OSID Specifications
personnel package
Version 3.1.0
personnel package
Version 3.1.0
| Interface | osid.personnel.AppointmentSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.personnel.AppointmentSearchSession | ||
osid.personnel.AppointmentSmartRealmSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByPerson | ||
| Description |
Specifies a preference for ordering the result set by the person. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPersonSearchOrder | ||
| Description |
Tests if a person search order is available. | ||
| Return | boolean | true if a person search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPersonSearchOrder | ||
| Description |
Gets the person search order. | ||
| Return | osid.personnel.PersonSearchOrder | the person search order | |
| Errors | UNIMPLEMENTED | supportsPersonSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsPersonSearchOrder() is true. | |
| Method | orderByPosition | ||
| Description |
Specifies a preference for ordering the result set by the position. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPositionSearchOrder | ||
| Description |
Tests if a position search order is available. | ||
| Return | boolean | true if a position search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPositionSearchOrder | ||
| Description |
Gets the position search order. | ||
| Return | osid.personnel.PositionSearchOrder | the position search order | |
| Errors | UNIMPLEMENTED | supportsPositionSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsPositionSearchOrder() is true. | |
| Method | orderByCommitment | ||
| Description |
Specifies a preference for ordering the result set by the commitment. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByTitle | ||
| Description |
Specifies a preference for ordering the result set by the title. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySalary | ||
| Description |
Specifies a preference for ordering the result set by the salary. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAppointmentSearchOrderRecord | ||
| Description |
Gets the appointment search order record corresponding
to the given appointment record | ||
| Parameters | osid.type.Type | appointmentRecordType | an appointment record type |
| Return | osid.personnel.records.AppointmentSearchOrderRecord | the appointment search order record | |
| Errors | NULL_ARGUMENT | appointmentRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(appointmentRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |