5.1 Action Request System Java API

com.remedy.arsys.api
Class FunctionAssignInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.FunctionAssignInfo
All Implemented Interfaces:
java.lang.Cloneable

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

The FunctionAssignInfo class specifies a function return value to assign in a Set Fields action.


Constructor Summary
FunctionAssignInfo()
          constructor
FunctionAssignInfo(long functionCode, AssignInfo[] parameterList)
           
 
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)
           
 long getFunctionCode()
          Returns type of function performed.
 long getNumItems()
          Returns number of input parameters.
 AssignInfo[] getParameterList()
          Returns parameter values used.
 int hashCode()
          This method can be used to populate a hash table.
 void setFunctionCode(long functionCode)
          Sets type of function to perform.
 void setNumItems(long numItems)
          Sets number of input parameters.
 void setParameterList(AssignInfo[] parameterList)
          Sets parameter values to use.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunctionAssignInfo

public FunctionAssignInfo()
constructor

FunctionAssignInfo

public FunctionAssignInfo(long functionCode,
                          AssignInfo[] parameterList)
Method Detail

getFunctionCode

public long getFunctionCode()
Returns type of function performed.

setFunctionCode

public void setFunctionCode(long functionCode)
Sets type of function to perform. Possible constants values include the following:
Parameters:
AR_FUNCTION_DATE - AR_FUNCTION_DATE
AR_FUNCTION_TIME - AR_FUNCTION_TIME
AR_FUNCTION_MONTH - AR_FUNCTION_MONTH
AR_FUNCTION_DAY - AR_FUNCTION_DAY
AR_FUNCTION_YEAR - AR_FUNCTION_YEAR
AR_FUNCTION_WEEKDAY - AR_FUNCTION_WEEKDAY
AR_FUNCTION_HOUR - AR_FUNCTION_HOUR
AR_FUNCTION_MINUTE - AR_FUNCTION_MINUTE
AR_FUNCTION_SECOND - AR_FUNCTION_SECOND
AR_FUNCTION_TRUNC - AR_FUNCTION_TRUNC
AR_FUNCTION_ROUND - AR_FUNCTION_ROUND
AR_FUNCTION_LENGTH - AR_FUNCTION_LENGTH
AR_FUNCTION_UPPER - AR_FUNCTION_UPPER
AR_FUNCTION_LOWER - AR_FUNCTION_LOWER
AR_FUNCTION_SUBSTR - AR_FUNCTION_SUBSTR
AR_FUNCTION_LEFT - AR_FUNCTION_LEFT
AR_FUNCTION_RIGHT - AR_FUNCTION_RIGHT
AR_FUNCTION_LTRIM - AR_FUNCTION_LTRIM
AR_FUNCTION_RTRIM - AR_FUNCTION_RTRIM
AR_FUNCTION_LPAD - AR_FUNCTION_LPAD
AR_FUNCTION_RPAD - AR_FUNCTION_RPAD
AR_FUNCTION_REPLACE - AR_FUNCTION_REPLACE
AR_FUNCTION_STRSTR - AR_FUNCTION_STRSTR
AR_FUNCTION_MIN - AR_FUNCTION_MIN
AR_FUNCTION_MAX - AR_FUNCTION_MAX
AR_FUNCTION_COLSUM - AR_FUNCTION_COLSUM
AR_FUNCTION_COLCOUNT - AR_FUNCTION_COLCOUNT
AR_FUNCTION_COLAVG - AR_FUNCTION_COLAVG
AR_FUNCTION_COLMIN - AR_FUNCTION_COLMIN
AR_FUNCTION_COLMAX - AR_FUNCTION_COLMAX
AR_MAX_FUNCTION_USED - AR_MAX_FUNCTION_USED

getNumItems

public long getNumItems()
Returns number of input parameters.

setNumItems

public void setNumItems(long numItems)
Sets number of input parameters.

getParameterList

public AssignInfo[] getParameterList()
Returns parameter values used.

setParameterList

public void setParameterList(AssignInfo[] parameterList)
Sets parameter values to use.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.
Overrides:
clone in class java.lang.Object

equals

public boolean equals(java.lang.Object anObject)
Use this method for checking equality. The result is true if and only if the argument is not null, is of same type and represents the same content.
Overrides:
equals in class java.lang.Object

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()
This method can be used to populate a hash table. Implicitly used method to test equality of objects.
Overrides:
hashCode in class java.lang.Object

5.1 Action Request System Java API