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

com.sas.services.information.metadata
Class Remarks

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--com.sas.services.information.metadata.Metadata
                          |
                          +--com.sas.services.information.metadata.Remarks

All Implemented Interfaces:

MetadataInterface, RemarksInterface,

public class Remarks

extends Metadata

implements RemarksInterface

Represents a set of comments or discussion thread on a particular topic.

A Serialized Form

Fields inherited from class com.sas.services.information.metadata.Metadata

_repository, _repositoryFlag, _repositoryObject, formats, gmtZone, REPOSITORY_DAV, REPOSITORY_LDAP, REPOSITORY_NONE, REPOSITORY_OMR

Fields inherited from class java.rmi.server.RemoteObject

ref

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

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Constructor Summary

	Remarks() Constructs a default instance.
protected	Remarks(Class theClass) Constructs a default instance.
	Remarks(DAVRemarks remarks) Constructs a default instance.
protected	Remarks(DAVRemarks remarks, Class theClass) Constructs a default instance.
	Remarks(UserContextInterface user, String topic)

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
void	delete() Override delete to make sure that only the owner can delete the remark.
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.
Set	getReferrals()
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
String	getType() Get the object type.
void	setOwner(UserContextInterface owner) 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.
void	update() Persist any changes to the object back to the repository.

Methods inherited from class com.sas.services.information.metadata.Metadata

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

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, 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, 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, version

Constructor Detail

Remarks

public Remarks()
        throws RemoteException

Constructs a default instance.

Throws:

RemoteException - if unable to export the remote object.

Remarks

public Remarks(DAVRemarks remarks)
        throws RemoteException

Constructs a default instance.

Parameters:

remarks - Remarks.

Throws:

RemoteException - if unable to export the remote object.

Remarks

protected Remarks(Class theClass)
           throws RemoteException

Constructs a default instance.

Parameters:

theClass - The subclass's class which will be used to determine appropriate RMI socket factories.

Throws:

RemoteException - if unable to export the remote object.

Remarks

protected Remarks(DAVRemarks remarks,
                  Class theClass)
           throws RemoteException

Constructs a default instance.

Parameters:

remarks - Remarks.

theClass - The subclass's class which will be used to determine appropriate RMI socket factories.

Throws:

RemoteException - if unable to export the remote object.

Remarks

public Remarks(UserContextInterface user,
               String topic)
        throws RemoteException

Method Detail

getType

public String getType()
               throws RemoteException

Description copied from interface: MetadataInterface

Get the object type. Subclasses of Metadata will return a repository-neutral type string. If no subclass exists, Metadata returns the repository-specific type.

Specified by:

getType in interface MetadataInterface

Overrides:

getType in class Metadata

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Returns:

A type string for the object.

Throws:

RemoteException - if an error occurs

addComment

public void addComment(CommentInterface comment)
                throws RemoteException

Description copied from interface: RemarksInterface

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

Specified by:

addComment in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Parameters:

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

getComment

public CommentInterface getComment(CommentFilterInterface filter)
                            throws RemoteException

Description copied from interface: RemarksInterface

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

Specified by:

getComment in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Parameters:

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

Returns:

CommentInterface A comment in the discussion thread

setThreadId

public void setThreadId(String threadId)
                 throws RemoteException

Description copied from interface: RemarksInterface

Sets the thread identifier for this remark.

Specified by:

setThreadId in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Parameters:

threadId - Thread identifier for this remark.

getThreadId

public String getThreadId()

Description copied from interface: RemarksInterface

Get the thread identifier for this remark

Specified by:

getThreadId in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Returns:

String The thread identifier for this remark

getComments

public List getComments(CommentFilterInterface filter)
                 throws RemoteException

Description copied from interface: RemarksInterface

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.

Specified by:

getComments in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

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

Description copied from interface: RemarksInterface

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

Specified by:

clear in interface RemarksInterface

delete

public void delete()
            throws ServiceException,
                   RemoteException

Override delete to make sure that only the owner can delete the remark. If there is no owner then allow deletion too.

Specified by:

delete in interface MetadataInterface

Overrides:

delete in class Metadata

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Throws:

ServiceException - in the event of a repository failure.

RemoteException - in the event of a network failure.

getOwner

public String getOwner()
                throws RemoteException

Description copied from interface: RemarksInterface

Gets the owner of the discussion thread

Specified by:

getOwner in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Returns:

String The owner/creator of the discussion thread

getTopic

public String getTopic()
                throws RemoteException

Description copied from interface: RemarksInterface

Gets the topic of discussion

Specified by:

getTopic in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Returns:

String The topic of discussion

getStarted

public Date getStarted()
                throws RemoteException

Description copied from interface: RemarksInterface

Returns the date the discussion thread was started

Specified by:

getStarted in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Returns:

Date The date the discussion thread was started

getStarted

public String getStarted(DateFormat df)
                  throws RemoteException

Description copied from interface: RemarksInterface

Returns the date the discussion thread was started

Specified by:

getStarted in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Parameters:

df - A dateformat to apply to the date for formatting

Returns:

String The date the discussion thread was started

update

public void update()
            throws ServiceException,
                   RemoteException

Description copied from interface: MetadataInterface

Persist any changes to the object back to the repository. This is not done automatically in most cases. Any change to metadata requires an update call to write it to the back end server.

Specified by:

update in interface MetadataInterface

Overrides:

update in class Metadata

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Throws:

ServiceException - if an error occurs in the repository.

RemoteException - if an error occurs

setOwner

public void setOwner(UserContextInterface owner)
              throws IllegalStateException,
                     RemoteException

Description copied from interface: RemarksInterface

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

Specified by:

setOwner in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

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

Description copied from interface: RemarksInterface

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

Specified by:

setTopic in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Parameters:

topic - The topic for this discussion thread

Throws:

IllegalStateException - If the topic is already set

getProperty

public String getProperty(String propertyName)
                   throws RemoteException

Description copied from interface: RemarksInterface

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

Specified by:

getProperty in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

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

Description copied from interface: RemarksInterface

Sets the value of a property

Specified by:

setProperty in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

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.

addReferral

public void addReferral(String entityKey)
                 throws RemoteException

Description copied from interface: RemarksInterface

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

Specified by:

addReferral in interface RemarksInterface

Following copied from interface: com.sas.services.information.metadata.RemarksInterface

Parameters:

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

getReferrals

public Set getReferrals()
                 throws RemoteException

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