7.0 Action Request System Java API

com.remedy.arsys.api
Class AssignInfo

java.lang.Object
  extended bycom.remedy.arsys.api.AssignInfo
All Implemented Interfaces:
java.lang.Cloneable

public class AssignInfo
extends java.lang.Object
implements java.lang.Cloneable

The AssignInfo class lets you define Set Fields action in filters, escalations, or active links. The methods below identify a field/value pair to update. These methods contain the internal ID of the field to update and the value to assign.


Field Summary
static int AR_ASSIGN_TYPE_ARITH
          AR_ASSIGN_TYPE_ARITH is the result value from an arithmetic operation.
static int AR_ASSIGN_TYPE_DDE
          AR_ASSIGN_TYPE_DDE is the result value from a DDE request to another application.
static int AR_ASSIGN_TYPE_FIELD
          AR_ASSIGN_TYPE_FIELD is a Schema field value.
static int AR_ASSIGN_TYPE_FILTER_API
          AR_ASSIGN_TYPE_FILTER_API is the result value from a filter API command.
static int AR_ASSIGN_TYPE_FUNCTION
          AR_ASSIGN_TYPE_FUNCTION is the return value from a function.
static int AR_ASSIGN_TYPE_NONE
          AR_ASSIGN_TYPE_NONE No value is assigned.
static int AR_ASSIGN_TYPE_PROCESS
          AR_ASSIGN_TYPE_PROCESS is the output value from successful execution of an operating system process or command.
static int AR_ASSIGN_TYPE_SQL
          AR_ASSIGN_TYPE_SQL is the result value from a SQL command.
static int AR_ASSIGN_TYPE_VALUE
          AR_ASSIGN_TYPE_VALUE is a Constant or keyword value.
 
Constructor Summary
AssignInfo()
          constructor
 
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.
 boolean equals(java.lang.Object anObject, java.lang.String lhsServer, java.lang.String lhsSchema, java.lang.String rhsServer, java.lang.String rhsSchema)
           
 ArithOpAssignInfo getArithOp()
          Returns the ArithOpAssignInfo object.
 int getAssignType()
          Returns the type of assignment.
 DDEInfo getDde()
          Returns the DDEInfo object.
 AssignFieldInfo getField()
          Returns the AssignFieldInfo object.
 AssignFilterApiInfo getFilterApi()
          Returns the AssignFilterApiInfo object.
 FunctionAssignInfo getFunction()
          Returns the FunctionAssignInfo object.
 java.lang.String getProcess()
          Returns the process name.
 AssignSQLInfo getSql()
          Returns the AssignSQLInfo object.
 Value getValue()
          Returns the Value object.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setArithOp(ArithOpAssignInfo arithOp)
          Sets the ArithOpAssignInfo object.
 void setAssignType(int assignType)
          Sets the type of assignment.
 void setDde(DDEInfo dde)
          Sets the DDEInfo object.
 void setField(AssignFieldInfo field)
          Sets the AssignFieldInfo object.
 void setFilterApi(AssignFilterApiInfo filterApi)
          Sets the AssignFilterApiInfo object.
 void setFunction(FunctionAssignInfo function)
          Sets the FunctionAssignInfo object.
 void setProcess(java.lang.String process)
          Sets the process name.
 void setSql(AssignSQLInfo sql)
          Sets the AssignSQLInfo object.
 void setValue(Value value)
          Sets the Value object.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AR_ASSIGN_TYPE_NONE

public static final int AR_ASSIGN_TYPE_NONE
AR_ASSIGN_TYPE_NONE No value is assigned.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_VALUE

public static final int AR_ASSIGN_TYPE_VALUE
AR_ASSIGN_TYPE_VALUE is a Constant or keyword value. The data type of the value must match the data type of the specified field.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_FIELD

public static final int AR_ASSIGN_TYPE_FIELD
AR_ASSIGN_TYPE_FIELD is a Schema field value.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_PROCESS

public static final int AR_ASSIGN_TYPE_PROCESS
AR_ASSIGN_TYPE_PROCESS is the output value from successful execution of an operating system process or command. The system generates an error if the process return code is not zero. This option is not available for active links on Windows clients.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_ARITH

public static final int AR_ASSIGN_TYPE_ARITH
AR_ASSIGN_TYPE_ARITH is the result value from an arithmetic operation.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_FUNCTION

public static final int AR_ASSIGN_TYPE_FUNCTION
AR_ASSIGN_TYPE_FUNCTION is the return value from a function.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_DDE

public static final int AR_ASSIGN_TYPE_DDE
AR_ASSIGN_TYPE_DDE is the result value from a DDE request to another application.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_SQL

public static final int AR_ASSIGN_TYPE_SQL
AR_ASSIGN_TYPE_SQL is the result value from a SQL command.

See Also:
Constant Field Values

AR_ASSIGN_TYPE_FILTER_API

public static final int AR_ASSIGN_TYPE_FILTER_API
AR_ASSIGN_TYPE_FILTER_API is the result value from a filter API command.

See Also:
Constant Field Values
Constructor Detail

AssignInfo

public AssignInfo()
constructor

Method Detail

getValue

public Value getValue()
Returns the Value object.


setValue

public void setValue(Value value)
Sets the Value object.


getField

public AssignFieldInfo getField()
Returns the AssignFieldInfo object.


setField

public void setField(AssignFieldInfo field)
Sets the AssignFieldInfo object. You can specify a value from any entry in any schema on a particular server.


getProcess

public java.lang.String getProcess()
Returns the process name.


setProcess

public void setProcess(java.lang.String process)
Sets the process name. See Appendix B of the Developing AR System Applications:Basic guide for the syntax for running a process ($PROCESS$).


getArithOp

public ArithOpAssignInfo getArithOp()
Returns the ArithOpAssignInfo object.


setArithOp

public void setArithOp(ArithOpAssignInfo arithOp)
Sets the ArithOpAssignInfo object.


getFunction

public FunctionAssignInfo getFunction()
Returns the FunctionAssignInfo object.


setFunction

public void setFunction(FunctionAssignInfo function)
Sets the FunctionAssignInfo object.


getDde

public DDEInfo getDde()
Returns the DDEInfo object.


setDde

public void setDde(DDEInfo dde)
Sets the DDEInfo object.


getSql

public AssignSQLInfo getSql()
Returns the AssignSQLInfo object.


setSql

public void setSql(AssignSQLInfo sql)
Sets the AssignSQLInfo object.


getFilterApi

public AssignFilterApiInfo getFilterApi()
Returns the AssignFilterApiInfo object.


setFilterApi

public void setFilterApi(AssignFilterApiInfo filterApi)
Sets the AssignFilterApiInfo object.


getAssignType

public int getAssignType()
Returns the type of assignment.


setAssignType

public void setAssignType(int assignType)
Sets the type of assignment. Use this method with any of the AR_ASSIGN_TYPE_ constants, for example, AR_ASSIGN_TYPE_NONE.


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.


equals

public boolean equals(java.lang.Object anObject,
                      java.lang.String lhsServer,
                      java.lang.String lhsSchema,
                      java.lang.String rhsServer,
                      java.lang.String rhsSchema)

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.


7.0 Action Request System Java API