com.bmc.arsys.api

Class Action

java.lang.Object

com.bmc.arsys.api.Action

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

CallGuideAction, ChangeFieldAction, CloseWindowAction, CommitChangesAction, DDEAction, DirectSqlAction, ExitGuideAction, FilterMessageAction, GotoAction, GotoGuideLabelAction, LogAction, MessageAction, NotifyAction, OleAutomationAction, OpenWindowAction, PushFieldsAction, RunMacroAction, RunProcessAction, ServiceAction, SetFieldsAction, WaitAction

public abstract class Action
extends Object
implements Cloneable

Reserved for internal use.

Constructor Summary

Constructors

Constructor and Description
Action()

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
boolean	equals(Object anObject, String lhsServer, String lhsForm, String rhsServer, String rhsForm)
static int	getActionType(Action action, boolean isActiveLinkAction) take the workflow action, and return an action type that is defined in API Constants class.
int	hashCode() Returns the hash code value for this instance of the current class.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Action

public Action()

Method Detail

getActionType

public static int getActionType(Action action,
                                boolean isActiveLinkAction)

take the workflow action, and return an action type that is defined in API Constants class. The type that returned matches with the on define in ARSystem C API.

Parameters:

action - action object

isActiveLinkAction - if it is an activelink action. Some actions, such as Push Field or Set Field exists in both activelink and filter. However, we use a different type to distingush between active link action and filter action. Active link is a client side logic, while Filter represents a server side logic.

Returns:

the action type for the given Action instance.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

equals

public boolean equals(Object anObject,
                      String lhsServer,
                      String lhsForm,
                      String rhsServer,
                      String rhsForm)

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 Object

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object