com.sapportals.wcm.repository.service.feedback
Interface IFeedback

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

public interface IFeedback

The interface IFeedback represents a service for handling feedback related to resources. Feedback is always assigned to a resource.
Permissions are required to give or view feedback for a resource:

• Users with read permission can give feedback
• Users with write-permission can view all feedback
• Users with the service permission collaboration can view all feedback
• Users can view feedback they have created.

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

Method Summary

boolean	addFeedback(IResource resource, java.lang.String Text) Adds a feedback item to the specified resource.
boolean	addFeedback(IResource resource, java.lang.String Text, com.sapportals.portal.security.usermanagement.IUMPrincipal receiver) Adds a feedback item to the specified resource.
boolean	delFeedback(IResource resource, IResource fedbackres) Deletes a feedback item belonging to a resource
IResourceList	getFeedback(IResource resource) Gets all feedback for a specifed resource sorted by creation date.
int	getFeedbackCount(IResource resource) Returns number of feedback items that exist for a resource.
java.util.Properties	getProperties() Gets all configuration data for this service.
boolean	isSecure() Checks if service is set to be a secure service.

Method Detail

addFeedback

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

Adds a feedback item to the specified resource. The author of the feedback is identified by the resource context.

Parameters:

resource - the resource for which the feedback is given

Text - text of the feedback

Returns:

Boolean to indicate whether storage of feedback was successful or failed

addFeedback

public boolean addFeedback(IResource resource,
                           java.lang.String Text,
                           com.sapportals.portal.security.usermanagement.IUMPrincipal receiver)
                    throws WcmException

Adds a feedback item to the specified resource. The author of the feedback is identified by the resource context. Optionally, a notification recipient can be named.

Parameters:

resource - the resource for which the feedback is given

Text - text of the feedback

receiver - recipient of a "New Feedback" notification

Returns:

Boolean to indicate whether storage of feedback was successful/failed

See Also:

IUMPrincipal

getFeedback

public IResourceList getFeedback(IResource resource)

Gets all feedback for a specifed resource sorted by creation date.

Parameters:

resource - the resource for which feedback exists

Returns:

list of resources that store feedback

delFeedback

public boolean delFeedback(IResource resource,
                           IResource fedbackres)

Deletes a feedback item belonging to a resource

Parameters:

resource - resource for which the feedback exists

fedbackres - resource that stores the feedback to be deleted

Returns:

Boolean to indicate whether deletion of feedback was successful or failed

getProperties

public java.util.Properties getProperties()

Gets all configuration data for this service.

Returns:

all configuration data as Java properties

getFeedbackCount

public int getFeedbackCount(IResource resource)

Returns number of feedback items that exist for a resource. A user only receives the feedback items he/she is permitted to see.

Parameters:

resource - resource for which feedback exists

Returns:

the number of feedback items that are assigned to the resource

isSecure

public boolean isSecure()

Checks if service is set to be a secure service. It is possible to configure the service so that no htmlb editor is used.

Returns:

true, if the service is set to be secure, otherwise false