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

[contained in: com.sap.km.cm.repository.service.base.par - km.shared.repository.service.statemanagement_api.jar] Deprecated. as of EP5 SP4 all state management related classes will become resource-dependent. Please use IStatemanagementUtilsResource instead.

public interface IStatemanagementUtils

The interface enables access to all information related to state management for a resource. For example, it provides information on the list of steps and approvers, the state of the resource, and the initiator of the workflow.

Method Summary

boolean	addFeedback(IResource impResource, java.lang.String impFeedbackText) Deprecated. Wrapper method for saving feedback from the service servlet for the feedback service
IStepList	convertToApproverList(java.lang.String impApproverString) Deprecated. Constructs a steplist from a string which is returned by convertToString
java.lang.String	convertToString(IStepList impStepList) Deprecated. Converts a steplist object into a string which can be used for persistent properties in UI
IAclPermission	getApproverAdminPermission(IResource impResource) Deprecated. Gets the permission for approver administration for a resource.
boolean	isApproverlistAllowedForRead(IResource impResource) Deprecated. Checks whether the current user is allowed to read the approver list for a resource
boolean	isApproverlistAllowedForWrite(IResource impResource) Deprecated. Checks whether the current user has permission to change the approver list for a resource
boolean	isStatemanagementEnabled(IResource impResource) Deprecated. Checks whether the state management service is enabled for a collection or for the parent collection of a resource.
IStepList	readApproverList(IResource impResource) Deprecated. Reads the list of steps and approvers for a resource.
java.lang.Integer	readCurrentStep(IResource impResource) Deprecated. Reads the last step approved for a resource.
java.lang.Integer	readNextStep(IResource impResource) Deprecated. Reads the index of the next step to be approved.
IState	readState(IResource impResource) Deprecated. Determines the current state of a resource.
com.sapportals.portal.security.usermanagement.IUser	readWorkflowInitiator(IResource impResource) Deprecated. Determines the person who initiated the approval process for a resource
void	saveApproverList(IResource impResource, IStepList impApproverList) Deprecated. Saves the list of steps and approvers for a resource
void	saveCurrentStep(IResource impResource, java.lang.Integer impStep) Deprecated. Saves the last approved step for a resource
void	saveState(IResource impResouce, IState impState) Deprecated. Saves the state of a resource
void	saveWorkflowInitiator(IResource impResource, com.sapportals.portal.security.usermanagement.IUser impWorkflowInitiator) Deprecated. Saves the person who initiated the approval process for a resource
void	setStatemanagementEnabled(ICollection impCollection, boolean enabled) Deprecated. Enables or disables the statemanagement for a folder.

Method Detail

getApproverAdminPermission

public IAclPermission getApproverAdminPermission(IResource impResource)
                                          throws WcmException

Deprecated.

Gets the permission for approver administration for a resource. Can return null, if the service permission is not yet registered

Parameters:

impResource - the resource for the permission

Returns:

the ApproverAdminPermission

Throws:

WcmException - exception raised in failure situation

setStatemanagementEnabled

public void setStatemanagementEnabled(ICollection impCollection,
                                      boolean enabled)
                               throws WcmException

Deprecated.

Enables or disables the statemanagement for a folder.

Parameters:

enabled - Boolean flag to enable or disable state management for a collection

impCollection - the new StatemanagementEnabled value

Throws:

WcmException -

isStatemanagementEnabled

public boolean isStatemanagementEnabled(IResource impResource)
                                 throws WcmException

Deprecated.

Checks whether the state management service is enabled for a collection or for the parent collection of a resource. The state management service must be enabled for each folder.

Parameters:

impResource - the resouce to check

Returns:

true if statemanagement is enabled

Throws:

WcmException -

saveApproverList

public void saveApproverList(IResource impResource,
                             IStepList impApproverList)
                      throws WcmException

Deprecated.

Saves the list of steps and approvers for a resource

Parameters:

impResource - resource for which the list is saved

impApproverList - list of steps and approvers

Throws:

WcmException -

readApproverList

public IStepList readApproverList(IResource impResource)
                           throws WcmException

Deprecated.

Reads the list of steps and approvers for a resource. If no steps are assigned to the resource, an empty list is returned.

Parameters:

impResource - resource for which the list is saved

Returns:

list of steps and approvers

Throws:

WcmException -

readCurrentStep

public java.lang.Integer readCurrentStep(IResource impResource)
                                  throws WcmException

Deprecated.

Reads the last step approved for a resource.

Parameters:

impResource - resource in the approval process

Returns:

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

Throws:

WcmException -

readNextStep

public java.lang.Integer readNextStep(IResource impResource)
                               throws WcmException

Deprecated.

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

Parameters:

impResource - resource in the approval process.

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 -

saveCurrentStep

public void saveCurrentStep(IResource impResource,
                            java.lang.Integer impStep)
                     throws WcmException

Deprecated.

Saves the last approved step for a resource

Parameters:

impResource - resource to save the step

impStep - number of the step. If null, the step is deleted.

Throws:

WcmException - exception raised in failure situation

readWorkflowInitiator

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

Deprecated.

Determines the person who initiated the approval process for a resource

Parameters:

impResource - resource in approval process

Returns:

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

Throws:

WcmException -

saveWorkflowInitiator

public void saveWorkflowInitiator(IResource impResource,
                                  com.sapportals.portal.security.usermanagement.IUser impWorkflowInitiator)
                           throws WcmException

Deprecated.

Saves the person who initiated the approval process for a resource

Parameters:

impResource - resource in approval process

impWorkflowInitiator - User who started the approval process. If null, the entry is deleted.

Throws:

WcmException -

readState

public IState readState(IResource impResource)
                 throws WcmException

Deprecated.

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

Parameters:

impResource - resource

Returns:

state of the resource

Throws:

WcmException -

saveState

public void saveState(IResource impResouce,
                      IState impState)
               throws WcmException

Deprecated.

Saves the state of a resource

Parameters:

impResouce - the resource for which the state has to be saved

impState - the state to save

Throws:

WcmException -

isApproverlistAllowedForWrite

public boolean isApproverlistAllowedForWrite(IResource impResource)
                                      throws WcmException

Deprecated.

Checks whether the current user has permission to change the approver list for a resource

Parameters:

impResource - the resource to be checked

Returns:

True if the user is allowed to change the approver list, otherwise false.

Throws:

WcmException -

isApproverlistAllowedForRead

public boolean isApproverlistAllowedForRead(IResource impResource)
                                     throws WcmException

Deprecated.

Checks whether the current user is allowed to read the approver list for a resource

Parameters:

impResource - resource to be approved

Returns:

True if the user is allowed to read the approver list, otherwise false.

Throws:

WcmException -

convertToApproverList

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

Deprecated.

Constructs a steplist from a string which is returned by convertToString

Parameters:

impApproverString - string as returned from convertToString. This string is used in the persistent properties of a control.

Returns:

an implementation of IStepList which contains the steps and approvers which were encoded in the impApproverString

Throws:

WcmException -

convertToString

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

Deprecated.

Converts a steplist object into a string which can be used for persistent properties in UI

Parameters:

impStepList - the steplist to convert

Returns:

string representation of the steplist

Throws:

WcmException -

addFeedback

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

Deprecated.

Wrapper method for saving feedback from the service servlet for the feedback service

Parameters:

impResource - resource for which there is feedback

impFeedbackText - text to save as feedback

Returns:

true if the feedback service returns true

Throws:

WcmException -