public interface CanonicalUnitProcessor extends OsidProcessor
A CanonicalUnitProcessor
describes the rules for
offering a canonical unit.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitProcessorRecord |
getCanonicalUnitProcessorRecord(Type canonicalUnitProcessorRecordType)
Gets the canonical unit processor record corresponding to the given
CanonicalUnitProcessor record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
CanonicalUnitProcessorRecord getCanonicalUnitProcessorRecord(Type canonicalUnitProcessorRecordType) throws OperationFailedException
CanonicalUnitProcessor
record Type.
This
method is used to retrieve an object implementing the requested
record. The canonicalUnitRecordType
may be the
Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(canonicalUnitRecordType)
is true
.canonicalUnitProcessorRecordType
- the type of canonical unit
processor record to retrieveNullArgumentException
-
canonicalUnitProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitProcessorRecordType)
is
false
mandatory
- This method must be implemented.