Interface CanonicalUnitProcessor

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidProcessor, OsidRule

public interface CanonicalUnitProcessor
extends OsidProcessor

A CanonicalUnitProcessor describes the rules for offering a canonical unit.

Method Summary

Modifier and Type	Method	Description
CanonicalUnitProcessorRecord	getCanonicalUnitProcessorRecord(Type canonicalUnitProcessorRecordType)	Gets the canonical unit processor record corresponding to the given CanonicalUnitProcessor record Type .

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface Operable

isActive, isDisabled, isEnabled, isOperational

Modifier and Type	Method	Description
boolean	isActive()	Tests if this operable is active.
boolean	isDisabled()	Tests if this operable is administravely disabled.
boolean	isEnabled()	Tests if this operable is administravely enabled.
boolean	isOperational()	Tests if this Operable is operational.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Methods inherited from interface OsidRule

getConditionRecordTypes, getRule, getRuleId, hasRule

Modifier and Type	Method	Description
TypeList	getConditionRecordTypes()	Gets the list of OsidCondition OsidRecord Types this rule requires.
Rule	getRule()	Gets the explicit rule.
Id	getRuleId()	Gets the explicit rule Id .
boolean	hasRule()	Tests if an explicit rule is available.

Method Details

getCanonicalUnitProcessorRecord

CanonicalUnitProcessorRecord getCanonicalUnitProcessorRecord(Type canonicalUnitProcessorRecordType)
                                                      throws OperationFailedException

Gets the canonical unit processor record corresponding to the given 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 .

Parameters:

canonicalUnitProcessorRecordType - the type of canonical unit processor record to retrieve

Returns:

the canonical unit processor record

Throws:

NullArgumentException - canonicalUnitProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.