com.sapportals.wcm.repository.service.personalnote
Interface IPersonalNote

[contained in: com.sap.km.cm.repository.service.base.par - km.shared.repository.service.personalnote_api.jar]

public interface IPersonalNote

The interface represents a service for handling personal notes that are created for resources. Personal notes are always assigned to resources. Users with read permission can write personal notes for a resource. Only the authors of personal notes can read them.

The personal notes service can be configured. It offers a method to determine the current configuration.

Method Summary

boolean	addComment(IResource resource, java.lang.String Text) Adds a personal note to the specified resource.
IResourceList	getComment(IResource resource) Gets all personal notes for a given resource sorted by creation date.
int	getPersonalNoteCount(IResource resource) Returns the number of personal notes assigned to a resource.
java.util.Properties	getProperties() Gets all configuration data for this service.

Method Detail

addComment

public boolean addComment(IResource resource,
                          java.lang.String Text)
                   throws WcmException

Adds a personal note to the specified resource. The author of the personal note is identified by the resource context.

Parameters:

resource - the resource for which the note is given

Text - text of the note

Returns:

Boolean to indicate whether storage of note was successful or failed

getComment

public IResourceList getComment(IResource resource)

Gets all personal notes for a given resource sorted by creation date.

Parameters:

resource - the resource for which the personal notes exist

Returns:

list of resources that store notes

getProperties

public java.util.Properties getProperties()

Gets all configuration data for this service.

Returns:

all configuration data as properties

getPersonalNoteCount

public int getPersonalNoteCount(IResource resource)

Returns the number of personal notes assigned to a resource.

Parameters:

resource - resource for which the personal notes exist

Returns:

number of personal notes assigned to the resource