com.sap.portal.pcm.admin

Class ObjectState

java.lang.Object

com.sap.portal.pcm.admin.ObjectState

public class ObjectState
extends Object

The interface that represents possible states of an object.

A portal object can have several states that influence its behavior. For example, a portal object that represents a PCD folder/directory can have two states: open, meaning an end user is navigating in it or in one of its sub-directories, or closed. When displaying the icon of this folder, you might want to use a different icon for each state.

A state is defined by its name.

The only predefined state is the default state.

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectState	DEFAULT A constant that represents the default state of an object.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectState(String state) Constructs an object state with the specified name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(ObjectState state) Indicates whether two states are equal.
String	toString() Returns a string representation of the object state.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ObjectState DEFAULT

A constant that represents the default state of an object.

Constructor Detail

ObjectState

protected ObjectState(String state)

Constructs an object state with the specified name.

Parameters:

state - the state name

Method Detail

equals

public boolean equals(ObjectState state)

Indicates whether two states are equal.

Parameters:

state - the state name

Returns:

true if the states have the same name, not case sensitive

toString

public String toString()

Returns a string representation of the object state.

Overrides:

toString in class Object

Returns:

the object state name