com.ca.commons.datamodel.annotations
Annotation Type MetaDataUsage

@Documented
@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface MetaDataUsage

Specifies usage information for a metadata properties.

Required Element Summary

String	description Fairly brief description of this metadata property's function.
MetaDataTarget[]	target Which entities represented in the datamodel can be decorated with this metadata property?

Optional Element Summary

AssociationType[]	associationRestriction Is this metadata property related to association processing, and if so which flavours?
DataModelType[]	dataType Type of this metadata property.
String	defaultValue Value assumed when metadata property is not defined for a target object.
String	documentation Extra documentation covering this metadata property's function, may include HTML markup.
String	enumName Allowed values for metadata property with dataType="ENUM", specifies name of enum class containing values which is expanded into a list of values by MetaDataDefsToXMLApf.
SoftwareModule[]	interestedModules Software module(s) which make use of this metadata property.
String[]	seeAlsoMetaData Names of other named related metadata properties.
MetaDataDefStatus	status
String[]	targetAttributeType Restriction on datamodel type of the target (where its an attribute) being decorated.
String[]	targetIncompatibleMetaData Use of this metadata property is incompatible with the presence of these other named metadata properties on the target.
MetaDataTarget[]	targetParent Restriction on parent of target attribute.
String[]	targetPrequesiteMetaData Use of this metadata property is dependent on the presence of these other named metadata properties on the target.

Element Detail

description

public abstract String description

Fairly brief description of this metadata property's function.

target

public abstract MetaDataTarget[] target

Which entities represented in the datamodel can be decorated with this metadata property?

dataType

public abstract DataModelType[] dataType

Type of this metadata property. Note that unlike in JCS server_jcs.xml qualifiers are not allowed for "FLEXI_STR:DN", "SEQ[ENUM]" etc as base type is enforced to be STR and FLEXI_STR / ENUM types don't make sense at the meta-level where there is no datamodel to refer to.

Default:

{}

documentation

public abstract String documentation

Extra documentation covering this metadata property's function, may include HTML markup.

Default:

""

defaultValue

public abstract String defaultValue

Value assumed when metadata property is not defined for a target object.

Default:

"null"

enumName

public abstract String enumName

Allowed values for metadata property with dataType="ENUM", specifies name of enum class containing values which is expanded into a list of values by MetaDataDefsToXMLApf.

Default:

""

interestedModules

public abstract SoftwareModule[] interestedModules

Software module(s) which make use of this metadata property.

Default:

{}

status

public abstract MetaDataDefStatus status

Default:

com.ca.commons.datamodel.cfg.MetaDataDefStatus.NORMAL

targetAttributeType

public abstract String[] targetAttributeType

Restriction on datamodel type of the target (where its an attribute) being decorated.

Default:

{}

targetParent

public abstract MetaDataTarget[] targetParent

Restriction on parent of target attribute.

Default:

{}

targetPrequesiteMetaData

public abstract String[] targetPrequesiteMetaData

Use of this metadata property is dependent on the presence of these other named metadata properties on the target.

Default:

{}

targetIncompatibleMetaData

public abstract String[] targetIncompatibleMetaData

Use of this metadata property is incompatible with the presence of these other named metadata properties on the target.

Default:

{}

seeAlsoMetaData

public abstract String[] seeAlsoMetaData

Names of other named related metadata properties.

Default:

{}

associationRestriction

public abstract AssociationType[] associationRestriction

Is this metadata property related to association processing, and if so which flavours?

Default:

{}