wt.epm.clients.htmltemplates
Class EPMContainsActionDelegate

java.lang.Object
  wt.epm.clients.htmltemplates.EPMContainsActionDelegate

All Implemented Interfaces:

ActionDelegate, Externalizable, Serializable

Direct Known Subclasses:

EPMURLContainsActionDelegate

public class EPMContainsActionDelegate

extends Object

implements ActionDelegate, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTEXT_SERVICE_NAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

EPMContainsActionDelegate()

Method Summary

Boolean	enableable(Object object) Tests if the action is currently applicable to the instance object; commonly used at the time a GUI is generated to see if the action should be "enabled" for the object, another common usage will be at the time that the action is to be performed, to see if it is still applicable.
String	getContextServiceName() This method is to allow access to the variable, CONTEXT_SERVICE_NAME.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EPMContainsActionDelegate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	setContextServiceName(String newContextServiceName) This method is to allow setting the variable, CONTEXT_SERVICE_NAME.
Boolean	valid(Object object) Tests if the action is valid on all instances of the class of object; commonly used in the construction of dynamically generated GUIs to determine if a particular action should appear.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

CONTEXT_SERVICE_NAME

public static final String CONTEXT_SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

EPMContainsActionDelegate

public EPMContainsActionDelegate()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMContainsActionDelegate thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

valid

public Boolean valid(Object object)

Tests if the action is valid on all instances of the class of object; commonly used in the construction of dynamically generated GUIs to determine if a particular action should appear. For instance, the valid method of the "check-in" action will test if the object is "Workable" or not.

Supported API: false

Specified by:

valid in interface ActionDelegate

Parameters:

object - The object that you want to test validity on.

Returns:

Boolean

enableable

public Boolean enableable(Object object)
                   throws WTException

Tests if the action is currently applicable to the instance object; commonly used at the time a GUI is generated to see if the action should be "enabled" for the object, another common usage will be at the time that the action is to be performed, to see if it is still applicable. This method should not be called when the concrete ActionDelegate class is unknown. In that case, call BasicTemplateProcessor.accessOK() instead.

Supported API: false

Specified by:

enableable in interface ActionDelegate

Parameters:

object - The object that you wish to set enabled.

Returns:

Boolean

Throws:

WTException

getContextServiceName

public String getContextServiceName()

This method is to allow access to the variable, CONTEXT_SERVICE_NAME. The role of the variable CONTEXT_SERVICE_NAME is to provide a reference name of the Action being performed. The value of CONTEXT_SERVICE_NAME should be set in the subclass that implements this interface.

Supported API: false

Specified by:

getContextServiceName in interface ActionDelegate

Returns:

String

setContextServiceName

protected void setContextServiceName(String newContextServiceName)

This method is to allow setting the variable, CONTEXT_SERVICE_NAME. The role of the variable CONTEXT_SERVICE_NAME is to provide a reference name of the Action being performed. The value of CONTEXT_SERVICE_NAME should be set in the subclass that implements this interface.

Supported API: false

Parameters:

newContextServiceName -