com.sapportals.wcm.util.controlstatus

Class ControlStatusService

java.lang.Object
  com.sapportals.wcm.util.controlstatus.ControlStatusService

public class ControlStatusService
extends Object

Field Summary

static String	CACHE
static String	CSS
static int	MAX_SIZE

Method Summary

String	addControlStatus(IControlStatus status) adds the given object and returns the key to retrieve the object again through the getControlStatus method.
boolean	deleteControlStatus(String key) deletes an IControlStatus object with the given key from the service's persistence.
List	getCacheEntries(Locale locale)
IControlStatus	getControlStatus(String key) returns the IControlStatus that has been saved with this key.
static ControlStatusService	getInstance() returns the singleton instance of this service.

Methods inherited from class java.lang.Object

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

Field Detail

CSS

public static final String CSS

See Also:

Constant Field Values

CACHE

public static final String CACHE

See Also:

Constant Field Values

MAX_SIZE

public static final int MAX_SIZE

See Also:

Constant Field Values

Method Detail

getInstance

public static ControlStatusService getInstance()

returns the singleton instance of this service. If this method is called for the first time, the service will read its configuration to initialize its persistence layer, using the CacheFactory . If no configuration can be found or the configuration is invalid, the service will use a simple HashMap to store IControlStatus elements. This mode is unsafe and error messages will be provided in the log files.

Returns:

the singleton instance of this service

getControlStatus

public IControlStatus getControlStatus(String key)
                                throws ControlStatusException

returns the IControlStatus that has been saved with this key.

Parameters:

key - TBD: Description of the incoming method parameter

Returns:

an IControlStatus object or null .

Throws:

ControlStatusException - if an exception in the persistence layer occurs. The original exception is nested within the thrown exception.

getCacheEntries

public List getCacheEntries(Locale locale)

addControlStatus

public String addControlStatus(IControlStatus status)
                        throws ControlStatusException

adds the given object and returns the key to retrieve the object again through the getControlStatus method. This method is synchronized because execution of this method might change the structure of the underlying persistence. The returned key is also added as an attribute to the status.

Parameters:

status - the object to store

Returns:

the key to retrieve the given object at a later time

Throws:

ControlStatusException - if an exception in the persistence layer occurs. The original exception is nested within the thrown exception.

deleteControlStatus

public boolean deleteControlStatus(String key)
                            throws ControlStatusException

deletes an IControlStatus object with the given key from the service's persistence.

Parameters:

key - the key of the object to delete

Returns:

flag stating if a document was found and consequently deleted ( true ) or if no element could be found (false ).

Throws:

ControlStatusException - if an exception in the persistence layer occurs. The original exception is nested within the thrown exception. If the exception is thrown, it is unknown, if the object has been deleted or not.

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