org.osid.offering.rules

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

Methods

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

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

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.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

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.