com.sapportals.wcm.rendering.base
Class ProxyStatus

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.base_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.rendering.base.ProxyStatus

All Implemented Interfaces:

IControlStatus

public final class ProxyStatus

extends java.lang.Object

implements IControlStatus

Since:

EP5 SP6 and EP6 SP1

Constructor Summary

ProxyStatus()

Method Summary

boolean	addToPrivate(java.lang.Object key, java.lang.Object value, boolean overwrite)
boolean	addToPublic(java.lang.Object key, java.lang.Object value, boolean overwrite)
StatusInformation	execute(IExecutable p0) carries out the action described by the given parameter.
StatusInformation	execute(java.lang.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.
java.util.List	getActions() returns a list with all IExecutable s defined by the implementing class
IUIBaseCommand	getEmbeddedCommand()
IField	getField(FieldIdentifier p0) returns the field with the given ident-parameter or null , if no such instance could be found.
java.util.List	getFields() returns a list with all fields defined by the implementing class
java.lang.Object	getFromPrivate(java.lang.Object key)
java.lang.Object	getFromPublic(java.lang.Object key)
com.sapportals.wcm.control.base.HabitatStack	getHabitatStack()
java.lang.String	getID() returns the ID under which this status was registered by the Service
java.util.Set	getPublicKeys()
java.util.Map	getRenderingInformation()
com.sapportals.wcm.repository.service.layout.info.RenderObjectContainer	getRenderObjectContainer()
com.sapportals.wcm.repository.service.layout.info.SettingsContainer	getSettingsContainer()
StatusInformation	getStatusInformation() returns the status of the implementing class.
boolean	isPreparedForAdapterUICommand()
boolean	removeFromPrivate(java.lang.Object key)
boolean	removeFromPublic(java.lang.Object key)
void	resetPublicCache()
void	setEmbeddedCommand(IUIBaseCommand command)
void	setID(java.lang.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	setPreparedForAdapterUICommand(boolean flag)
void	setRenderingInformation(java.util.Map map)
void	setRenderObjectContainer(com.sapportals.wcm.repository.service.layout.info.RenderObjectContainer roc)
void	setSettingsContainer(com.sapportals.wcm.repository.service.layout.info.SettingsContainer sic)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyStatus

public ProxyStatus()

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

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

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

public StatusInformation execute(java.lang.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

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

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

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

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

Parameters:

ident - 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

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

Parameters:

ident - TBD: Description of the incoming method parameter

Returns:

action

getFields

public java.util.List getFields()

Description copied from interface: IControlStatus

returns a list with all fields defined by the implementing class

Specified by:

getFields in interface IControlStatus

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

Returns:

fields

getActions

public java.util.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

Following copied from interface: com.sapportals.wcm.util.controlstatus.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

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

Returns:

statusInformation

addToPublic

public boolean addToPublic(java.lang.Object key,
                           java.lang.Object value,
                           boolean overwrite)

getFromPublic

public java.lang.Object getFromPublic(java.lang.Object key)

getPublicKeys

public java.util.Set getPublicKeys()

resetPublicCache

public void resetPublicCache()

removeFromPublic

public boolean removeFromPublic(java.lang.Object key)

addToPrivate

public boolean addToPrivate(java.lang.Object key,
                            java.lang.Object value,
                            boolean overwrite)

getFromPrivate

public java.lang.Object getFromPrivate(java.lang.Object key)

removeFromPrivate

public boolean removeFromPrivate(java.lang.Object key)

getEmbeddedCommand

public IUIBaseCommand getEmbeddedCommand()

setEmbeddedCommand

public void setEmbeddedCommand(IUIBaseCommand command)

getRenderingInformation

public java.util.Map getRenderingInformation()

setRenderingInformation

public void setRenderingInformation(java.util.Map map)

setRenderObjectContainer

public void setRenderObjectContainer(com.sapportals.wcm.repository.service.layout.info.RenderObjectContainer roc)

getRenderObjectContainer

public com.sapportals.wcm.repository.service.layout.info.RenderObjectContainer getRenderObjectContainer()

setSettingsContainer

public void setSettingsContainer(com.sapportals.wcm.repository.service.layout.info.SettingsContainer sic)

getSettingsContainer

public com.sapportals.wcm.repository.service.layout.info.SettingsContainer getSettingsContainer()

setPreparedForAdapterUICommand

public void setPreparedForAdapterUICommand(boolean flag)

isPreparedForAdapterUICommand

public boolean isPreparedForAdapterUICommand()

getID

public java.lang.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

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

Returns:

iD

setID

public void setID(java.lang.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

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

Parameters:

id - iD to be set

getHabitatStack

public com.sapportals.wcm.control.base.HabitatStack getHabitatStack()