public interface AppointmentSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AppointmentSearchOrderRecord |
getAppointmentSearchOrderRecord(Type appointmentRecordType)
Gets the appointment search order record corresponding to the given
appointment record
Type. |
PersonSearchOrder |
getPersonSearchOrder()
Gets the person search order.
|
PositionSearchOrder |
getPositionSearchOrder()
Gets the position search order.
|
void |
orderByCommitment(SearchOrderStyle style)
Specifies a preference for ordering the result set by the commitment.
|
void |
orderByPerson(SearchOrderStyle style)
Specifies a preference for ordering the result set by the person.
|
void |
orderByPosition(SearchOrderStyle style)
Specifies a preference for ordering the result set by the position.
|
void |
orderBySalary(SearchOrderStyle style)
Specifies a preference for ordering the result set by the salary.
|
void |
orderByTitle(SearchOrderStyle style)
Specifies a preference for ordering the result set by the title.
|
boolean |
supportsPersonSearchOrder()
Tests if a person search order is available.
|
boolean |
supportsPositionSearchOrder()
Tests if a position search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByPerson(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPersonSearchOrder()
true
if a person search order is available,
false
otherwisemandatory
- This method must be implemented. PersonSearchOrder getPersonSearchOrder()
UnimplementedException
-
supportsPersonSearchOrder()
is false
optional
- This method must be implemented if
supportsPersonSearchOrder()
is true.
void orderByPosition(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPositionSearchOrder()
true
if a position search order is available,
false
otherwisemandatory
- This method must be implemented. PositionSearchOrder getPositionSearchOrder()
UnimplementedException
-
supportsPositionSearchOrder()
is false
optional
- This method must be implemented if
supportsPositionSearchOrder()
is true.
void orderByCommitment(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTitle(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySalary(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. AppointmentSearchOrderRecord getAppointmentSearchOrderRecord(Type appointmentRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.appointmentRecordType
- an appointment record typeNullArgumentException
- appointmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(appointmentRecordType)
is false
mandatory
- This method must be implemented.