com.bmc.arsys.api
Class GotoAction

java.lang.Object
  com.bmc.arsys.api.Action
      com.bmc.arsys.api.GotoAction

All Implemented Interfaces:

ActiveLinkAction, FilterAction, Serializable, Cloneable

public class GotoAction
extends Action
implements ActiveLinkAction, FilterAction, Cloneable, Serializable

The GotoActionInfo class is used to create and retrieve information about the Goto workflow action. You use the Goto action to execute an active link or filter in some order other than the normal sequence determined by the active link or filter execution order. For more information, see the Developing AR System Applications: Basic guide.

See Also:

Serialized Form

Field Summary

static int	AR_GOTO_ABSOLUTE_ORDER Skips directly to the action whose number is defined as part of the action.
static int	AR_GOTO_FIELD_XREF Skip to the action whose number is in the cross-referenced field.
static int	AR_GOTO_OFFSET_BACKWARD Skips backward to the action that is behind the cross-referenced field, by the specified offset amount.
static int	AR_GOTO_OFFSET_FORWARD Skips forward to the action that is ahead of the cross-referenced field, by the specified offset amount.

Constructor Summary

GotoAction()
constructor

GotoAction(int tag, int fieldIdOrValue)
Constructs a new GotoActionInfoobject with the following parameters:

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality.
int	getFieldIdOrValue() Returns field ID or value of label.
int	getTag() Returns tag.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setFieldIdOrValue(int fieldIdOrValue) Sets field ID or execution order.
void	setTag(int tag) Sets tag.
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.Action

equals, getActionType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

AR_GOTO_FIELD_XREF

public static final int AR_GOTO_FIELD_XREF

Skip to the action whose number is in the cross-referenced field.

See Also:

Constant Field Values

AR_GOTO_ABSOLUTE_ORDER

public static final int AR_GOTO_ABSOLUTE_ORDER

Skips directly to the action whose number is defined as part of the action.

See Also:

Constant Field Values

AR_GOTO_OFFSET_FORWARD

public static final int AR_GOTO_OFFSET_FORWARD

Skips forward to the action that is ahead of the cross-referenced field, by the specified offset amount.

See Also:

Constant Field Values

AR_GOTO_OFFSET_BACKWARD

public static final int AR_GOTO_OFFSET_BACKWARD

Skips backward to the action that is behind the cross-referenced field, by the specified offset amount.

See Also:

Constant Field Values

Constructor Detail

GotoAction

public GotoAction()

constructor

GotoAction

public GotoAction(int tag,
                  int fieldIdOrValue)

Constructs a new GotoActionInfoobject with the following parameters:

Parameters:

tag - Tells whether fieldIdOrValue parameter is actual execution order or the field ID.

fieldIdOrValue - Either the absolute execution order or the ID of the integer field.

Method Detail

getTag

public int getTag()

Returns tag.

setTag

public void setTag(int tag)

Sets tag.

getFieldIdOrValue

public int getFieldIdOrValue()

Returns field ID or value of label. Should be interpreted based on the tag.

setFieldIdOrValue

public void setFieldIdOrValue(int fieldIdOrValue)

Sets field ID or execution order.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Action

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Use this method for checking equality. The result is true only if the argument is not null, is of same type and represents the same content.

Overrides:

equals in class Action

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Action

Returns:

returns the hash code for this instance

toString

public String toString()

Description copied from class: Action

Returns a string description of the object.

Overrides:

toString in class Action