com.baan.b3.boi1.metadata
Interface IMethodMetadata

All Known Subinterfaces:

IBusinessObjectMethodMetadata, IManagerMethodMetadata

public interface IMethodMetadata

Describes a method of a BusinessObject or BusinessObjectManager.

Version:

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

See Also:

IBusinessObjectMetadata, IManagerMetadata

Method Summary

java.lang.String[]	getDescription() Gets a description of this method.
java.lang.String	getName() Retrieves the name of the method.
IParameterMetadata[]	getParameters() Retrieves the parameter descriptions for this method.
IParameterMetadata	getReturnType() Retrieves a description of the return value of this method.
java.lang.Object	invoke(java.lang.Object p_instance, java.lang.Object[] p_parameters) Invokes this method on the specified object.
java.lang.Object	invokeWithStrings(java.lang.Object p_instance, java.lang.Object[] p_parameters) Invokes this method on the specified object.

Method Detail

getName

public java.lang.String getName()

Retrieves the name of the method.
Threading policy: MTSafe.

Returns:

the method's name

getParameters

public IParameterMetadata[] getParameters()

Retrieves the parameter descriptions for this method.
Threading policy: MTSafe

Returns:

an array containing parameter descriptions in the order in which the parameters were declared (may have length 0)

getReturnType

public IParameterMetadata getReturnType()

Retrieves a description of the return value of this method.
The return value of a method is seen as a method parameter with IParameterMetadata.SCOPE_OUT.
Threading policy: MTSafe.

Returns:

a parameter description describing the return value or null if the method returns void

invoke

public java.lang.Object invoke(java.lang.Object p_instance,
                               java.lang.Object[] p_parameters)
                        throws java.lang.IllegalArgumentException,
                               java.lang.reflect.InvocationTargetException

Invokes this method on the specified object.
Preconditions: p_instance is in a valid state
Postconditions: Depends on the method called
Threading policy: Unsafe

Parameters:

p_instance - the object for which this method should be called

p_parameters - the values for the parameters. Primal values that map to primitive java types should be passed using the standard java object wrappers (eg. an int is passed as a java.lang.Integer object)

Returns:

the return value of the method. Primal values that map to primitive java types are returned using the standard java object wrappers (eg. an int is returned as a java.lang.Integer object)

Throws:

java.lang.IllegalArgumentException - if p_instance is null or of the wrong type, or if the number of parameters is incorrect or the parameters are of the wrong types

java.lang.reflect.InvocationTargetException - if the method called throws an exception

invokeWithStrings

public java.lang.Object invokeWithStrings(java.lang.Object p_instance,
                                          java.lang.Object[] p_parameters)
                                   throws java.lang.IllegalArgumentException,
                                          java.lang.reflect.InvocationTargetException

Invokes this method on the specified object.
Preconditions: p_instance is in a valid state
Postconditions: Depends on the method called
Threading policy: Unsafe

Parameters:

p_instance - the object for which this method should be called

p_parameters - the values for the parameters. Primal should be passed using java.lang.Strings

Returns:

the return value of the method. Primal values are returned using java.lang.Strings

Throws:

java.lang.IllegalArgumentException - if p_instance is null or of the wrong type, or if the number of parameters is incorrect or the parameters are of the wrong types

java.lang.reflect.InvocationTargetException - if the method called throws an exception

getDescription

public java.lang.String[] getDescription()

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

Returns:

a multiline string. The array can have length 0.