railo.runtime.type
Interface FunctionArgument

All Superinterfaces:

java.io.Serializable

public interface FunctionArgument

extends java.io.Serializable

a function argument definition

Field Summary

static int	DEFAULT_TYPE_LITERAL
static int	DEFAULT_TYPE_NULL
static int	DEFAULT_TYPE_RUNTIME_EXPRESSION

Method Summary

int	getDefaultType()
java.lang.String	getDisplayName()
java.lang.String	getDspName() Deprecated. replaced with getDisplayName();
java.lang.String	getHint()
Struct	getMetaData()
Collection.Key	getName()
short	getType()
java.lang.String	getTypeAsString()
boolean	isPassByReference()
boolean	isRequired()

Field Detail

DEFAULT_TYPE_NULL

public static final int DEFAULT_TYPE_NULL

See Also:

Constant Field Values

DEFAULT_TYPE_LITERAL

public static final int DEFAULT_TYPE_LITERAL

See Also:

Constant Field Values

DEFAULT_TYPE_RUNTIME_EXPRESSION

public static final int DEFAULT_TYPE_RUNTIME_EXPRESSION

See Also:

Constant Field Values

Method Detail

getName

public Collection.Key getName()

Returns:

Returns the name of the argument.

isRequired

public boolean isRequired()

Returns:

Returns if argument is required or not.

getType

public short getType()

Returns:

Returns the type of the argument.

getTypeAsString

public java.lang.String getTypeAsString()

Returns:

Returns the type of the argument.

getHint

public java.lang.String getHint()

Returns:

Returns the Hint of the argument.

getDspName

public java.lang.String getDspName()

Deprecated. replaced with getDisplayName();

Returns:

Returns the display name (Label) of the argument.

getDisplayName

public java.lang.String getDisplayName()

Returns:

Returns the Display name of the argument.

getDefaultType

public int getDefaultType()

Returns:

the default type of the argument

getMetaData

public Struct getMetaData()

Returns:

the meta data defined

isPassByReference

public boolean isPassByReference()