com.sapportals.wcm.rendering.base

Class MetaStatus

java.lang.Object
  com.sapportals.wcm.rendering.base.MetaStatus

All Implemented Interfaces:

IControlStatus

public final class MetaStatus

extends Object

implements IControlStatus

This status simply holds a mapping for keys generated by an IProxyControl with keys generated by the ControlStatusService.

Since:

EP6 SP1

Constructor Summary

MetaStatus()

Method Summary

StatusInformation	execute(IExecutable p0) carries out the action described by the given parameter.
StatusInformation	execute(String p0) different signature for this method.
IExecutable	getAction(FieldIdentifier p0) 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 p0) 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
String	getProxyStatusID()
StatusInformation	getStatusInformation() returns the status of the implementing class.
Properties	getStatusMapping()
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.
void	setProxyStatusID(String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetaStatus

public MetaStatus()

Method Detail

execute

public StatusInformation execute(IExecutable p0)
                          throws WcmException

Description copied from interface: IControlStatus

carries out the action described by the given parameter.

Specified by:

execute in interface IControlStatus

Parameters:

p0 - TBD: Description of the incoming method parameter

Returns:

the status of the execution - can be null.

Throws:

WcmException - Exception raised in failure situation

getStatusMapping

public Properties getStatusMapping()

getProxyStatusID

public String getProxyStatusID()

setProxyStatusID

public void setProxyStatusID(String id)

execute

public StatusInformation execute(String p0)
                          throws WcmException

Description copied from interface: IControlStatus

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.

Specified by:

execute in interface IControlStatus

Parameters:

p0 - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

Throws:

WcmException - Exception raised in failure situation

getField

public IField getField(FieldIdentifier p0)

Description copied from interface: IControlStatus

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

Specified by:

getField in interface IControlStatus

Parameters:

p0 - TBD: Description of the incoming method parameter

Returns:

field

getAction

public IExecutable getAction(FieldIdentifier p0)

Description copied from interface: IControlStatus

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

Specified by:

getAction in interface IControlStatus

Parameters:

p0 - TBD: Description of the incoming method parameter

Returns:

action

getFields

public List getFields()

Description copied from interface: IControlStatus

returns a list with all fields defined by the implementing class

Specified by:

getFields in interface IControlStatus

Returns:

fields

getActions

public List getActions()

Description copied from interface: IControlStatus

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

Specified by:

getActions in interface IControlStatus

Returns:

actions

getStatusInformation

public StatusInformation getStatusInformation()

Description copied from interface: IControlStatus

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

Specified by:

getStatusInformation in interface IControlStatus

Returns:

statusInformation

getID

public String getID()

Description copied from interface: IControlStatus

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

Specified by:

getID in interface IControlStatus

Returns:

iD

setID

public void setID(String ID)

Description copied from interface: IControlStatus

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.

Specified by:

setID in interface IControlStatus

Parameters:

ID - iD to be set