org.osid.subscription

Interface PublisherSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface PublisherSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
PublisherSearchOrderRecord	getPublisherSearchOrderRecord(Type publisherRecordType) Gets the publisher search order record corresponding to the given publisher record Type.

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

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getPublisherSearchOrderRecord

PublisherSearchOrderRecord getPublisherSearchOrderRecord(Type publisherRecordType)
                                                         throws OperationFailedException

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

Parameters:

publisherRecordType - a publisher record type

Returns:

the publisher search order record

Throws:

NullArgumentException - publisherRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(publisherRecordType) is false

Compliance:

mandatory - This method must be implemented.