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

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

All Superinterfaces:

IRepositoryService

public interface IStatemanagementManager

extends IRepositoryService

A service returned from the service factory using the IWCMConst.STATEMANAGEMENT_SERVICE has to implement this interface. The state management service makes it possible to assign different states to a resource and to define transitions between states. For a particular transition, an approval workflow can be defined.

Method Summary

IEventSender	getEventSender() Returns an instance of the event sender of the state management service.
IStatemanagement	getStatemanagement() Deprecated. as of NW04. All state management related classes will become resource-dependent. Please use getStatemanagementResource() to handle states and transitions for a single resource.
IStatemanagementEvent	getStatemanagementEventTemplate(int type) Get a IStatemanagementEvent-template for the given IStatemanagementEvent-type.
IStatemanagementUtils	getStatemanagementUtils() Deprecated. as of NW04. All state management related classes will become resource-dependent please use getStatemanagementResource().getUtils() to handle persistent storage of state management related data
IStatemanagementResource	getStatemangementResource(IResource impResource) Gets an instance of the IStatemanagementResource for a resource.

Methods inherited from interface com.sapportals.wcm.repository.service.IRepositoryService

acceptServletCall, getDescription, getDescription, getID, getServiceType

Method Detail

getStatemanagement

public IStatemanagement getStatemanagement()

Deprecated. as of NW04. All state management related classes will become resource-dependent. Please use getStatemanagementResource() to handle states and transitions for a single resource.

Returns the IStatemanagement interface to work with states and transitions

Returns:

instance of IStatemanagement

getStatemanagementUtils

public IStatemanagementUtils getStatemanagementUtils()

Deprecated. as of NW04. All state management related classes will become resource-dependent please use getStatemanagementResource().getUtils() to handle persistent storage of state management related data

Gets the IStatemanagementUtils interface to enable persistent storage of state management information

Returns:

instance of statemanagement utils

getEventSender

public IEventSender getEventSender()

Returns an instance of the event sender of the state management service. Can be null.

Returns:

instance of event sender

getStatemangementResource

public IStatemanagementResource getStatemangementResource(IResource impResource)
                                                   throws StatemanagementException,
                                                          WcmException

Gets an instance of the IStatemanagementResource for a resource. This is the central class for dealing with states and transitions for a resource.

Parameters:

impResource - the resource to get the instance for

Returns:

an instance of the state management resource, can be null

getStatemanagementEventTemplate

public IStatemanagementEvent getStatemanagementEventTemplate(int type)

Get a IStatemanagementEvent-template for the given IStatemanagementEvent-type.

Parameters:

type - the IStatemanagementEvent-type to get the template for.

Returns:

an IStatemanagementEvent-template for the given type or null if the given type is not valid.