com.ptc.windchill.uwgm.cadx.cancelcheckout
Class CancelCheckoutActionDelegate

java.lang.Object
  com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate
      com.ptc.windchill.uwgm.cadx.cancelcheckout.CancelCheckoutActionDelegate

All Implemented Interfaces:

ActionDelegate, NavBarActionDelegate, WildfireActionDelegate, WildfireNavBarCommonActionDelegate

Direct Known Subclasses:

CancelCheckoutURLActionDelegate

public class CancelCheckoutActionDelegate

extends BasicWildfireNavBarActionDelegate

Supported API: false

Extendable: false

Field Summary

private static String	CLASSNAME
static String	CONTEXT_SERVICE_NAME
private static String	RESOURCE

Fields inherited from class com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate

state

Constructor Summary

CancelCheckoutActionDelegate()

Method Summary

Boolean	enableable(Object object, HTTPRequest request) 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.
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.

Methods inherited from class com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate

enableable, enableable, getContextWorkspace, getIsValidInInActive, getNeverInStandAlone, setActionName, setContextWorkspace, setIsValidInInActive, setNeverInStandAlone, setState

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

CONTEXT_SERVICE_NAME

public static final String CONTEXT_SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

CancelCheckoutActionDelegate

public CancelCheckoutActionDelegate()

Method Detail

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

Parameters:

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

Returns:

Boolean

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

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 -

enableable

public Boolean enableable(Object object,
                          HTTPRequest request)
                   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 implementation of the method considers the origin of the HTTPRequest (user agent) and is acceptable to use for all classes implementing the WildfireActionDelegate interface. The method enableable(Object) is not valid for objects implementing WildfireActionDelegate and will throw an exception.

Supported API: false

Specified by:

enableable in interface WildfireActionDelegate

Overrides:

enableable in class BasicWildfireNavBarActionDelegate

Parameters:

object -

request -

Returns:

Boolean

Throws:

WTException