com.ptc.windchill.cadx.common
Class BasicWildfireNavBarActionDelegate

java.lang.Object
  com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate

All Implemented Interfaces:

ActionDelegate, NavBarActionDelegate, WildfireActionDelegate, WildfireNavBarCommonActionDelegate

Direct Known Subclasses:

AssociateActionDelegate, AssociateFromWsActionDelegate, AutoAssociateActionDelegate, AutoPartActionDelegate, CancelCheckoutActionDelegate, CancelCheckoutActionDelegate, CheckedOutToWorkspaceActionDelegate, CheckinActionDelegate, CheckinActionDelegate, CreateRepWFActionDelegate, DeleteActionDelegate, DisassociateActionDelegate, DisassociateFromWsActionDelegate, DownloadActionDelegate, EDACompareActionDelegate, EditAttachmentsActionDelegate, EditAttributesActionDelegate, ListRepsWFActionDelegate, MultiEditAttrActionDelegate, MultiRenameActionDelegate, MultiReviseActionDelegate, NewCadDocActionDelegate, NewCADDocFamilyInfoActionDelegate, NewCADDocFamilyInfoActionDelegate, NewCADDocPropertyActionDelegate, NewCADDocRefByPageActionDelegate, NewCADDocRefPageActionDelegate, NewCADDocUsedByPageActionDelegate, NewCADDocUsesPageActionDelegate, NewPartActionDelegate, OpenInProEActionDelegate, OpenInPVActionDelegate, PlaceHolderActionDelegate, ProductViewWFActionDelegate, RemoveActionDelegate, RenameActionDelegate, ReplaceMissDepActionDelegate, ReviseActionDelegate, SaveAsActionDelegate, SaveAsActionDelegate, SaveAsFromWsActionDelegate, SetStateActionDelegate, SynchronizeWorkspaceActionDelegate, UpdateActionDelegate, UploadActionDelegate, UploadActionDelegate, WFCheckoutActionDelegate, WFMoveActionDelegate

public abstract class BasicWildfireNavBarActionDelegate

extends Object

implements WildfireNavBarCommonActionDelegate

Supported API: false

Extendable: false

Field Summary

private static String	CLASSNAME
private EPMWorkspace	contextWorkspace
private Boolean	isValidInInActive
private Boolean	neverInStandAlone
private static String	RESOURCE
protected HTTPState	state

Fields inherited from interface wt.enterprise.ActionDelegate

CONTEXT_SERVICE_NAME

Constructor Summary

BasicWildfireNavBarActionDelegate()

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.
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.
Boolean	enableable(Object object, HTTPState state) 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.
EPMWorkspace	getContextWorkspace() Gets the value of the attribute: contextWorkspace.
Boolean	getIsValidInInActive() Gets the value of the attribute: isValidInInActive.
Boolean	getNeverInStandAlone() Gets the value of the attribute: neverInStandAlone.
void	setActionName(String action) Sets the current Action.
void	setContextWorkspace(EPMWorkspace a_ContextWorkspace) Sets the value of the attribute: contextWorkspace.
void	setIsValidInInActive(Boolean a_IsValidInInActive) Sets the value of the attribute: isValidInInActive.
void	setNeverInStandAlone(Boolean a_NeverInStandAlone) Sets the value of the attribute: neverInStandAlone.
void	setState(HTTPState state) Sets the current HTTPState from the TemplateProcessor that is being used to generate the Navigation Bar.

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.enterprise.ActionDelegate

getContextServiceName, valid

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

isValidInInActive

private Boolean isValidInInActive

contextWorkspace

private EPMWorkspace contextWorkspace

neverInStandAlone

private Boolean neverInStandAlone

state

protected HTTPState state

Constructor Detail

BasicWildfireNavBarActionDelegate

public BasicWildfireNavBarActionDelegate()

Method Detail

getIsValidInInActive

public Boolean getIsValidInInActive()

Gets the value of the attribute: isValidInInActive.

Supported API: false

Returns:

Boolean

setIsValidInInActive

public void setIsValidInInActive(Boolean a_IsValidInInActive)
                          throws WTPropertyVetoException

Sets the value of the attribute: isValidInInActive.

Supported API: false

Parameters:

a_IsValidInInActive -

Throws:

WTPropertyVetoException

getContextWorkspace

public EPMWorkspace getContextWorkspace()

Gets the value of the attribute: contextWorkspace.

Supported API: false

Returns:

EPMWorkspace

setContextWorkspace

public void setContextWorkspace(EPMWorkspace a_ContextWorkspace)
                         throws WTPropertyVetoException

Sets the value of the attribute: contextWorkspace.

Supported API: false

Specified by:

setContextWorkspace in interface WildfireNavBarCommonActionDelegate

Parameters:

a_ContextWorkspace -

Throws:

WTPropertyVetoException

getNeverInStandAlone

public Boolean getNeverInStandAlone()

Gets the value of the attribute: neverInStandAlone.

Supported API: false

Returns:

Boolean

setNeverInStandAlone

public void setNeverInStandAlone(Boolean a_NeverInStandAlone)
                          throws WTPropertyVetoException

Sets the value of the attribute: neverInStandAlone.

Supported API: false

Parameters:

a_NeverInStandAlone -

Throws:

WTPropertyVetoException

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

enableable

public Boolean enableable(Object object,
                          HTTPState state)
                   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

Parameters:

object -

state -

Returns:

Boolean

Throws:

WTException

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

Parameters:

object -

request -

Returns:

Boolean

Throws:

WTException

setState

public void setState(HTTPState state)

Sets the current HTTPState from the TemplateProcessor that is being used to generate the Navigation Bar.

Supported API: false

Supported API: false

Supported API: false

Specified by:

setState in interface NavBarActionDelegate

Parameters:

state - The current HTTPState.

Returns:

void

setActionName

public void setActionName(String action)
                   throws WTPropertyVetoException

Sets the current Action. This is a bit of a kludge to allow re-using existing ActionDelegates

Supported API: false

Supported API: false

Supported API: false

Specified by:

setActionName in interface NavBarActionDelegate

Parameters:

action -

Returns:

void

Throws:

WTPropertyVetoException