com.ibm.j2ca.base
Interface MetadataProperties


public interface MetadataProperties

This interface simply encapsulates the standard property names used for BO, verb, and propery-level metadata.


Field Summary
static java.lang.String MDOL_OBJECT_NAME
          Name of the corresponding entity in the EIS to which this business object definition maps.
static java.lang.String MDOL_OP_METHOD_NAME
          Name of the EIS method that should be used to perform this operation
static java.lang.String MDOL_OP_NAME
          Name of the supported operation
static java.lang.String MDOL_OP_RESPONSE_TYPE
          Name of the ComplexType that represents the business object that should be returned by this operation.
static java.lang.String MDOL_SUPPORTED_OPERATION
          Element under which metadata for operations is listed.
static java.lang.String MDPL_FIELD_NAME
          Corresponding name of the field in the EIS to which this BO property definition maps.
static java.lang.String MDPL_FIELD_TYPE
          The type of this field as it is represented in the EIS.
static java.lang.String MDPL_FOREIGN_BO_KEY
          Pointer to another BO property to which this property value should refer.
static java.lang.String MDPL_KEY_FLAG
          Boolean flag indicating whether this property is part of the primary key for the entity.
static java.lang.String MDPL_SIDE_EFFECTS
          Boolean flag indicating whether this property should be checked for side-effects.
 

Field Detail

MDPL_KEY_FLAG

public static final java.lang.String MDPL_KEY_FLAG
Boolean flag indicating whether this property is part of the primary key for the entity.

See Also:
Constant Field Values

MDPL_FOREIGN_BO_KEY

public static final java.lang.String MDPL_FOREIGN_BO_KEY
Pointer to another BO property to which this property value should refer. Note: Foreign-key properties are not inherently required properties. They need to be explicitly marked required in the BO definition if required by EIS.

See Also:
Constant Field Values

MDPL_FIELD_NAME

public static final java.lang.String MDPL_FIELD_NAME
Corresponding name of the field in the EIS to which this BO property definition maps.

See Also:
Constant Field Values

MDPL_FIELD_TYPE

public static final java.lang.String MDPL_FIELD_TYPE
The type of this field as it is represented in the EIS. Used when the EIS type does not match one of the types supported by the BO definition schema

See Also:
Constant Field Values

MDPL_SIDE_EFFECTS

public static final java.lang.String MDPL_SIDE_EFFECTS
Boolean flag indicating whether this property should be checked for side-effects.

See Also:
Constant Field Values

MDOL_OBJECT_NAME

public static final java.lang.String MDOL_OBJECT_NAME
Name of the corresponding entity in the EIS to which this business object definition maps.

See Also:
Constant Field Values

MDOL_SUPPORTED_OPERATION

public static final java.lang.String MDOL_SUPPORTED_OPERATION
Element under which metadata for operations is listed.

See Also:
Constant Field Values

MDOL_OP_NAME

public static final java.lang.String MDOL_OP_NAME
Name of the supported operation

See Also:
Constant Field Values

MDOL_OP_METHOD_NAME

public static final java.lang.String MDOL_OP_METHOD_NAME
Name of the EIS method that should be used to perform this operation

See Also:
Constant Field Values

MDOL_OP_RESPONSE_TYPE

public static final java.lang.String MDOL_OP_RESPONSE_TYPE
Name of the ComplexType that represents the business object that should be returned by this operation. Used for operations such as RetrieveAll that require the creation of a wrapper object to return a batch of objects.

See Also:
Constant Field Values