OSID Specifications
personnel package
Version 3.1.0
personnel package
Version 3.1.0
| Interface | osid.personnel.PositionSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidTemporalSearchOrder | |||
osid.OsidSubjugateableSearchOrder | |||
| Used By | osid.personnel.AppointmentSearchOrder | ||
osid.personnel.PositionSearchSession | |||
osid.personnel.PositionSmartRealmSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByOrganization | ||
| Description |
Specifies a preference for ordering the result set by the organization. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsOrganizationSearchOrder | ||
| Description |
Tests if an organization search order is available. | ||
| Return | boolean | true if an organization search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrganizationSearchOrder | ||
| Description |
Gets the organization search order. | ||
| Return | osid.personnel.OrganizationSearchOrder | the organization search order | |
| Errors | UNIMPLEMENTED | supportsOrganizationSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsOrganizationSearchOrder() is true. | |
| 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 | orderByLevel | ||
| Description |
Specifies a preference for ordering the result set by the level. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsLevelSearchOrder | ||
| Description |
Tests if a grade level search order is available. | ||
| Return | boolean | true if a level search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLevelSearchOrder | ||
| Description |
Gets the level search order. | ||
| Return | osid.grading.GradeSearchOrder | the level search order | |
| Errors | UNIMPLEMENTED | supportsLevelSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsLevelSearchOrder()
is true. | |
| Method | orderByTargetAppointments | ||
| Description |
Specifies a preference for ordering the result set by the target appointments. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRequiredCommitment | ||
| Description |
Specifies a preference for ordering the result set by the required commitment. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByLowSalaryRange | ||
| Description |
Specifies a preference for ordering the result set by the low salary. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMidpointSalaryRange | ||
| Description |
Specifies a preference for ordering the result set by the midpoint salary. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByHighSalaryRange | ||
| Description |
Specifies a preference for ordering the result set by the high salary. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCompensationFrequency | ||
| Description |
Specifies a preference for ordering the result set by the compensation frequency. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByExempt | ||
| Description |
Specifies a preference for ordering the result set by the exempt flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBenefitsType | ||
| Description |
Specifies a preference for ordering the result set by the benefits type. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPositionSearchOrderRecord | ||
| Description |
Gets the position search order record corresponding to
the given position record | ||
| Parameters | osid.type.Type | positionRecordType | a position record type |
| Return | osid.personnel.records.PositionSearchOrderRecord | the position search order record | |
| Errors | NULL_ARGUMENT | positionRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(positionRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |