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

com.sas.services.information.metadata
Interface RemarksInterface

All Superinterfaces:

MetadataInterface, PublicObjectInterface, java.rmi.Remote

All Known Implementing Classes:

Remarks

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public interface RemarksInterface
extends MetadataInterface, java.rmi.Remote

Remarks are a list of comments, which forms a way of grouping comments on a related topic together. A list of remarks can be obtained from a metadata object using the getRemarksList on corresponding metadata objects.

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 void	addComment(CommentInterface comment) Add a comment - as long as user is an allowed participant
abstract void	addReferral(java.lang.String entityKey) Sets the referral, which is the item that refers to this remark.
abstract void	clear() Clear the list of comments - only owner is allowed to do this
abstract CommentInterface	getComment(CommentFilterInterface filter) Get a comment that satisfies the filter.
abstract java.util.List	getComments(CommentFilterInterface filter) Get a list of all comments that satisfy the filter.
abstract java.lang.String	getOwner() Gets the owner of the discussion thread
abstract java.lang.String	getProperty(java.lang.String propertyName) Returns the value of a property.
abstract java.util.Date	getStarted() Returns the date the discussion thread was started
abstract java.lang.String	getStarted(java.text.DateFormat df) Returns the date the discussion thread was started
abstract java.lang.String	getThreadId() Get the thread identifier for this remark
abstract java.lang.String	getTopic() Gets the topic of discussion
abstract void	setOwner(UserContextInterface user) Sets the owner of the discussion thread.
abstract void	setProperty(java.lang.String propertyName, java.lang.String propertyValue) Sets the value of a property
abstract void	setThreadId(java.lang.String threadId) Sets the thread identifier for this remark.
abstract void	setTopic(java.lang.String topic) Sets the topic of discussion.

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

addComment

void addComment(CommentInterface comment)
                throws java.rmi.RemoteException

Add a comment - as long as user is an allowed participant

Parameters:

comment - A comment to add to the discussion thread. The comment may contain attachments

Throws:

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

getComment

CommentInterface getComment(CommentFilterInterface filter)
                            throws java.rmi.RemoteException

Get a comment that satisfies the filter. No filter is attained by passing a null filter or setting NOMODIFIER in the CommentFilter.

Parameters:

filter - A filter to determine which comment in the discussion thread should be returned.

Returns:

CommentInterface A comment in the discussion thread

Throws:

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

getComments

java.util.List getComments(CommentFilterInterface filter)
                           throws java.rmi.RemoteException

Get a list of all comments that satisfy the filter. No filter is attained by passing a null filter or setting NOMODIFIER in the CommentFilter.

Parameters:

filter - A filter to determine which comments in the discussion thread should be returned.

Returns:

List(of CommentInterface) A list of comments in the discussion thread

Throws:

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

clear

void clear()
           throws java.rmi.RemoteException

Clear the list of comments - only owner is allowed to do this

Throws:

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

getOwner

java.lang.String getOwner()
                          throws java.rmi.RemoteException

Gets the owner of the discussion thread

Returns:

String The owner/creator of the discussion thread

Throws:

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

getTopic

java.lang.String getTopic()
                          throws java.rmi.RemoteException

Gets the topic of discussion

Returns:

String The topic of discussion

Throws:

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

setOwner

void setOwner(UserContextInterface user)
              throws java.lang.IllegalStateException,
                     java.rmi.RemoteException

Sets the owner of the discussion thread. If the owner is already set then an IllegalStateException is thrown.

Parameters:

user - The user context that represents the owner/creator of the discussion thread

Throws:

java.lang.IllegalStateException - If the owner is already set

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

setTopic

void setTopic(java.lang.String topic)
              throws java.lang.IllegalStateException,
                     java.rmi.RemoteException

Sets the topic of discussion. If the topic is already set then an IllegalStateException is thrown.

Parameters:

topic - The topic for this discussion thread

Throws:

java.lang.IllegalStateException - If the topic is already set

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

getStarted

java.util.Date getStarted()
                          throws java.rmi.RemoteException

Returns the date the discussion thread was started

Returns:

Date The date the discussion thread was started

Throws:

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

getStarted

java.lang.String getStarted(java.text.DateFormat df)
                            throws java.rmi.RemoteException

Returns the date the discussion thread was started

Parameters:

df - A dateformat to apply to the date for formatting

Returns:

String The date the discussion thread was started

Throws:

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

getProperty

java.lang.String getProperty(java.lang.String propertyName)
                             throws java.rmi.RemoteException

Returns the value of a property. If the property does not exist then return null.

Parameters:

propertyName - The name of the property. Use the format "{namespaceURI}name". If the property is not in any namespace then use either "{}name" or just "name".

Returns:

String The value of the property requested.

Throws:

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

setProperty

void setProperty(java.lang.String propertyName,
                 java.lang.String propertyValue)
                 throws java.rmi.RemoteException

Sets the value of a property

Parameters:

propertyName - The name of the property. Use the format "{namespaceURI}name". If the property is not in any namespace then use either "{}name" or just "name".

propertyValue - The value for the property.

Throws:

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

setThreadId

void setThreadId(java.lang.String threadId)
                 throws java.rmi.RemoteException

Sets the thread identifier for this remark.

Parameters:

threadId - Thread identifier for this remark.

Throws:

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

getThreadId

java.lang.String getThreadId()
                             throws java.rmi.RemoteException

Get the thread identifier for this remark

Returns:

String The thread identifier for this remark

Throws:

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

addReferral

void addReferral(java.lang.String entityKey)
                 throws java.rmi.RemoteException

Sets the referral, which is the item that refers to this remark. There can be more than one referral.

Parameters:

entityKey - The entityKey of the smart object that refers to this remark.

Throws:

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

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