com.remedy.arsys.api
Class AutomationInfo

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

All Implemented Interfaces:

java.lang.Cloneable

public class AutomationInfo

extends java.lang.Object

implements java.lang.Cloneable

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.

Constructor Summary

AutomationInfo()
constructor

AutomationInfo(java.lang.String autoServerName, java.lang.String clsId, java.lang.String action, boolean isVisible, COMMethodInfo[] methodList)

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.
java.lang.String	getAction() Returns string specifying the equation defined by this action, including nested methods and the assignment, if any.
java.lang.String	getAutoServerName() Returns string specifying the name of the Automation server, length limited by AR_MAX_COM_NAME (64 bytes).
java.lang.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).
boolean	getIsVisible() Not used.
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.
void	setAction(java.lang.String action) Sets string specifying the equation defined by this action, including nested methods and the assignment, if any.
void	setAutoServerName(java.lang.String autoServerName) Sets string specifying the name of the Automation server, length limited by AR_MAX_COM_NAME (64 bytes).
void	setClsId(java.lang.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	setIsVisible(boolean isVisible) Not used.
void	setMethodList(COMMethodInfo[] methodList) Sets list of methods called by this active link action, specified by using the COMMethodInfo object.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutomationInfo

public AutomationInfo()

constructor

AutomationInfo

public AutomationInfo(java.lang.String autoServerName,
                      java.lang.String clsId,
                      java.lang.String action,
                      boolean isVisible,
                      COMMethodInfo[] methodList)

Method Detail

getAutoServerName

public java.lang.String getAutoServerName()

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

setAutoServerName

public void setAutoServerName(java.lang.String autoServerName)

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

getClsId

public java.lang.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(java.lang.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 java.lang.String getAction()

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

setAction

public void setAction(java.lang.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).

getIsVisible

public boolean getIsVisible()

Not used.

setIsVisible

public void setIsVisible(boolean isVisible)

Not used.

getMethodList

public COMMethodInfo[] getMethodList()

Returns list of methods called by this active link action.

setMethodList

public void setMethodList(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 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.