public class AssignInfo extends Object implements Cloneable, Serializable
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.Modifier and Type | Field and Description |
---|---|
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 Form 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 and Description |
---|
AssignInfo()
constructor
|
AssignInfo(DDEAction ddeInfo) |
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) |
ArithOpAssignInfo |
getArithOp()
Returns the
ArithOpAssignInfo object. |
String |
getAssignmentAsString() |
int |
getAssignType()
Returns the type of assignment.
|
DDEAction |
getDde()
Returns the
DDEAction object. |
AssignFieldInfo |
getField()
Returns the
AssignFieldInfo object. |
AssignFilterApiInfo |
getFilterApi()
Returns the
AssignFilterApiInfo object. |
FunctionAssignInfo |
getFunction()
Returns the
FunctionAssignInfo object. |
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 |
setAssignmentAsString(String assignmentAsString) |
void |
setAssignType(int assignType)
Sets the type of assignment.
|
void |
setDde(DDEAction dde)
Sets the
DDEAction 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(String process)
Sets the process name.
|
void |
setSql(AssignSQLInfo sql)
Sets the
AssignSQLInfo object. |
void |
setValue(Value value)
Sets the
Value object. |
String |
toString()
Returns a string description of the object.
|
public static final int AR_ASSIGN_TYPE_NONE
AR_ASSIGN_TYPE_NONE
No value is assigned.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.public static final int AR_ASSIGN_TYPE_FIELD
AR_ASSIGN_TYPE_FIELD
is a Form field value.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.public static final int AR_ASSIGN_TYPE_ARITH
AR_ASSIGN_TYPE_ARITH
is the result value from an arithmetic operation.public static final int AR_ASSIGN_TYPE_FUNCTION
AR_ASSIGN_TYPE_FUNCTION
is the return value from a function.public static final int AR_ASSIGN_TYPE_DDE
AR_ASSIGN_TYPE_DDE
is the result value from a DDE request to another
application.public static final int AR_ASSIGN_TYPE_SQL
AR_ASSIGN_TYPE_SQL
is the result value from a SQL command.public static final int AR_ASSIGN_TYPE_FILTER_API
AR_ASSIGN_TYPE_FILTER_API
is the result value from a filter API
command.public AssignInfo()
public AssignInfo(DDEAction ddeInfo)
public AssignFieldInfo getField()
AssignFieldInfo
object.public void setField(AssignFieldInfo field)
AssignFieldInfo
object. You can specify a value from any entry in any form on a particular
server.public String getProcess()
public void setProcess(String process)
public ArithOpAssignInfo getArithOp()
ArithOpAssignInfo
object.public void setArithOp(ArithOpAssignInfo arithOp)
ArithOpAssignInfo
object.public FunctionAssignInfo getFunction()
FunctionAssignInfo
object.public void setFunction(FunctionAssignInfo function)
FunctionAssignInfo
object.public AssignSQLInfo getSql()
AssignSQLInfo
object.public void setSql(AssignSQLInfo sql)
AssignSQLInfo
object.public AssignFilterApiInfo getFilterApi()
AssignFilterApiInfo
object.public void setFilterApi(AssignFilterApiInfo filterApi)
AssignFilterApiInfo
object.public int getAssignType()
public void setAssignType(int assignType)
AR_ASSIGN_TYPE_
constants, for
example, AR_ASSIGN_TYPE_NONE
.public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public boolean equals(Object obj)
public boolean equals(Object anObject, String lhsServer, String lhsForm, String rhsServer, String rhsForm)
public int hashCode()
public String toString()
public String getAssignmentAsString()
public void setAssignmentAsString(String assignmentAsString)
assignmentAsString
- the assignmentAsString to set? Copyright 2013 BMC Software, Inc.