com.baan.b3.boi1.metadata
Interface IMetadataFactory

public interface IMetadataFactory

Creates instances of metadata objects.
This interface decouples the metadata interfaces from their implementation.

Version:

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

Method Summary

IBusinessObjectMetadata	createBusinessObjectMetadata(java.lang.String p_typeName, java.lang.String p_xmlDataType, IMethodMetadata[] p_methods, IMemberMetadata[] p_members, java.lang.String[] p_description) Creates an object that describes a BusinessObject.
IBusinessObjectMetadata	createBusinessObjectMetadata(java.lang.String p_typeName, java.lang.String p_xmlDataType, IMethodMetadata[] p_methods, IMemberMetadata[] p_members, java.lang.String[] p_description, boolean p_readOnly) Creates an object that describes a BusinessObject.
IIteratorMetadata	createIteratorMetadata(java.lang.String p_typeName, java.lang.String[] p_description) Creates an object that describes a Iterator.
IManagerMetadata	createManagerMetadata(java.lang.String p_typeName, IMethodMetadata[] p_methods, java.lang.String[] p_managedObjectsTypeNames, java.lang.String[] p_description) Creates an object that describes a BusinessObjectManager.
IMemberMetadata	createMemberMetadata(java.lang.String p_name, IObjectMetadata p_type, int p_cardinalityMin, int p_cardinalityMax, IMemberAccessor p_accessor, java.lang.String[] p_description) Creates an object that describes a non-primal member of a BusinessObject.
IMemberMetadata	createMemberMetadata(java.lang.String p_name, IObjectMetadata p_type, int p_cardinalityMin, int p_cardinalityMax, IMemberAccessor p_accessor, java.lang.String[] p_description, boolean p_readOnly) Creates an object that describes a non-primal member of a BusinessObject.
IMemberMetadata	createMemberMetadata(java.lang.String p_name, java.lang.String p_typeName, int p_cardinalityMin, int p_cardinalityMax, IMemberAccessor p_accessor, java.lang.String[] p_description) Creates an object that describes a non-primal member of a BusinessObject.
IMemberMetadata	createMemberMetadata(java.lang.String p_name, java.lang.String p_typeName, int p_cardinalityMin, int p_cardinalityMax, IMemberAccessor p_accessor, java.lang.String[] p_description, boolean p_readOnly) Creates an object that describes a non-primal member of a BusinessObject.
IMethodMetadata	createMethodMetadata(java.lang.String p_name, IParameterMetadata[] p_parameters, IParameterMetadata p_returnType, IMethodImplementationAdapter p_implementation, java.lang.String[] p_description) Creates an object that describes a method of a BusinessObject or BusinessObjectManager.
IParameterMetadata	createParameterMetadata(java.lang.String p_scope, java.lang.String p_name, IObjectMetadata p_type, java.lang.String[] p_description) Creates an object that describes a parameter of a method.
IParameterMetadata	createParameterMetadata(java.lang.String p_scope, java.lang.String p_name, java.lang.String p_typeName, java.lang.String[] p_description) Creates an object that describes a parameter of a method.
IPrimalMemberMetadata	createPrimalMemberMetadata(java.lang.String p_name, IPrimalObjectMetadata p_type, int p_cardinalityMin, int p_cardinalityMax, IPrimalMemberAccessor p_accessor, java.lang.String[] p_description) Creates an object that describes a primal member of a BusinessObject.
IPrimalMemberMetadata	createPrimalMemberMetadata(java.lang.String p_name, IPrimalObjectMetadata p_type, int p_cardinalityMin, int p_cardinalityMax, IPrimalMemberAccessor p_accessor, java.lang.String[] p_description, boolean p_readOnly, boolean p_attribute) Creates an object that describes a primal member of a BusinessObject.
IPrimalObjectMetadata	createPrimalObjectMetadata(java.lang.String p_typeName, java.lang.String p_xmlDataType, java.lang.String[] p_description) Creates an object that describes a primal data type.

Method Detail

createBusinessObjectMetadata

public IBusinessObjectMetadata createBusinessObjectMetadata(java.lang.String p_typeName,
                                                            java.lang.String p_xmlDataType,
                                                            IMethodMetadata[] p_methods,
                                                            IMemberMetadata[] p_members,
                                                            java.lang.String[] p_description,
                                                            boolean p_readOnly)
                                                     throws java.lang.IllegalArgumentException

Creates an object that describes a BusinessObject.
Threading policy: MTSafe

Parameters:

p_typeName - the name of the type of business object (should not be null)

p_xmlDataType - the XML data type that the business object type corresponds to (should not be null)

p_methods - an array of objects that describe the methods of the business object (may have length 0, should not be null, should have non-null elements)

p_members - an array of objects that describe the members of the business object (may have length 0, should not be null, should have non-null elements)

p_description - a multi-line description of the business object (may have length 0, should not be null, should have non-null elements)

p_readOnly - specifies if the business object is read only

Returns:

the metadata element describing the business object

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createBusinessObjectMetadata

public IBusinessObjectMetadata createBusinessObjectMetadata(java.lang.String p_typeName,
                                                            java.lang.String p_xmlDataType,
                                                            IMethodMetadata[] p_methods,
                                                            IMemberMetadata[] p_members,
                                                            java.lang.String[] p_description)
                                                     throws java.lang.IllegalArgumentException

Creates an object that describes a BusinessObject.
Threading policy: MTSafe

Parameters:

p_typeName - the name of the type of business object (should not be null)

p_xmlDataType - the XML data type that the business object type corresponds to (should not be null)

p_methods - an array of objects that describe the methods of the business object (may have length 0, should not be null, should have non-null elements)

p_members - an array of objects that describe the members of the business object (may have length 0, should not be null, should have non-null elements)

p_description - a multi-line description of the business object (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the business object

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createIteratorMetadata

public IIteratorMetadata createIteratorMetadata(java.lang.String p_typeName,
                                                java.lang.String[] p_description)
                                         throws java.lang.IllegalArgumentException

Creates an object that describes a Iterator.
Threading policy: MTSafe

Parameters:

p_typeName - the name of the type of object that the iterator is expected to return (should not be null)

p_description - a multi-line description of the iterator (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the iterator

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createManagerMetadata

public IManagerMetadata createManagerMetadata(java.lang.String p_typeName,
                                              IMethodMetadata[] p_methods,
                                              java.lang.String[] p_managedObjectsTypeNames,
                                              java.lang.String[] p_description)
                                       throws java.lang.IllegalArgumentException

Creates an object that describes a BusinessObjectManager.
Threading policy: MTSafe

Parameters:

p_typeName - the name of the type of the manager

p_methods - an array of objects that describe the methods of the manager (may have length 0, should not be null, should have non-null elements)

p_managedObjectsTypeNames - an array of names of the types of business object that are managed by the manager (may have length 0, should not be null, should have non-null elements)

p_description - a multi-line description of the manager (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the business object manager

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createMemberMetadata

public IMemberMetadata createMemberMetadata(java.lang.String p_name,
                                            java.lang.String p_typeName,
                                            int p_cardinalityMin,
                                            int p_cardinalityMax,
                                            IMemberAccessor p_accessor,
                                            java.lang.String[] p_description,
                                            boolean p_readOnly)
                                     throws java.lang.IllegalArgumentException

Creates an object that describes a non-primal member of a BusinessObject.
Threading policy: MTSafe

Parameters:

p_name - the identifier for the member (should not be null)

p_typeName - the name of the type of object that this member references. This should be a non-primal type (should not be null)

p_cardinalityMin - the minimum cardinality for this member (should be 0 or more)

p_cardinalityMax - the maximum cardinality for this member (should be IMemberMetadata.INFINITE_CARDINALITY, 1 or more}

p_accessor - a delegate that gives access to the value of this member for actual instances of the relevant business object (should not be null)

p_description - a multi-line description of the member (may have length 0, should not be null, should have non-null elements)

p_readOnly - specifies that the member is read only

Returns:

the metadata element describing the member

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createMemberMetadata

public IMemberMetadata createMemberMetadata(java.lang.String p_name,
                                            java.lang.String p_typeName,
                                            int p_cardinalityMin,
                                            int p_cardinalityMax,
                                            IMemberAccessor p_accessor,
                                            java.lang.String[] p_description)
                                     throws java.lang.IllegalArgumentException

Creates an object that describes a non-primal member of a BusinessObject.
Threading policy: MTSafe

Parameters:

p_name - the identifier for the member (should not be null)

p_typeName - the name of the type of object that this member references. This should be a non-primal type (should not be null)

p_cardinalityMin - the minimum cardinality for this member (should be 0 or more)

p_cardinalityMax - the maximum cardinality for this member (should be IMemberMetadata.INFINITE_CARDINALITY, 1 or more}

p_accessor - a delegate that gives access to the value of this member for actual instances of the relevant business object (should not be null)

p_description - a multi-line description of the member (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the member

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createMemberMetadata

public IMemberMetadata createMemberMetadata(java.lang.String p_name,
                                            IObjectMetadata p_type,
                                            int p_cardinalityMin,
                                            int p_cardinalityMax,
                                            IMemberAccessor p_accessor,
                                            java.lang.String[] p_description,
                                            boolean p_readOnly)
                                     throws java.lang.IllegalArgumentException

Creates an object that describes a non-primal member of a BusinessObject.
Threading policy: MTSafe

Parameters:

p_name - the identifier for the member (should not be null)

p_type - an object describing the type of object that this member references. Should describe a non-primal type (should not be null)

p_cardinalityMin - the minimum cardinality for this member (should be 0 or more)

p_cardinalityMax - the maximum cardinality for this member (should be IMemberMetadata.INFINITE_CARDINALITY, 1 or more}

p_accessor - a delegate that gives access to the value of this member for actual instances of the relevant business object (should not be null)

p_description - a multi-line description of the member (may have length 0, should not be null, should have non-null elements)

p_readOnly - specifies that the member is read only

Returns:

the metadata element describing the member

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createMemberMetadata

public IMemberMetadata createMemberMetadata(java.lang.String p_name,
                                            IObjectMetadata p_type,
                                            int p_cardinalityMin,
                                            int p_cardinalityMax,
                                            IMemberAccessor p_accessor,
                                            java.lang.String[] p_description)
                                     throws java.lang.IllegalArgumentException

Creates an object that describes a non-primal member of a BusinessObject.
Threading policy: MTSafe

Parameters:

p_name - the identifier for the member (should not be null)

p_type - an object describing the type of object that this member references. Should describe a non-primal type (should not be null)

p_cardinalityMin - the minimum cardinality for this member (should be 0 or more)

p_cardinalityMax - the maximum cardinality for this member (should be IMemberMetadata.INFINITE_CARDINALITY, 1 or more}

p_accessor - a delegate that gives access to the value of this member for actual instances of the relevant business object (should not be null)

p_description - a multi-line description of the member (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the member

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createMethodMetadata

public IMethodMetadata createMethodMetadata(java.lang.String p_name,
                                            IParameterMetadata[] p_parameters,
                                            IParameterMetadata p_returnType,
                                            IMethodImplementationAdapter p_implementation,
                                            java.lang.String[] p_description)
                                     throws java.lang.IllegalArgumentException

Creates an object that describes a method of a BusinessObject or BusinessObjectManager.
Threading policy: MTSafe

Parameters:

p_name - the name of the method (should not be null)

p_parameters - an ordered array of objects that describe the parameters of the method (should not be null, may have length 0, should have non-null elements). The order of the parameters should correspond to the declaration order. The names of the parameters should all be different

p_returnType - an object that describes the return type, or null if the method returns void. The scope of the return type parameter should be IParameterMetadata.SCOPE_OUT

p_implementation - a delegate that gives access to implementations of this method for actual instances of the relevant business object or business object manager (should not be null)

p_description - a multi-line description of the method (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the method

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createParameterMetadata

public IParameterMetadata createParameterMetadata(java.lang.String p_scope,
                                                  java.lang.String p_name,
                                                  java.lang.String p_typeName,
                                                  java.lang.String[] p_description)
                                           throws java.lang.IllegalArgumentException

Creates an object that describes a parameter of a method.
Threading policy: MTSafe

Parameters:

p_scope - the scope of the parameter. Must be either IParameterMetadata.SCOPE_IN, IParameterMetadata.SCOPE_INOUT or IParameterMetadata.SCOPE_OUT (must not be null)

p_name - the identifier for the parameter (must not be null)

p_typeName - the name of the type of the parameter (should not be null)

p_description - a multi-line description of the parameter (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the parameter

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createParameterMetadata

public IParameterMetadata createParameterMetadata(java.lang.String p_scope,
                                                  java.lang.String p_name,
                                                  IObjectMetadata p_type,
                                                  java.lang.String[] p_description)
                                           throws java.lang.IllegalArgumentException

Creates an object that describes a parameter of a method.
Threading policy: MTSafe

Parameters:

p_scope - the scope of the parameter. Must be either IParameterMetadata.SCOPE_IN, IParameterMetadata.SCOPE_INOUT or IParameterMetadata.SCOPE_OUT (must not be null)

p_name - the identifier for the parameter (must not be null)

p_type - an object describing the type of the parameter (should not be null)

p_description - a multi-line description of the parameter (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the parameter

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createPrimalMemberMetadata

public IPrimalMemberMetadata createPrimalMemberMetadata(java.lang.String p_name,
                                                        IPrimalObjectMetadata p_type,
                                                        int p_cardinalityMin,
                                                        int p_cardinalityMax,
                                                        IPrimalMemberAccessor p_accessor,
                                                        java.lang.String[] p_description,
                                                        boolean p_readOnly,
                                                        boolean p_attribute)
                                                 throws java.lang.IllegalArgumentException

Creates an object that describes a primal member of a BusinessObject.
Threading policy: MTSafe

Parameters:

p_name - the identifier for the member (should not be null)

p_type - an object describing the type of object that this member references. Should be a primal type (should not be null)

p_cardinalityMin - the minimum cardinality for this member (should be 0 or more)

p_cardinalityMax - the maximum cardinality for this member (should be IMemberMetadata.INFINITE_CARDINALITY, 1 or more}

p_accessor - a delegate that gives access to the value of this member for actual instances of the relevant business object (should not be null)

p_description - a multi-line description of the member (may have length 0, should not be null, should have non-null elements)

p_readOnly - specifies that the member is read only

p_attribute - specifies that the member is an Attribute

Returns:

the metadata element describing the member

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createPrimalMemberMetadata

public IPrimalMemberMetadata createPrimalMemberMetadata(java.lang.String p_name,
                                                        IPrimalObjectMetadata p_type,
                                                        int p_cardinalityMin,
                                                        int p_cardinalityMax,
                                                        IPrimalMemberAccessor p_accessor,
                                                        java.lang.String[] p_description)
                                                 throws java.lang.IllegalArgumentException

Creates an object that describes a primal member of a BusinessObject.
Threading policy: MTSafe

Parameters:

p_name - the identifier for the member (should not be null)

p_type - an object describing the type of object that this member references. Should be a primal type (should not be null)

p_cardinalityMin - the minimum cardinality for this member (should be 0 or more)

p_cardinalityMax - the maximum cardinality for this member (should be IMemberMetadata.INFINITE_CARDINALITY, 1 or more}

p_accessor - a delegate that gives access to the value of this member for actual instances of the relevant business object (should not be null)

p_description - a multi-line description of the member (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the member

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value

createPrimalObjectMetadata

public IPrimalObjectMetadata createPrimalObjectMetadata(java.lang.String p_typeName,
                                                        java.lang.String p_xmlDataType,
                                                        java.lang.String[] p_description)
                                                 throws java.lang.IllegalArgumentException

Creates an object that describes a primal data type.
Threading policy: MTSafe

Parameters:

p_typeName - the name of the type of data type (should not be null)

p_xmlDataType - the XML data type that this primal data type corresponds to (should not be null)

p_description - a multi-line description of the data type (may have length 0, should not be null, should have non-null elements)

Returns:

the metadata element describing the data type

Throws:

java.lang.IllegalArgumentException - if one of the parameters has an illegal value