com.ptc.core.ca.co.client.event
Interface CoInstruction

All Known Subinterfaces:

CoFrameInstruction, CoFrameLocationInstruction

All Known Implementing Classes:

CoFrameCloseInstruction, CoFrameGoBackInstruction, CoFrameGoToInstruction, CoFrameOpenInstruction, CoFrameRedrawInstruction, CoInvokeActionNeedingConfirmation, CoNodeInstruction

Deprecated.

@Deprecated
public interface CoInstruction

The inteface conceptual instructions implement. A concreate instruction might indicate the need to refresh a window, close a window, etc.

Supported API: true

Extendable: false

Field Summary

static String	PARAMS Deprecated. Label for the attribute; the map of parameters.
static String	RECEIVER_ADDRESS Deprecated. Label for the attribute; the external form of the full address of the receiver element.
static String	SENDER_ADDRESS Deprecated. Label for the attribute; the external form of the full address of the sender element.

Method Summary

HashMap	getParams() Deprecated. Gets the value of the attribute: PARAMS.
String	getReceiverAddress() Deprecated. Gets the value of the attribute: RECEIVER_ADDRESS.
String	getSenderAddress() Deprecated. Gets the value of the attribute: SENDER_ADDRESS.
void	setParams(HashMap a_Params) Deprecated. Sets the value of the attribute: PARAMS.
void	setReceiverAddress(String a_ReceiverAddress) Deprecated. Sets the value of the attribute: RECEIVER_ADDRESS.
void	setSenderAddress(String a_SenderAddress) Deprecated. Sets the value of the attribute: SENDER_ADDRESS.

Field Detail

SENDER_ADDRESS

static final String SENDER_ADDRESS

Deprecated.

Label for the attribute; the external form of the full address of the sender element.

Supported API: true

See Also:

Constant Field Values

RECEIVER_ADDRESS

static final String RECEIVER_ADDRESS

Deprecated.

Label for the attribute; the external form of the full address of the receiver element. Currently the address of the frame can be specified. However, the address is not equal to the address of the current frame, the opener window is assumed to be a receiver of the instructions.

Supported API: true

See Also:

Constant Field Values

PARAMS

static final String PARAMS

Deprecated.

Label for the attribute; the map of parameters. No elements, addresses, or other framework related objects are allowed to be placed in a map. The purpose of this restriction is to allow thread safe storage of instructions not intoducing additional memory consumption. Place strings containing external form of addresses in a map to inform about some elements.

Supported API: true

See Also:

Constant Field Values

Method Detail

getSenderAddress

String getSenderAddress()

Deprecated.

Gets the value of the attribute: SENDER_ADDRESS. the external form of the full address of the sender element.

Supported API: true

Returns:

String

setSenderAddress

void setSenderAddress(String a_SenderAddress)

Deprecated.

Sets the value of the attribute: SENDER_ADDRESS. the external form of the full address of the sender element.

Supported API: true

Parameters:

a_SenderAddress -

getReceiverAddress

String getReceiverAddress()

Deprecated.

Gets the value of the attribute: RECEIVER_ADDRESS. the external form of the full address of the receiver element. Currently the address of the frame can be specified. However, the address is not equal to the address of the current frame, the opener window is assumed to be a receiver of the instructions.

Supported API: true

Returns:

String

setReceiverAddress

void setReceiverAddress(String a_ReceiverAddress)

Deprecated.

Sets the value of the attribute: RECEIVER_ADDRESS. the external form of the full address of the receiver element. Currently the address of the frame can be specified. However, the address is not equal to the address of the current frame, the opener window is assumed to be a receiver of the instructions.

Supported API: true

Parameters:

a_ReceiverAddress -

getParams

HashMap getParams()

Deprecated.

Gets the value of the attribute: PARAMS. the map of parameters. No elements, addresses, or other framework related objects are allowed to be placed in a map. The purpose of this restriction is to allow thread safe storage of instructions not intoducing additional memory consumption. Place strings containing external form of addresses in a map to inform about some elements.

Supported API: true

Returns:

HashMap

setParams

void setParams(HashMap a_Params)

Deprecated.

Sets the value of the attribute: PARAMS. the map of parameters. No elements, addresses, or other framework related objects are allowed to be placed in a map. The purpose of this restriction is to allow thread safe storage of instructions not intoducing additional memory consumption. Place strings containing external form of addresses in a map to inform about some elements.

Supported API: true

Parameters:

a_Params -