com.sapportals.wcm.repository.service.feedback

Interface IFeedback

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, String Text) Adds a feedback item to the specified resource.
boolean	addFeedback(IResource resource, String Text, com.sap.security.api.IPrincipal receiver) Adds a feedback item to the specified resource.
boolean	addFeedback(IResource resource, String Text, com.sapportals.portal.security.usermanagement.IUMPrincipal receiver) Deprecated. As of NetWeaver 7.1, replaced by addFeedback(IResource,String,com.sap.security.api.IPrincipal)
boolean	delFeedback(IResource resource, IResource fedbackres) Deletes a feedback item belonging to a resource
IResourceList	getFeedback(IResource resource) Gets all feedback for a specified resource sorted by creation date.
int	getFeedbackCount(IResource resource) Returns number of feedback items that exist for a resource.
Properties	getProperties() Gets all configuration data for this service.
boolean	isSecure() Checks if service is set to be a secure service.

Method Detail

addFeedback

boolean addFeedback(IResource resource,
                    String Text)
                    throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

addFeedback

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

Deprecated. As of NetWeaver 7.1, replaced by addFeedback(IResource,String,com.sap.security.api.IPrincipal)

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

Throws:

com.sapportals.wcm.WcmException

See Also:

IUMPrincipal

addFeedback

boolean addFeedback(IResource resource,
                    String Text,
                    com.sap.security.api.IPrincipal receiver)
                    throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

Since:

NetWeaver 7.1

See Also:

IUMPrincipal

getFeedback

IResourceList getFeedback(IResource resource)

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

Parameters:

resource - the resource for which feedback exists

Returns:

list of resources that store feedback

delFeedback

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

Properties getProperties()

Gets all configuration data for this service.

Returns:

all configuration data as Java properties

getFeedbackCount

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

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

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM