org.osid.configuration.rules

Interface ParameterProcessorSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidProcessorSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface ParameterProcessorSearchOrder
extends OsidProcessorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ParameterProcessorSearchOrderRecord	getParameterProcessorSearchOrderRecord(Type parameterProcessorRecordType) Gets the parameter processor search order record corresponding to the given parameter processor record Type.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

getParameterProcessorSearchOrderRecord

ParameterProcessorSearchOrderRecord getParameterProcessorSearchOrderRecord(Type parameterProcessorRecordType)
                                                                           throws OperationFailedException

Gets the parameter processor search order record corresponding to the given parameter processor record Type. Multiple retrievals return the same underlying object.

Parameters:

parameterProcessorRecordType - a parameter processor record type

Returns:

the parameter processor search order record

Throws:

NullArgumentException - parameterProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.