*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.information.metadata
Interface TextStoreInterface

All Superinterfaces:

MetadataInterface,

All Known Subinterfaces:

ConfigurationXMLTextStoreInterface

All Known Implementing Classes:

OMRTextStore,

public interface TextStoreInterface

extends MetadataInterface

A simple interface representing TextStore objects from the metadata store.

Since:

1.1

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

String	getText() Get the text from the text store.
String	getTextRole() Get the text role.
String	getTextType() Get the text type.
void	setText(String text) Set the text contained in this TextStore object.
void	setTextRole(String role) Set the text role string for this object.
void	setTextType(String type) Set the text type for this object.

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getDescription, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getType, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Method Detail

getText

public String getText()
               throws ServiceException,
                      RemoteException

Get the text from the text store.

Returns:

A String containing the text.

Throws:

ServiceException - If a repository error occurs.

RemoteException - In the event of remote object failure.

setText

public void setText(String text)
             throws ServiceException,
                    RemoteException

Set the text contained in this TextStore object.

Parameters:

text - The new text for this object.

Throws:

ServiceException - If a repository error occurs.

RemoteException - In the event of remote object failure.

getTextRole

public String getTextRole()
                   throws ServiceException,
                          RemoteException

Get the text role. This provides information on what the text is to be used for.

Returns:

A String containing the TextRole.

Throws:

ServiceException - If a repository error occurs.

RemoteException - In the event of remote object failure.

setTextRole

public void setTextRole(String role)
                 throws ServiceException,
                        RemoteException

Set the text role string for this object.

Parameters:

role - The new text role.

Throws:

ServiceException - If a repository error occurs.

RemoteException - In the event of remote object failure.

getTextType

public String getTextType()
                   throws ServiceException,
                          RemoteException

Get the text type.

Returns:

A String containing the TextType.

Throws:

ServiceException - If a repository error occurs.

RemoteException - In the event of remote object failure.

setTextType

public void setTextType(String type)
                 throws ServiceException,
                        RemoteException

Set the text type for this object.

Parameters:

type - The new type string.

Throws:

ServiceException - if a repository error occurs.

RemoteException - In the event of remote object failure.

*** This API provides Binary Compatibility only, not Source Compatibility ***