org.osid.repository

Interface Composition

All Superinterfaces:

Browsable, Containable, Extensible, Identifiable, Operable, OsidObject, Sourceable

public interface Composition
extends OsidObject, Containable, Operable, Sourceable

A Composition represents an authenticatable identity. Like all OSID objects, a Composition is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
CompositionList	getChildren() Gets the children of this composition.
IdList	getChildrenIds() Gets the child Ids of this composition.
CompositionRecord	getCompositionRecord(Type compositionRecordType) Gets the composition record corresponding to the given Composition record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Containable

isSequestered

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getChildrenIds

IdList getChildrenIds()

Gets the child Ids of this composition.

Returns:

the composition child Ids

Compliance:

mandatory - This method must be implemented.

getChildren

CompositionList getChildren()
                            throws OperationFailedException

Gets the children of this composition.

Returns:

the composition children

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCompositionRecord

CompositionRecord getCompositionRecord(Type compositionRecordType)
                                       throws OperationFailedException

Gets the composition record corresponding to the given Composition record Type. This method is used to retrieve an object implementing the requested record. The compositionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(compositionRecordType) is true .

Parameters:

compositionRecordType - a composition record type

Returns:

the composition record

Throws:

NullArgumentException - compositionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionRecordType) is false

Compliance:

mandatory - This method must be implemented.