com.baan.b3.boi1.metadata
Interface IParameterMetadata

public interface IParameterMetadata

Describes a parameter of a method.

Version:

Build Nr 61, file version \\main\\3, 15:09:06 24-07-2006 UTC

See Also:

IMethodMetadata

Field Summary

static java.lang.String	SCOPE_IN Specifies an input parameter.
static java.lang.String	SCOPE_INOUT Specifies a combined input/output parameter.
static java.lang.String	SCOPE_OUT Specifies an output parameter.

Method Summary

java.lang.String[]	getDescription() Gets a description of this parameter.
java.lang.String	getName() Retrieves the identifier attached to this parameter.
java.lang.String	getScope() Retrieves the scope of this parameter.
IObjectMetadata	getType() Retrieves the type of this parameter.

Field Detail

SCOPE_IN

public static final java.lang.String SCOPE_IN

Specifies an input parameter.

SCOPE_INOUT

public static final java.lang.String SCOPE_INOUT

Specifies a combined input/output parameter.

SCOPE_OUT

public static final java.lang.String SCOPE_OUT

Specifies an output parameter.

Method Detail

getScope

public java.lang.String getScope()

Retrieves the scope of this parameter.
This indicates whether the parameter is used for input to the method, for output of results from the method or for both.
Threading policy: MTSafe.

Returns:

SCOPE_IN, SCOPE_INOUT or SCOPE_OUT

getName

public java.lang.String getName()

Retrieves the identifier attached to this parameter.
For a method with prototype: void doIt( int p_integerParameter);
The identifier of the first parameter is p_integerParameter
Threading policy: MTSafe.

Returns:

the name of this parameter

getType

public IObjectMetadata getType()

Retrieves the type of this parameter.
Threading policy: MTSafe.

Returns:

an object describing the type of this parameter

getDescription

public java.lang.String[] getDescription()

Gets a description of this parameter.
The description can be multiple lines long.
Threading policy: MTSafe.

Returns:

a multiline string. The array can have length 0.