AR System Java API

com.bmc.arsys.api
Class DDEAction

java.lang.Object
  extended by com.bmc.arsys.api.Action
      extended by com.bmc.arsys.api.DDEAction
All Implemented Interfaces:
ActiveLinkAction, Serializable, Cloneable

public class DDEAction
extends Action
implements ActiveLinkAction, Cloneable, Serializable

The DDEAction class specifies a DDE result value to assign in a Set Fields action. This option is available for active links on Windows clients only.

See Also:
Serialized Form

Constructor Summary
DDEAction()
          constructor
DDEAction(String serviceName, String topic, String item, int action, String pathToProgram, String command)
           
 
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 between the current object and the provided one.
 String format()
           
 int getAction()
          Returns integer value identifying the type of DDE action.
 String getCommand()
          Returns string specifying the command to execute.
 String getItem()
          Returns string specifying the item to retrieve.
 String getPathToProgram()
          Returns string specifying the path to the application.
 String getServiceName()
          Returns string specifying the service to use.
 String getTopic()
          Returns string specifying the topic to use.
 int hashCode()
          Returns the hash code value for this instance of the current class.
static DDEAction parse(String assignment)
           
 void setAction(int action)
          Sets integer value identifying the type of DDE action.
 void setCommand(String command)
          Sets string specifying the command to execute.
 void setItem(String item)
          Sets string specifying the item to retrieve.
 void setPathToProgram(String pathToProgram)
          Sets string specifying the path to the application.
 void setServiceName(String serviceName)
          Sets string specifying the service to use.
 void setTopic(String topic)
          Sets string specifying the topic to use.
 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

DDEAction

public DDEAction()
constructor


DDEAction

public DDEAction(String serviceName,
                 String topic,
                 String item,
                 int action,
                 String pathToProgram,
                 String command)
Method Detail

getServiceName

public String getServiceName()
Returns string specifying the service to use.


setServiceName

public void setServiceName(String serviceName)
Sets string specifying the service to use.


getTopic

public String getTopic()
Returns string specifying the topic to use.


setTopic

public void setTopic(String topic)
Sets string specifying the topic to use.


getItem

public String getItem()
Returns string specifying the item to retrieve.


setItem

public void setItem(String item)
Sets string specifying the item to retrieve.


getAction

public int getAction()
Returns integer value identifying the type of DDE action.


setAction

public void setAction(int action)
Sets integer value identifying the type of DDE action. Specify AR_DDE_REQUEST for this item.


getPathToProgram

public String getPathToProgram()
Returns string specifying the path to the application.


setPathToProgram

public void setPathToProgram(String pathToProgram)
Sets string specifying the path to the application.


getCommand

public String getCommand()
Returns string specifying the command to execute.


setCommand

public void setCommand(String command)
Sets string specifying the command to execute. Specify NULL for this item.


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 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 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()
Returns a string description of the object.

Overrides:
toString in class Action

parse

public static DDEAction parse(String assignment)

format

public String format()

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.