org.kuali.rice.krad.data.metadata

Interface MetadataCommon

All Superinterfaces:

Serializable

All Known Subinterfaces:

DataObjectAttribute, DataObjectAttributeInternal, DataObjectCollection, DataObjectMetadata, DataObjectMetadataInternal, DataObjectRelationship, MetadataChild, MetadataCommonInternal

All Known Implementing Classes:

DataObjectAttributeImpl, DataObjectCollectionImpl, DataObjectMetadataImpl, DataObjectRelationshipImpl, MetadataChildBase, MetadataCommonBase

public interface MetadataCommon
extends Serializable

An interface for attributes common to all primary metadata objects. (name, backing object, labels, etc...)

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
String	getBackingObjectName() Provider specific name of the persistent storage behind this object type.
String	getDescription() A longer description of the object.
String	getLabel() The user displayed name of the object.
MetadataMergeAction	getMergeAction() MetadataMergeAction which determines how to handle the embedding of this object when multiple metadata providers are in use.
String	getName() The name of the object as known to the system.
String	getShortLabel() A shorter version of the user displayed name of the object.
boolean	isReadOnly() Whether this metadata object should be considered read-only by calling code.

Method Detail

getMergeAction

MetadataMergeAction getMergeAction()

MetadataMergeAction which determines how to handle the embedding of this object when multiple metadata providers are in use.

Returns:

the merge action to use when embedding this metadata when multiple metadata providers are in use

See Also:

MetadataMergeAction

getBackingObjectName

String getBackingObjectName()

Provider specific name of the persistent storage behind this object type. For a data object, this would likely be the table name. For an attribute, this would be the table column name. It is to be used for reference purposes only. The default implementation will return the name property if none is provided by the metadata providers.

Returns:

String representing the backing object. Must not return null.

getName

String getName()

The name of the object as known to the system. This would be the class name, attribute name, etc...

Returns:

name

getLabel

String getLabel()

The user displayed name of the object.

Returns:

user diplayed name

getShortLabel

String getShortLabel()

A shorter version of the user displayed name of the object.

Returns:

short name

getDescription

String getDescription()

A longer description of the object. This can be used to provide a more complete description of the data object and its purpose. This information can be used when displaying help information to the end-user.

Returns:

description

isReadOnly

boolean isReadOnly()

Whether this metadata object should be considered read-only by calling code.

That is, the persistence layer is not likely to accept/persist an update to this object, attribute, collection, reference.

Returns:

whether metadata read-only