com.appiancorp.suiteapi.expression

Class FunctionParameter

java.lang.Object

com.appiancorp.suiteapi.expression.FunctionParameter

All Implemented Interfaces:

java.io.Serializable

public class FunctionParameter
extends java.lang.Object
implements java.io.Serializable

This class represents a parameter of a function in the Expression Editor. The attributes type and typename are mutually exclusive. Typename is used to reference types that are not base primitive types with a known id.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FunctionParameter()
FunctionParameter(FunctionParameter fp)
FunctionParameter(java.lang.reflect.Method method, int methodParameterIndex, Name name, Parameter param, int type) Create a FunctionParameter using a type id.
FunctionParameter(java.lang.reflect.Method method, int methodParameterIndex, Name name, Parameter param, java.lang.String systemTypename) Create a FunctionParameter using a name for the type of the parameter instead of a type id.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() Gets the description of parameter
java.lang.String	getName() Gets the name of parameter
java.lang.String	getSystemTypename() Gets the Typename of the parameter.
int	getType() Gets the Type of the parameter.
int	hashCode()
boolean	isRequired() Indicates whether the parameter is required as an input to the function
boolean	isUnlimited() Indicates whether this parameter may have an unlimited number of entries.
void	setDescription(java.lang.String description) Sets the description of parameter
void	setName(java.lang.String name) Sets the name of parameter
void	setRequired(boolean required) Sets whether the parameter is required as an input to the function
void	setSystemTypename(java.lang.String systemTypename) Sets the Typename of the parameter.
void	setType(int type) Sets the Type of the parameter.
void	setUnlimited(boolean isUnlimited) Sets whether this function parameter can take an unlimited number of entries.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionParameter

public FunctionParameter()

FunctionParameter

public FunctionParameter(FunctionParameter fp)

FunctionParameter

public FunctionParameter(java.lang.reflect.Method method,
                         int methodParameterIndex,
                         Name name,
                         Parameter param,
                         int type)

Create a FunctionParameter using a type id. Use this constructor when the parameter type is a built-in system type such as Integer or String.

See Also:

AppianType

FunctionParameter

public FunctionParameter(java.lang.reflect.Method method,
                         int methodParameterIndex,
                         Name name,
                         Parameter param,
                         java.lang.String systemTypename)

Create a FunctionParameter using a name for the type of the parameter instead of a type id. Use this contructor when the parameter type is not a built-in system type like Integer or Text.

See Also:

AppianType

Method Detail

getDescription

public java.lang.String getDescription()

Gets the description of parameter

Returns:

the string description of the parameter

setDescription

public void setDescription(java.lang.String description)

Sets the description of parameter

Parameters:

description - the string description of the parameter

getName

public java.lang.String getName()

Gets the name of parameter

Returns:

the name of the parameter

setName

public void setName(java.lang.String name)

Sets the name of parameter

Parameters:

name - the name of parameter

isRequired

public boolean isRequired()

Indicates whether the parameter is required as an input to the function

Returns:

true or false if the parameter is required or not.

setRequired

public void setRequired(boolean required)

Sets whether the parameter is required as an input to the function

Parameters:

required - true or false if the parameter is required or not.

getType

public int getType()

Gets the Type of the parameter. This will match one of the types in TypedVariable

Returns:

the Type of the parameter

See Also:

TypedVariable

setType

public void setType(int type)

Sets the Type of the parameter. This must match one of the types in TypedVariable

Parameters:

type - the Type of the parameter

See Also:

TypedVariable

getSystemTypename

public java.lang.String getSystemTypename()

Gets the Typename of the parameter. This value is empty is the type was provided using its ID.

Returns:

The Typename of the parameter

setSystemTypename

public void setSystemTypename(java.lang.String systemTypename)

Sets the Typename of the parameter.

isUnlimited

public boolean isUnlimited()

Indicates whether this parameter may have an unlimited number of entries.

setUnlimited

public void setUnlimited(boolean isUnlimited)

Sets whether this function parameter can take an unlimited number of entries. This value cannot be updated on the server.

See Also:

isUnlimited

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String for debugging purposes

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object