Interface RegistrationRequestSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRequestSearchOrder, OsidSearchOrder, Suppliable

public interface RegistrationRequestSearchOrder
extends OsidRequestSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
RegistrationRequestSearchOrderRecord	getRegistrationRequestSearchOrderRecord(Type registrationRequestRecordType)	Gets the registration request search order record corresponding to the given registration request record Type .
TermSearchOrder	getTermSearchOrder()	Gets the term search order.
void	orderByTerm(SearchOrderStyle style)	Orders the results by term.
boolean	supportsTermSearchOrder()	Tests if a term search order is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidRequestSearchOrder

getErrorSearchOrder, getRequesterSearchOrder, getSubmitterSearchOrder, getSubmittingAgentSearchOrder, orderByCanceledDate, orderByError, orderByPostingDate, orderByProcessedDate, orderByRequester, orderBySubmittedDate, orderBySubmitter, orderBySubmittingAgent, supportsErrorSearchOrder, supportsRequesterSearchOrder, supportsSubmitterSearchOrder, supportsSubmittingAgentSearchOrder

Modifier and Type	Method	Description
StateSearchOrder	getErrorSearchOrder()	Gets the search order for an error state.
ResourceSearchOrder	getRequesterSearchOrder()	Gets the search order for a requester resource.
ResourceSearchOrder	getSubmitterSearchOrder()	Gets the search order for a submitter resource.
AgentSearchOrder	getSubmittingAgentSearchOrder()	Gets the search order for a submitting agent.
void	orderByCanceledDate(SearchOrderStyle style)	Orders results by the canceled date.
void	orderByError(SearchOrderStyle style)	Orders results by the error state.
void	orderByPostingDate(SearchOrderStyle style)	Orders results by the posting date.
void	orderByProcessedDate(SearchOrderStyle style)	Orders results by the processed date.
void	orderByRequester(SearchOrderStyle style)	Specifies a preference for ordering the results by the requester.
void	orderBySubmittedDate(SearchOrderStyle style)	Orders results by the submitted date.
void	orderBySubmitter(SearchOrderStyle style)	Specifies a preference for ordering the results by the submitter.
void	orderBySubmittingAgent(SearchOrderStyle style)	Specifies a preference for ordering the results by the submitting agent.
boolean	supportsErrorSearchOrder()	Tests if a StateSearchOrder is available.
boolean	supportsRequesterSearchOrder()	Tests if a ResourceSearchOrder is available.
boolean	supportsSubmitterSearchOrder()	Tests if a ResourceSearchOrder is available.
boolean	supportsSubmittingAgentSearchOrder()	Tests if a ResourceSearchOrder is available.

Method Details

orderByTerm

void orderByTerm(SearchOrderStyle style)

Orders the results by term.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTermSearchOrder

boolean supportsTermSearchOrder()

Tests if a term search order is available.

Returns:

true if a term search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTermSearchOrder

TermSearchOrder getTermSearchOrder()

Gets the term search order.

Returns:

the term search order

Throws:

IllegalStateException - supportsTermSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestSearchOrderRecord

RegistrationRequestSearchOrderRecord getRegistrationRequestSearchOrderRecord(Type registrationRequestRecordType)
                                                                      throws OperationFailedException

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

Parameters:

registrationRequestRecordType - a registration request record type

Returns:

the registration request search order record

Throws:

NullArgumentException - registrationRequestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestRecordType) is false

Compliance:

mandatory - This method must be implemented.