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

com.sas.services.information.metadata
Interface TextStoreInterface

All Superinterfaces:

MetadataInterface, PublicObjectInterface, java.rmi.Remote

All Known Subinterfaces:

ConfigurationXMLTextStoreInterface

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public interface TextStoreInterface
extends MetadataInterface

A simple interface representing TextStore objects from the metadata store.

Since:

1.1

Field Summary

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

METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

abstract boolean	containsBytes() Returns true if the TextStore contents were set with the setBytes() method.
abstract byte[]	getBytes() Get byte array from the text store.
abstract java.lang.String	getText() Get the text from the text store.
abstract java.lang.String	getTextRole() Get the text role.
abstract java.lang.String	getTextType() Get the text type.
abstract void	setBytes(byte[] bytes) Set the text contained in this TextStore object.
abstract void	setText(java.lang.String text) Set the text contained in this TextStore object.
abstract void	setTextRole(java.lang.String role) Set the text role string for this object.
abstract void	setTextType(java.lang.String type) Set the text type for this object.

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

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getCreatedBy, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getType, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isObjectAlive, isReadCompatible, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setName, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface

addProcessorInterface, getContainer, getIdentifier, getName, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor

Method Detail

getText

java.lang.String getText()
                         throws ServiceException,
                                java.rmi.RemoteException

Get the text from the text store.

Returns:

A String containing the text.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setText

void setText(java.lang.String text)
             throws ServiceException,
                    java.rmi.RemoteException

Set the text contained in this TextStore object.

Parameters:

text - The new text for this object.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getTextRole

java.lang.String getTextRole()
                             throws ServiceException,
                                    java.rmi.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.

java.rmi.RemoteException - In the event of remote object failure.

setTextRole

void setTextRole(java.lang.String role)
                 throws ServiceException,
                        java.rmi.RemoteException

Set the text role string for this object.

Parameters:

role - The new text role.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getTextType

java.lang.String getTextType()
                             throws ServiceException,
                                    java.rmi.RemoteException

Get the text type.

Returns:

A String containing the TextType.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setTextType

void setTextType(java.lang.String type)
                 throws ServiceException,
                        java.rmi.RemoteException

Set the text type for this object.

Parameters:

type - The new type string.

Throws:

ServiceException - if a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getBytes

byte[] getBytes()
                throws ServiceException,
                       java.rmi.RemoteException

Get byte array from the text store. Byte array contains value set by setBytes(bytes[]). If text value was not set by setBytes(bytes[]), UTF-8 byte equivalent of the text value is returned.

Returns:

A byte array.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

containsBytes

boolean containsBytes()
                      throws ServiceException,
                             java.rmi.RemoteException

Returns true if the TextStore contents were set with the setBytes() method.

Returns:

true if the TextStore contents were set with the setBytes() method

Throws:

ServiceException

java.rmi.RemoteException

setBytes

void setBytes(byte[] bytes)
              throws ServiceException,
                     java.rmi.RemoteException

Set the text contained in this TextStore object.

Parameters:

text - The new text for this object.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

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