wt.enterprise
Interface ActionDelegate

All Known Subinterfaces:

NavBarActionDelegate, WildfireActionDelegate, WildfireNavBarCommonActionDelegate

All Known Implementing Classes:

AddToProjectActionDelegate, AllConfigurationsActionDelegate, AllInstancesActionDelegate, AllVersionsActionDelegate, BasicWildfireNavBarActionDelegate, ChangeActivityAddEffActionDelegate, ChangeItemViewEffActionDelegate, ChangeOrderAddEffActionDelegate, CheckedOutWorkActionDelegate, CheckInActionDelegate, CheckOutActionDelegate, CopyActionDelegate, CreateTemplateCADDocument2ActionDelegate, CreateTemplateCADDocument3ActionDelegate, CreateWTProductInstanceActionDelegate, DefaultNavBarActionDelegate, DefineAlternatesActionDelegate, DefineSubstitutesActionDelegate, DelegateNavBarActionDelegate, DeleteActionDelegate, DeleteActionDelegate, DeleteCabinetsActionDelegate, DeleteWorkspaceActionDelegate, DeleteWTProductInstanceActionDelegate, DisableActionDelegate, EditContentActionDelegate, EditDisplayActionDelegate, EditSearchActionDelegate, EditStructureNavigatorActionDelegate, EditTablesActionDelegate, EditVisualActionDelegate, EffHistoryActionDelegate, ElectronicSignaturesActionDelegate, EnableActionDelegate, EPMContainsActionDelegate, ExportActionDelegate, ExportStatusActionDelegate, ForumActionDelegate, GeneralActionDelegate, GetContentActionDelegate, ImportActionDelegate, ImportStatusActionDelegate, IterationHistoryActionDelegate, LifeCycleHistoryActionDelegate, ListPartsActionDelegate, MadeFromActionDelegate, MoveActionDelegate, MoveActionDelegate, MyWorkspaceNavBarActionDelegate, NavBarForumActionDelegate, PasteActionDelegate, PublicationActionDelegate, ReAuthenticationActionDelegate, ReceiveActionDelegate, ReceiveStatusActionDelegate, RemoveDocumentFromPartActionDelegate, RemoveESIAssociationFromPartActionDelegate, RenameActionDelegate, ReportTemplateExecuteActionDelegate, ReviseActionDelegate, SaveAsActionDelegate, SearchLibraryPrefsActionDelegate, SendActionDelegate, SendStatusActionDelegate, SetIncorporatedActionDelegate, SetPlannedIncorporationActionDelegate, ShareStatusActionDelegate, ShowDistributionListActionDelegate, SubmitActionDelegate, SubscriptionActionDelegate, ThumbnailActionDelegate, UndoCheckoutActionDelegate, UndoPDMCheckoutActionDelegate, UpdateActionDelegate, UpdateChangeIssueActionDelegate, UpdateWTProductInstanceActionDelegate, VersionHistoryActionDelegate, ViewableActionDelegate, ViewLogActionDelegate, ViewMarkupActionDelegate, WfCheckinActionDelegate, WsprefActionDelegate

public interface ActionDelegate

Defines methods that test the viability of a user action on an object. Used to test if an action could be valid(java.lang.Object) for an object of a particular type (should it be a menu item) and if the action is enableable(java.lang.Object) for the specific object (should the menu item be enabled).

Supported API: true

Extendable: true

Field Summary

static String

CONTEXT_SERVICE_NAME Deprecated.

Method Summary

Boolean	enableable(Object object) Deprecated.
String	getContextServiceName() Deprecated.
Boolean	valid(Object object) Deprecated.

Field Detail

CONTEXT_SERVICE_NAME

public static final String CONTEXT_SERVICE_NAME

Deprecated.

Supported API: false

See Also:

Constant Field Values

Method Detail

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

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

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

Returns:

String