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.
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. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isSequestered
isActive, isDisabled, isEnabled, isOperational
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
IdList getChildrenIds()
Ids
of this composition. Ids
mandatory
- This method must be implemented. CompositionList getChildren() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CompositionRecord getCompositionRecord(Type compositionRecordType) throws OperationFailedException
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
.compositionRecordType
- a composition record typeNullArgumentException
- compositionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(compositionRecordType)
is false
mandatory
- This method must be implemented.