Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

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

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

This is the main interface for the state management service. It handles transitions between states. Everything related to the current state of a resource is available via IStatemanagementUtilsResource

Method Summary
 IResourceTransitionList getAllowedTransitions()
          Gets all permitted transitions for the current resource and the current user.
 IResource getResource()
          Gets the original resource for this object.
 IResourceTransition getTransition(java.lang.String ID)
          Gets a transition for the ID.
 IStatemanagementUtilsResource getUtils()
          Gets the IStatemanagementUtilsResource for this resource.
 

Method Detail

getResource

public IResource getResource()
Gets the original resource for this object. The IStatemanagementResource contains one resource. This can be accessed via this method.
Returns:
The resource that is handled by this object

getUtils

public IStatemanagementUtilsResource getUtils()
Gets the IStatemanagementUtilsResource for this resource. Everything related to the current state and the defined workflow is handled by IStatemanagementUtilsResource
Returns:
the statemanagent utils for this resource

getAllowedTransitions

public IResourceTransitionList getAllowedTransitions()
                                              throws WcmException
Gets all permitted transitions for the current resource and the current user. A transition has a source state and a target state. The current state of a resource therefore determines all possible transitions by evaluating the source state of all transitions. In addition, whether a transition is allowed or not also depends on the user. The list returned can not be null but can be empty.
Returns:
a list with all permitted transitions
Throws:
WcmException - exception raised in failure situation

getTransition

public IResourceTransition getTransition(java.lang.String ID)
                                  throws WcmException
Gets a transition for the ID. This transition may not be allowed.
Parameters:
ID - ID for a transition
Returns:
the transition value
Throws:
WcmException - exception raised in failure situation
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.