com.ptc.core.ca.co.client.simple
Interface CoSimpleActionHandlerData

All Superinterfaces:

CoActionHandlerData, CoHandlerData, CoSimpleHandlerData

All Known Implementing Classes:

CoClipboardActionHandlerData, CoDefaultSimpleActionHandlerData, CoDefaultWizardHandlerData, CoPropertyRetrieverOkActionHandlerData

Deprecated.

@Deprecated
public interface CoSimpleActionHandlerData
extends CoActionHandlerData, CoSimpleHandlerData

Action handlers using "simple approach" pass the instance of handler data that implements this interface as a parameter to methods they call.

Supported API: true

Extendable: false

Field Summary

static String	ACTION_HOLDER Deprecated. Label for the attribute; the logical "holder" of the action.
static String	ACTION_HOLDER_RELATED_INSTANCE Deprecated. Label for the attribute; the Info*Engine element related to a logical "holder" of an action wrapped into CoInstance Supported API: true
static String	ACTION_HOLDER_RELATED_TYPE_ID Deprecated. Label for the attribute; the type of the Info*Engine element related to a logical "holder" of an action.
static String	ACTION_HOLDER_RELATED_UFID Deprecated. Label for the attribute; the UFID of the Info*Engine element related to a logical "holder" of an action.
static String	INSTANCE_HOLDERS Deprecated. Label for the attribute; the list of conceptual elements the action was triggered on behalf of.

Fields inherited from interface com.ptc.core.ca.co.client.action.CoActionHandlerData

ACTION, ACTION_TRIGGERED

Fields inherited from interface com.ptc.core.ca.co.client.element.CoHandlerData

ENV_DATA

Fields inherited from interface com.ptc.core.ca.co.client.simple.CoSimpleHandlerData

OPENER_ACTION_ADDRESS

Method Summary

CoElement	getActionHolder() Deprecated. Gets the value of the attribute: ACTION_HOLDER.
CoInstance	getActionHolderRelatedInstance() Deprecated. Gets the value of the attribute: ACTION_HOLDER_RELATED_INSTANCE.
String	getActionHolderRelatedTypeId() Deprecated. Gets the value of the attribute: ACTION_HOLDER_RELATED_TYPE_ID.
String	getActionHolderRelatedUfid() Deprecated. Gets the value of the attribute: ACTION_HOLDER_RELATED_UFID.
ArrayList	getInstanceHolders() Deprecated. Gets the value of the attribute: INSTANCE_HOLDERS.

Methods inherited from interface com.ptc.core.ca.co.client.action.CoActionHandlerData

getAction, isActionTriggered, setActionTriggered

Methods inherited from interface com.ptc.core.ca.co.client.element.CoHandlerData

getEnvData

Methods inherited from interface com.ptc.core.ca.co.client.simple.CoSimpleHandlerData

getOpenerActionAddress

Field Detail

ACTION_HOLDER

static final String ACTION_HOLDER

Deprecated.

Label for the attribute; the logical "holder" of the action. This is not necessarily an action parent but rather an element an action logically belongs to. For instance, an action in the list of actions in a table's toolbar will have the table as the action holder and not the action list.

Supported API: true

See Also:

Constant Field Values

ACTION_HOLDER_RELATED_TYPE_ID

static final String ACTION_HOLDER_RELATED_TYPE_ID

Deprecated.

Label for the attribute; the type of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

See Also:

Constant Field Values

ACTION_HOLDER_RELATED_UFID

static final String ACTION_HOLDER_RELATED_UFID

Deprecated.

Label for the attribute; the UFID of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

See Also:

Constant Field Values

ACTION_HOLDER_RELATED_INSTANCE

static final String ACTION_HOLDER_RELATED_INSTANCE

Deprecated.

Label for the attribute; the Info*Engine element related to a logical "holder" of an action wrapped into CoInstance

Supported API: true

See Also:

Constant Field Values

INSTANCE_HOLDERS

static final String INSTANCE_HOLDERS

Deprecated.

Label for the attribute; the list of conceptual elements the action was triggered on behalf of. For instance

• a list of selected rows in a table for an action in a toolbar.
• a row in a table for an action in a row
• a property panel for an action in a panel

Supported API: true

See Also:

Constant Field Values

Method Detail

getActionHolder

CoElement getActionHolder()

Deprecated.

Gets the value of the attribute: ACTION_HOLDER. the logical "holder" of the action. This is not necessarily an action parent but rather an element an action logically belongs to. For instance, an action in the list of actions in a table's toolbar will have the table as the action holder and not the action list.

Supported API: true

Returns:

CoElement

getActionHolderRelatedTypeId

String getActionHolderRelatedTypeId()
                                    throws WTException

Deprecated.

Gets the value of the attribute: ACTION_HOLDER_RELATED_TYPE_ID. the type of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

Returns:

String

Throws:

WTException

getActionHolderRelatedUfid

String getActionHolderRelatedUfid()
                                  throws WTException

Deprecated.

Gets the value of the attribute: ACTION_HOLDER_RELATED_UFID. the UFID of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

Returns:

String

Throws:

WTException

getActionHolderRelatedInstance

CoInstance getActionHolderRelatedInstance()
                                          throws WTException

Deprecated.

Gets the value of the attribute: ACTION_HOLDER_RELATED_INSTANCE. the Info*Engine element related to a logical "holder" of an action wrapped into CoInstance

Supported API: true

Returns:

CoInstance

Throws:

WTException

getInstanceHolders

ArrayList getInstanceHolders()

Deprecated.

Gets the value of the attribute: INSTANCE_HOLDERS. the list of conceptual elements the action was triggered on behalf of. For instance

• a list of selected rows in a table for an action in a toolbar.
• a row in a table for an action in a row
• a property panel for an action in a panel

Supported API: true

Returns:

ArrayList