com.bmc.arsys.api
Class FunctionAssignInfo

java.lang.Object
  com.bmc.arsys.api.FunctionAssignInfo

All Implemented Interfaces:

Serializable, Cloneable

public class FunctionAssignInfo
extends Object
implements Cloneable, Serializable

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

See Also:

Serialized Form

Constructor Summary

FunctionAssignInfo()
constructor

FunctionAssignInfo(int functionCode, List<AssignInfo> parameterList)

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.
int	getFunctionCode() Returns type of function performed.
int	getNumItems() Returns number of input parameters.
List<AssignInfo>	getParameterList() Returns parameter values used.
static int	getParamType(int funcCode, int paramIndx) Returns function parameter data type given the function code and argument index
static int	getParamType(String function, int paramIndx) Returns function parameter data type given the function name and argument index
int	hashCode() Returns the hash code value for this instance of the current class.
void	setFunctionCode(int functionCode) Sets type of function to perform.
void	setNumItems(int numItems) Sets number of input parameters.
void	setParameterList(List<AssignInfo> parameterList) Sets parameter values to use.
static int	toFuncCode(String function) Returns the function code given the function name
static String	toFuncName(int code) Returns the function name given the function code
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionAssignInfo

public FunctionAssignInfo()

constructor

FunctionAssignInfo

public FunctionAssignInfo(int functionCode,
                          List<AssignInfo> parameterList)

Method Detail

getFunctionCode

public int getFunctionCode()

Returns type of function performed.

setFunctionCode

public void setFunctionCode(int functionCode)

Sets type of function to perform.

Parameters:

functionCode - Possible constants values include the following:

• AR_FUNCTION_DATE
• AR_FUNCTION_TIME
• AR_FUNCTION_MONTH
• AR_FUNCTION_DAY
• AR_FUNCTION_YEAR
• AR_FUNCTION_WEEKDAY
• AR_FUNCTION_HOUR
• AR_FUNCTION_MINUTE
• AR_FUNCTION_SECOND
• AR_FUNCTION_TRUNC
• AR_FUNCTION_ROUND
• AR_FUNCTION_CONVERT
• AR_FUNCTION_LENGTH
• AR_FUNCTION_UPPER
• AR_FUNCTION_LOWER
• AR_FUNCTION_SUBSTR
• AR_FUNCTION_LEFT
• AR_FUNCTION_RIGHT
• AR_FUNCTION_LTRIM
• AR_FUNCTION_RTRIM
• AR_FUNCTION_LPAD
• AR_FUNCTION_RPAD
• AR_FUNCTION_REPLACE
• AR_FUNCTION_STRSTR
• AR_FUNCTION_MIN
• AR_FUNCTION_MAX
• AR_FUNCTION_COLSUM
• AR_FUNCTION_COLCOUNT
• AR_FUNCTION_COLAVG
• AR_FUNCTION_COLMIN
• AR_FUNCTION_COLMAX
• AR_FUNCTION_DATEADD
• AR_FUNCTION_DATEDIFF
• AR_FUNCTION_DATENAME
• AR_FUNCTION_DATENUM
• AR_FUNCTION_CURRCONVERT
• AR_FUNCTION_CURRSETDATE
• AR_FUNCTION_CURRSETTYPE
• AR_FUNCTION_CURRSETVALUE
• AR_FUNCTION_LENGTHC
• AR_FUNCTION_LEFTC
• AR_FUNCTION_RIGHTC
• AR_FUNCTION_LPADC
• AR_FUNCTION_RPADC
• AR_FUNCTION_STRSTRC
• AR_FUNCTION_SUBSTRC
• AR_FUNCTION_ENCRYPT
• AR_FUNCTION_DECRYPT
• AR_MAX_FUNCTION_USED

getNumItems

public int getNumItems()

Returns number of input parameters.

setNumItems

public void setNumItems(int numItems)

Sets number of input parameters.

getParameterList

public List<AssignInfo> getParameterList()

Returns parameter values used.

setParameterList

public void setParameterList(List<AssignInfo> parameterList)

Sets parameter values to use.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

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.

Overrides:

equals in class Object

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 Object

toString

public String toString()

Overrides:

toString in class Object

toFuncCode

public static int toFuncCode(String function)

Returns the function code given the function name

Parameters:

function -

Returns:

int

toFuncName

public static String toFuncName(int code)
                         throws ARException

Returns the function name given the function code

Parameters:

int -

Returns:

String

Throws:

ARException

getParamType

public static int getParamType(int funcCode,
                               int paramIndx)

Returns function parameter data type given the function code and argument index

Parameters:

funcCode -

paramIndx -

Returns:

int

getParamType

public static int getParamType(String function,
                               int paramIndx)

Returns function parameter data type given the function name and argument index

Parameters:

function -

paramIndx -

Returns:

int argument type