Package wt.enterprise

Class CheckInActionDelegate

java.lang.Object
wt.enterprise.CheckInActionDelegate
All Implemented Interfaces:
Externalizable, Serializable, ActionDelegate
Direct Known Subclasses:
CheckInURLActionDelegate

public class CheckInActionDelegate extends Object implements ActionDelegate, Externalizable
Defines methods that test the viability of a user doing a check-in on an object.

Supported API: true

Extendable: false
See Also:
  • Method Details

    • valid

      public Boolean valid(Object object)
      Deprecated.
      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: true
      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
      Deprecated.
      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: true
      Specified by:
      enableable in interface ActionDelegate
      Parameters:
      object - The object that you wish to set enabled.
      Returns:
      Boolean
      Throws:
      WTException
    • getContextServiceName

      public String getContextServiceName()
      Deprecated.
      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: true
      Specified by:
      getContextServiceName in interface ActionDelegate
      Returns:
      String