com.sapportals.wcm.util.controlstatus

Interface IControlStatus

All Known Subinterfaces:

IConfigurableRendererStatus, IRendererStatus

All Known Implementing Classes:

AbstractRendererStatus, com.sapportals.wcm.control.fields.AbstractStatus, CLPRendererStatus, CollectionRendererStatus, JanusHeadedStatusFlipSide, JanusHeadedStatusFrontside, LinkControlStatus, MetaStatus, ProxyStatus, RenameStatus, SearchRendererStatus, SingleDiscPersistenceData

public interface IControlStatus

Method Summary

StatusInformation	execute(IExecutable executable) carries out the action described by the given parameter.
StatusInformation	execute(String execution) different signature for this method.
IExecutable	getAction(FieldIdentifier ident) returns the IExecutable with the given ident-parameter or null , if no such instance could be found.
List	getActions() returns a list with all IExecutable s defined by the implementing class
IField	getField(FieldIdentifier ident) returns the field with the given ident-parameter or null , if no such instance could be found.
List	getFields() returns a list with all fields defined by the implementing class
String	getID() returns the ID under which this status was registered by the Service
StatusInformation	getStatusInformation() returns the status of the implementing class.
void	setID(String id) sets the ID under which this status was registered by the service this field is set by the service and must not be altered afterwards.

Method Detail

execute

StatusInformation execute(IExecutable executable)
                          throws WcmException

carries out the action described by the given parameter.

Parameters:

executable - TBD: Description of the incoming method parameter

Returns:

the status of the execution - can be null.

Throws:

WcmException - Exception raised in failure situation

execute

StatusInformation execute(String execution)
                          throws WcmException

different signature for this method. The implementation must iterate through its defined list of IExecutable objects. If the given parameter matches the IExecutable 's getIdentifier.getID , this IExecutable must be passed to the other signature of this method.

Parameters:

execution - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

Throws:

WcmException - Exception raised in failure situation

WcmException, - if no matching class could be found.

getField

IField getField(FieldIdentifier ident)

returns the field with the given ident-parameter or null , if no such instance could be found.

Parameters:

ident - TBD: Description of the incoming method parameter

Returns:

field

getAction

IExecutable getAction(FieldIdentifier ident)

returns the IExecutable with the given ident-parameter or null , if no such instance could be found.

Parameters:

ident - TBD: Description of the incoming method parameter

Returns:

action

getFields

List getFields()

returns a list with all fields defined by the implementing class

Returns:

fields

getActions

List getActions()

returns a list with all IExecutable s defined by the implementing class

Returns:

actions

getStatusInformation

StatusInformation getStatusInformation()

returns the status of the implementing class. This status is obtained by asking all of the fields of the implementing class for their status. The first class, that returns a status != null will be used and its status will be returned. Consequently, this method might return null

Returns:

statusInformation

getID

String getID()

returns the ID under which this status was registered by the Service

Returns:

iD

setID

void setID(String id)

sets the ID under which this status was registered by the service this field is set by the service and must not be altered afterwards.

Parameters:

id - iD to be set

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