org.osid.personnel

Interface OrganizationSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface OrganizationSearchOrder
extends OsidObjectSearchOrder, OsidFederateableSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
OrganizationSearchOrderRecord	getOrganizationSearchOrderRecord(Type organizationRecordType) Gets the organization search order record corresponding to the given organization record Type.
void	orderByDisplayLabel(SearchOrderStyle style) Specifies a preference for ordering the result set by the display label.

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

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByDisplayLabel

void orderByDisplayLabel(SearchOrderStyle style)

Specifies a preference for ordering the result set by the display label.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getOrganizationSearchOrderRecord

OrganizationSearchOrderRecord getOrganizationSearchOrderRecord(Type organizationRecordType)
                                                               throws OperationFailedException

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

Parameters:

organizationRecordType - an organization record type

Returns:

the organization search order record

Throws:

NullArgumentException - organizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationRecordType) is false

Compliance:

mandatory - This method must be implemented.