public interface AvailabilitySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and 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.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByResource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsResourceSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
IllegalStateException
-
supportsResourceSearchOrder()
is false
mandatory
- This method must be implemented. void orderByJob(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsJobSearchOrder()
true
if a job search order is available,
false
otherwisemandatory
- This method must be implemented. JobSearchOrder getJobSearchOrder()
IllegalStateException
- supportsJobSearchOrder()
is false
mandatory
- This method must be implemented. void orderByCompetency(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCompetencySearchOrder()
true
if a competency search order is available,
false
otherwisemandatory
- This method must be implemented. CompetencySearchOrder getCompetencySearchOrder()
IllegalStateException
-
supportsCompetencySearchOrder()
is false
mandatory
- This method must be implemented. void orderByPercentage(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. AvailabilitySearchOrderRecord getAvailabilitySearchOrderRecord(Type availabilityRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.availabilityRecordType
- an availability record typeNullArgumentException
- availabilityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(availabilityRecordType)
is false
mandatory
- This method must be implemented.