com.bmc.arsys.api
Class OleAutomationAction

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

All Implemented Interfaces:

ActiveLinkAction, Serializable, Cloneable

public class OleAutomationAction
extends Action
implements ActiveLinkAction, Cloneable, Serializable

The AutomationInfo class is used to define the information of an OLE Automation active link action. The OLE Automation action shares functionality between applications that support OLE. When using this action, the AR System acts as an OLE automation controller client to an OLE server.

See Also:

Serialized Form

Constructor Summary

OleAutomationAction()
constructor

OleAutomationAction(String autoServerName, String clsId, String action, boolean isVisible, List<COMMethodInfo> methodList)

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.
String	getAction() Returns string specifying the equation defined by this action, including nested methods and the assignment, if any.
String	getAutoServerName() Returns string specifying the name of the Automation server, length limited by AR_MAX_COM_NAME (64 bytes).
String	getClsId() Returns string specifying the unique ID assigned to this server in the registry, length limited by AR_MAX_COM_ID_SIZE (128 bytes).
List<COMMethodInfo>	getMethodList() Returns list of methods called by this active link action.
int	hashCode() * Returns the hash code value for this instance of the current class.
boolean	isVisible() Returns whether the Automation Server is visible or not.
void	setAction(String action) Sets string specifying the equation defined by this action, including nested methods and the assignment, if any.
void	setAutoServerName(String autoServerName) Sets string specifying the name of the Automation server, length limited by AR_MAX_COM_NAME (64 bytes).
void	setClsId(String clsId) Sets string specifying the unique ID assigned to this server in the registry, length limited by AR_MAX_COM_ID_SIZE (128 bytes).
void	setMethodList(List<COMMethodInfo> methodList) Sets list of methods called by this active link action, specified by using the COMMethodInfo object.
void	setVisible(boolean isVisible) Sets flag to enable or disable the visibility of the Automation Server.
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

Constructor Detail

OleAutomationAction

public OleAutomationAction()

constructor

OleAutomationAction

public OleAutomationAction(String autoServerName,
                           String clsId,
                           String action,
                           boolean isVisible,
                           List<COMMethodInfo> methodList)

Method Detail

getAutoServerName

public String getAutoServerName()

Returns string specifying the name of the Automation server, length limited by AR_MAX_COM_NAME (64 bytes).

setAutoServerName

public void setAutoServerName(String autoServerName)

Sets string specifying the name of the Automation server, length limited by AR_MAX_COM_NAME (64 bytes).

getClsId

public String getClsId()

Returns string specifying the unique ID assigned to this server in the registry, length limited by AR_MAX_COM_ID_SIZE (128 bytes).

setClsId

public void setClsId(String clsId)

Sets string specifying the unique ID assigned to this server in the registry, length limited by AR_MAX_COM_ID_SIZE (128 bytes).

getAction

public String getAction()

Returns string specifying the equation defined by this action, including nested methods and the assignment, if any.

setAction

public void setAction(String action)

Sets string specifying the equation defined by this action, including nested methods and the assignment, if any. For example, $Status$ = MethodA().MethodB(MethodC()). It is used for display only, and limited by AR_MAX_AUTOMATION_SIZE (2000 bytes).

isVisible

public boolean isVisible()

Returns whether the Automation Server is visible or not.

setVisible

public void setVisible(boolean isVisible)

Sets flag to enable or disable the visibility of the Automation Server.

getMethodList

public List<COMMethodInfo> getMethodList()

Returns list of methods called by this active link action.

setMethodList

public void setMethodList(List<COMMethodInfo> methodList)

Sets list of methods called by this active link action, specified by using the COMMethodInfo object. The methods must be listed in order of execution. Therefore, if Method B is passed as a parameter to Method A, Method B should be listed first so that its result value will be available when Method A is called.

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