Interface AvailabilitySearchOrder

All Superinterfaces:

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

public interface AvailabilitySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
AvailabilitySearchOrderRecord	getAvailabilitySearchOrderRecord(Type availabilityRecordType)	Gets the availability search order record corresponding to the given availability record Type .
CompetencySearchOrder	getCompetencySearchOrder()	Gets the competency search order.
JobSearchOrder	getJobSearchOrder()	Gets the job search order.
ResourceSearchOrder	getResourceSearchOrder()	Gets the resource search order.
void	orderByCompetency(SearchOrderStyle style)	Orders the results by competency.
void	orderByJob(SearchOrderStyle style)	Orders the results by job.
void	orderByPercentage(SearchOrderStyle style)	Orders the results by percentage availability.
void	orderByResource(SearchOrderStyle style)	Orders the results by resource.
boolean	supportsCompetencySearchOrder()	Tests if a competency search order is available.
boolean	supportsJobSearchOrder()	Tests if a job search order is available.
boolean	supportsResourceSearchOrder()	Tests if a resource 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 OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Modifier and Type	Method	Description
StateSearchOrder	getEndReasonSearchOrder()	Gets the search order for a state.
void	orderByEndReason(SearchOrderStyle style)	Specifies a preference for ordering the results by the end reason state.
boolean	supportsEndReasonSearchOrder()	Tests if a StateSearchOrder is available.

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

orderByResource

void orderByResource(SearchOrderStyle style)

Orders the results by resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a resource search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsResourceSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByJob

void orderByJob(SearchOrderStyle style)

Orders the results by job.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsJobSearchOrder

boolean supportsJobSearchOrder()

Tests if a job search order is available.

Returns:

true if a job search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getJobSearchOrder

JobSearchOrder getJobSearchOrder()

Gets the job search order.

Returns:

the job search order

Throws:

IllegalStateException - supportsJobSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByCompetency

void orderByCompetency(SearchOrderStyle style)

Orders the results by competency.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCompetencySearchOrder

boolean supportsCompetencySearchOrder()

Tests if a competency search order is available.

Returns:

true if a competency search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCompetencySearchOrder

CompetencySearchOrder getCompetencySearchOrder()

Gets the competency search order.

Returns:

the competency search order

Throws:

IllegalStateException - supportsCompetencySearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByPercentage

void orderByPercentage(SearchOrderStyle style)

Orders the results by percentage availability.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getAvailabilitySearchOrderRecord

AvailabilitySearchOrderRecord getAvailabilitySearchOrderRecord(Type availabilityRecordType)
                                                        throws OperationFailedException

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

Parameters:

availabilityRecordType - an availability record type

Returns:

the availability order record

Throws:

NullArgumentException - availabilityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(availabilityRecordType) is false

Compliance:

mandatory - This method must be implemented.