com.sapportals.wcm.repository.service.statemanagement
Interface IStatemanagementUtilsResource

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

public interface IStatemanagementUtilsResource

This interface provides acces to persistent data of a resource for the statemanagement related controls. Everything related to the current state and the defined workflow is accessed via this interface.

Method Summary

boolean	addFeedback(java.lang.String impFeedbackText) Adds feedback to the IStatemanagementUtilsResource object.
IStepList	convertToApproverList(java.lang.String impApproverString) Converts a string as returned from the convertToString() method back to a IStepList .
java.lang.String	convertToString(IStepList impStepList) Converts a steplist to a string in order to save this string as persistant data within a control
boolean	isApproverlistAllowedForRead() Gets the ApproverlistAllowedForRead attribute of the IStatemanagementUtilsResource object.
boolean	isApproverlistAllowedForWrite() Gets the ApproverlistAllowedForWrite attribute of the IStatemanagementUtilsResource object.
boolean	isStatemanagementEnabled() Gets the StatemanagementEnabled attribute of the IStatemanagementUtilsResource object.
IStepList	readApproverList() Reads the list of steps and approvers from the database
java.lang.Integer	readCurrentStep() Reads the index of the last step approved for a resource
java.lang.Integer	readNextStep() Reads the index of the next step to be approved.
IState	readState() Determines the current state of a resource.
com.sapportals.portal.security.usermanagement.IUser	readWorkflowInitiator() Determines the user who initiated the approval process for a resource
void	saveApproverList(IStepList impApproverList) Saves the defined workflow for the current resource
void	setStatemanagementEnabled(boolean enabled) Sets the StatemanagementEnabled attribute of the IStatemanagementUtilsResource object.

Method Detail

setStatemanagementEnabled

public void setStatemanagementEnabled(boolean enabled)
                               throws WcmException

Sets the StatemanagementEnabled attribute of the IStatemanagementUtilsResource object. Whether the visibility of a resource is controlled by the state management service is defined on folder level for all direct children of this folder.

Parameters:

enabled - the new StatemanagementEnabled value

Throws:

WcmException - exception raised in failure situation

isStatemanagementEnabled

public boolean isStatemanagementEnabled()
                                 throws WcmException

Gets the StatemanagementEnabled attribute of the IStatemanagementUtilsResource object. Whether the visibility of a resource is controlled by the state management service is defined on folder level for all direct children of this folder.

Returns:

the StatemanagementEnabled value

Throws:

WcmException - exception raised in failure situation

isApproverlistAllowedForWrite

public boolean isApproverlistAllowedForWrite()
                                      throws WcmException

Gets the ApproverlistAllowedForWrite attribute of the IStatemanagementUtilsResource object. An approver list can only be maintained for collections and the authorizations are controlled by service permissions. This method is used by the user interface to decide whether to make the workflow list editable.

Returns:

the ApproverlistAllowedForWrite value

Throws:

WcmException - exception raised in failure situation

isApproverlistAllowedForRead

public boolean isApproverlistAllowedForRead()
                                     throws WcmException

Gets the ApproverlistAllowedForRead attribute of the IStatemanagementUtilsResource object. Normally this method returns true.

Returns:

the ApproverlistAllowedForRead value

Throws:

WcmException - exception raised in failure situation

saveApproverList

public void saveApproverList(IStepList impApproverList)
                      throws WcmException

Saves the defined workflow for the current resource

Parameters:

impApproverList - the list of steps and approvers

Throws:

WcmException - exception raised in failure situation

readApproverList

public IStepList readApproverList()
                           throws WcmException

Reads the list of steps and approvers from the database

Returns:

a list of steps of approvers

Throws:

WcmException - exception raised in failure situation

convertToApproverList

public IStepList convertToApproverList(java.lang.String impApproverString)
                                throws WcmException

Converts a string as returned from the convertToString() method back to a IStepList . This method can be used to restore the persistent data from a control.

Parameters:

impApproverString - a string as returned from convertToString()

Returns:

a steplist

Throws:

WcmException - exception raised in failure situation

See Also:

IStepList.setStepListString(String impStepListString)

convertToString

public java.lang.String convertToString(IStepList impStepList)
                                 throws WcmException

Converts a steplist to a string in order to save this string as persistant data within a control

Parameters:

impStepList - a steplist

Returns:

a string encoding the steplist

Throws:

WcmException - exception raised in failure situation

addFeedback

public boolean addFeedback(java.lang.String impFeedbackText)
                    throws WcmException

Adds feedback to the IStatemanagementUtilsResource object. Tis feedback is available via the normal collaboration control for the resource.

Parameters:

impFeedbackText - feedback to be added

Returns:

true if feedback was successfully saved

Throws:

WcmException - exception raised in failure situation

readNextStep

public java.lang.Integer readNextStep()
                               throws WcmException

Reads the index of the next step to be approved. Before the approval process starts, 0 is returned. After the last step is approved, null is returned.

Returns:

an integer with the index of the next step which has to be approved, or null if the last step has been approved

Throws:

WcmException - exception raised in failure situation

readCurrentStep

public java.lang.Integer readCurrentStep()
                                  throws WcmException

Reads the index of the last step approved for a resource

Returns:

last approved step if the resource has been submitted for approval once. Returns null, if no step has been approved yet

Throws:

WcmException - exception raised in failure situation

readWorkflowInitiator

public com.sapportals.portal.security.usermanagement.IUser readWorkflowInitiator()
                                                                          throws WcmException

Determines the user who initiated the approval process for a resource

Returns:

user who started the approval process. Null can be returned.

Throws:

WcmException - exception raised in failure situation

readState

public IState readState()
                 throws WcmException

Determines the current state of a resource. If no state is set for a resource, a special state 'undefined' is returned.

Returns:

state of the resource

Throws:

WcmException - exception raised in failure situation