org.osid.resource.demographic

Interface DemographicSearchOrder

All Superinterfaces:

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

public interface DemographicSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
DemographicSearchOrderRecord	getDemographicSearchOrderRecord(Type demographicRecordType) Gets the demographic search order record corresponding to the given demographic 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

getDemographicSearchOrderRecord

DemographicSearchOrderRecord getDemographicSearchOrderRecord(Type demographicRecordType)
                                                             throws OperationFailedException

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

Parameters:

demographicRecordType - a demographic record type

Returns:

the demographic search order record

Throws:

NullArgumentException - demographicRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicRecordType) is false

Compliance:

mandatory - This method must be implemented.