org.osid.configuration.rules

Interface ParameterProcessor

All Superinterfaces:

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

public interface ParameterProcessor
extends OsidProcessor

A ParameterProcessor describes the rules for processing parameters.

Method Summary

Methods

Modifier and Type	Method and Description
ParameterProcessorRecord	getParameterProcessorRecord(Type parameterProcessorRecordType) Gets the parameter processor record corresponding to the given ParameterProcessor 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

getParameterProcessorRecord

ParameterProcessorRecord getParameterProcessorRecord(Type parameterProcessorRecordType)
                                                     throws OperationFailedException

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

Parameters:

parameterProcessorRecordType - the type of parameter processor record to retrieve

Returns:

the parameter processor record

Throws:

NullArgumentException - parameterProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.