ilog.rules.dvs.rsi

Interface IlrBusinessObjectModelServices

All Known Subinterfaces:

IlrObjectModelServices

public interface IlrBusinessObjectModelServices

Defines the set of services provided on top of the BOM layer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLLECTIONS_FACTORY_CONTENT_INPUT_PARAMETER The name of the extra factory input parameter added for collection initialization.

Method Summary

Methods

Modifier and Type	Method and Description
IlrBOMTypeDescriptor	getFieldDeclaringClass(java.lang.String theBOMTypeFullyQualifiedName, java.lang.String theFieldName) Returns the BOM type descriptor for the class in which a field in the class is declared.
java.util.Map<java.lang.String,IlrObjectFactoryParameter>	getObjectFactorySignature(IlrBOMTypeDescriptor theBOMType) Returns the factory signature for a BOM type.
IlrBOMTypeDescriptor	getTypeOfArrayElements(java.lang.String theBOMTypeFullyQualifiedName) Returns the BOM type of the elements in an array.
boolean	isArrayType(java.lang.String theBOMTypeFullyQualifiedName) Tests if a BOM type is an array.
boolean	isCollection(java.lang.String theBOMTypeFullyQualifiedName) Tests if a BOM type is a collection.
boolean	isCollectionWithSingleFactoryParameterForContent(IlrBOMTypeDescriptor theBOMDescriptor) Tests if a BOM type is a collection holding a single array that contains the elements used to initialize this collection.

Field Detail

COLLECTIONS_FACTORY_CONTENT_INPUT_PARAMETER

static final java.lang.String COLLECTIONS_FACTORY_CONTENT_INPUT_PARAMETER

The name of the extra factory input parameter added for collection initialization.

See Also:

Constant Field Values

Method Detail

getObjectFactorySignature

java.util.Map<java.lang.String,IlrObjectFactoryParameter> getObjectFactorySignature(IlrBOMTypeDescriptor theBOMType)
                                                                                    throws IlrUnsupportedBOMTypeException

Returns the factory signature for a BOM type.

Throws:

IlrUnsupportedBOMTypeException - if this factory cannot create an instance of theBOMType.

Parameters:

theBOMType - The BOM type.

Returns:

The factory signature for this BOM type. The map key is the parameter name, and the value is the parameter definition.

isArrayType

boolean isArrayType(java.lang.String theBOMTypeFullyQualifiedName)
                    throws IlrUnsupportedBOMTypeException

Tests if a BOM type is an array.

Throws:

IlrUnsupportedBOMTypeException - if theBOMTypeFullyQualifiedName is not defined in the BOM.

Parameters:

theBOMTypeFullyQualifiedName - The fully qualified name of the BOM type.

Returns:

true if theBOMTypeFullyQualifiedName is an array.

getFieldDeclaringClass

IlrBOMTypeDescriptor getFieldDeclaringClass(java.lang.String theBOMTypeFullyQualifiedName,
                                          java.lang.String theFieldName)
                                            throws IlrUnsupportedBOMTypeException

Returns the BOM type descriptor for the class in which a field in the class is declared. This is for a parent class if the field is inherited.

Throws:

IlrUnsupportedBOMTypeException - if the class theBOMTypeFullyQualifiedName is not defined in the BOM.

Parameters:

theBOMTypeFullyQualifiedName - The fully qualified name of the class that contains the field.

theFieldName - The name of the field.

Returns:

The BOM type descriptor of the class that declares the field. If the field does not exist in theBOMTypeFullyQualifiedName, null is returned.

getTypeOfArrayElements

IlrBOMTypeDescriptor getTypeOfArrayElements(java.lang.String theBOMTypeFullyQualifiedName)
                                            throws IlrUnsupportedBOMTypeException

Returns the BOM type of the elements in an array.

Throws:

IlrUnsupportedBOMTypeException - if theBOMTypeFullyQualifiedName is not defined in the BOM.

Parameters:

theBOMTypeFullyQualifiedName - The fully qualified name of a BOM type. This object must be an array, that is, calls to theBOMTypeFullyQualifiedName.isArrayType(String) must return true.

Returns:

The BOM type of the elements in the array. If theBOMTypeFullyQualifiedName is not an array, null is returned.

isCollection

boolean isCollection(java.lang.String theBOMTypeFullyQualifiedName)
                     throws IlrUnsupportedBOMTypeException

Tests if a BOM type is a collection.

Throws:

IlrUnsupportedBOMTypeException - if theBOMTypeFullyQualifiedName is not defined in the BOM.

Parameters:

theBOMTypeFullyQualifiedName - The fully qualified name of the BOM type to test.

Returns:

true if the BOM type is a collection.

isCollectionWithSingleFactoryParameterForContent

boolean isCollectionWithSingleFactoryParameterForContent(IlrBOMTypeDescriptor theBOMDescriptor)
                                                         throws IlrUnsupportedBOMTypeException

Tests if a BOM type is a collection holding a single array that contains the elements used to initialize this collection.

Throws:

IlrUnsupportedBOMTypeException

Parameters:

theBOMDescriptor - The BOM type to test.

Returns:

true if theBOMDescriptor holds a single factory parameter containing the elements used to initialize this collection.