com.remedy.arsys.api
Class GotoActionInfo

java.lang.Object
  com.remedy.arsys.api.GotoActionInfo

All Implemented Interfaces:

java.lang.Cloneable

public class GotoActionInfo

extends java.lang.Object

implements java.lang.Cloneable

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.

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

GotoActionInfo()
constructor

GotoActionInfo(long tag, long fieldIdOrValue)
Constructs a new GotoActionInfoobject with the following parameters:

Method Summary

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, 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

GotoActionInfo

public GotoActionInfo()

constructor

GotoActionInfo

public GotoActionInfo(long tag,
                      long 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 long getTag()

Returns tag.

setTag

public void setTag(long tag)

Sets tag.

getFieldIdOrValue

public long getFieldIdOrValue()

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

setFieldIdOrValue

public void setFieldIdOrValue(long fieldIdOrValue)

Sets field ID or execution order.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object anObject)

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.

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.