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

com.sas.services.information.metadata
Interface RemarksInterface

All Superinterfaces:

MetadataInterface,

All Known Implementing Classes:

Remarks,

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.

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

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

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

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

addComment

public void addComment(CommentInterface comment)
                throws 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

getComment

public CommentInterface getComment(CommentFilterInterface filter)
                            throws 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

getComments

public List getComments(CommentFilterInterface filter)
                 throws 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

clear

public void clear()
           throws RemoteException

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

getOwner

public String getOwner()
                throws RemoteException

Gets the owner of the discussion thread

Returns:

String The owner/creator of the discussion thread

getTopic

public String getTopic()
                throws RemoteException

Gets the topic of discussion

Returns:

String The topic of discussion

setOwner

public void setOwner(UserContextInterface user)
              throws IllegalStateException,
                     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:

IllegalStateException - If the owner is already set

setTopic

public void setTopic(String topic)
              throws IllegalStateException,
                     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:

IllegalStateException - If the topic is already set

getStarted

public Date getStarted()
                throws RemoteException

Returns the date the discussion thread was started

Returns:

Date The date the discussion thread was started

getStarted

public String getStarted(DateFormat df)
                  throws 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

getProperty

public String getProperty(String propertyName)
                   throws 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.

setProperty

public void setProperty(String propertyName,
                        String propertyValue)
                 throws 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.

setThreadId

public void setThreadId(String threadId)
                 throws RemoteException

Sets the thread identifier for this remark.

Parameters:

threadId - Thread identifier for this remark.

getThreadId

public String getThreadId()
                   throws RemoteException

Get the thread identifier for this remark

Returns:

String The thread identifier for this remark

addReferral

public void addReferral(String entityKey)
                 throws 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.

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