org.kuali.rice.krad.data.metadata
Interface DataObjectCollection

All Superinterfaces:

MetadataChild, MetadataCommon, Serializable

All Known Implementing Classes:

DataObjectCollectionImpl

public interface DataObjectCollection
extends MetadataChild

Collection metadata

Represents the metadata for a collection within a data object.

Author:

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

Method Summary

List<DataObjectCollectionSortAttribute>	getDefaultOrdering() Gets the default ordering of a collection.
String	getElementLabel() Gets name of single object in collection
Long	getMaxItems() The maximum number of items which may be in the collection.
Long	getMinItems() Gets the minimum number of items which may be in the collection.
boolean	isIndirectCollection() Determines whether a linked objected is used.

Methods inherited from interface org.kuali.rice.krad.data.metadata.MetadataChild

getAttributeRelationships, getInverseRelationship, getParentAttributeNameRelatedToChildAttributeName, getRelatedType, isDeletedWithParent, isLoadedAtParentLoadTime, isLoadedDynamicallyUponUse, isSavedWithParent

Methods inherited from interface org.kuali.rice.krad.data.metadata.MetadataCommon

getBackingObjectName, getDescription, getLabel, getMergeAction, getName, getShortLabel, isReadOnly

Method Detail

getElementLabel

String getElementLabel()

Gets name of single object in collection

The elementLabel defines the name to be used for a single object within the collection. For example: "Address" may be the name of one object within the "Addresses" collection.

return name of single object in collection

getMinItems

Long getMinItems()

Gets the minimum number of items which may be in the collection.

This is an optional attribute and may not be set by the metadata provider.

Returns:

The minimum number of items which must be in this collection or null if unset.

getMaxItems

Long getMaxItems()

The maximum number of items which may be in the collection.

This is an optional attribute and may not be set by the metadata provider.

Returns:

The maximum number of items which may be in this collection or null if unset.

getDefaultOrdering

List<DataObjectCollectionSortAttribute> getDefaultOrdering()

Gets the default ordering of a collection.

The default ordering of collection items as specified by the metadata provider.

Returns:

The list of fields in order by which to sort, or an empty list if none specified.

isIndirectCollection

boolean isIndirectCollection()

Determines whether a linked objected is used.

Whether the referenced collection uses a linking object in the underlying implementation. (In case that is somehow important to using code.).

Returns:

whether a linked object is used