Interface | osid.personnel.AppointmentQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching appointments. Each method
specifies an | ||
Method | matchPersonId | ||
Description |
Sets a person | ||
Parameters | osid.id.Id | personId | a person Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | personId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPersonIdTerms | ||
Description |
Clears all person | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a person query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPersonQuery | ||
Description |
Gets the query for a person query. Multiple retrievals
produce a nested | ||
Return | osid.personnel.PersonQuery | the person query | |
Errors | UNIMPLEMENTED | supportsPersonQuery() is false | |
Compliance | optional | This method must be implemented if supportsPersonQuery() is
true. | |
Method | clearPersonTerms | ||
Description |
Clears all person terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPositionId | ||
Description |
Sets a position | ||
Parameters | osid.id.Id | positionId | a position Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | positionId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPositionIdTerms | ||
Description |
Clears all position | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a position query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPositionQuery | ||
Description |
Gets the query for a position query. Multiple
retrievals produce a nested | ||
Return | osid.personnel.PositionQuery | the position query | |
Errors | UNIMPLEMENTED | supportsPositionQuery() is false | |
Compliance | optional | This method must be implemented if supportsPositionQuery()
is true. | |
Method | clearPositionTerms | ||
Description |
Clears all position terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCommitment | ||
Description |
Matches a commitment between the given range inclusive. | ||
Parameters | cardinal | from | a starting range |
cardinal | to | an ending range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyCommitment | ||
Description |
Matches positions with any low salary. | ||
Parameters | boolean | match | true to match appointments with any commitment, false
to match appointments with no commitment |
Compliance | mandatory | This method must be implemented. | |
Method | clearCommitmentTerms | ||
Description |
Clears all commitment terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTitle | ||
Description |
Matches a title. | ||
Parameters | string | title | a title |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | title is not of stringMatchType | |
NULL_ARGUMENT | title or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTitle | ||
Description |
Matches persons with any title. | ||
Parameters | boolean | match | true to match appointments with any title, false
to match appointments with no title |
Compliance | mandatory | This method must be implemented. | |
Method | clearTitleTerms | ||
Description |
Clears all title terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSalary | ||
Description |
Matches a salary between the given range inclusive. | ||
Parameters | osid.financials.Currency | from | a starting salary range |
osid.financials.Currency | to | an ending salary range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySalary | ||
Description |
Matches positions with any salary. | ||
Parameters | boolean | match | true to match appointments with any salary, false
to match appointments with no salary |
Compliance | mandatory | This method must be implemented. | |
Method | clearSalaryTerms | ||
Description |
Clears all salary terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRealmId | ||
Description |
Sets the realm | ||
Parameters | osid.id.Id | realmId | a realm Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | realmId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRealmIdTerms | ||
Description |
Clears all realm | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a realm query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealmQuery | ||
Description |
Gets the query for a realm query. Multiple retrievals
produce a nested | ||
Return | osid.personnel.RealmQuery | the realm query | |
Errors | UNIMPLEMENTED | supportsRealmQuery() is false | |
Compliance | optional | This method must be implemented if supportsRealmQuery() is
true. | |
Method | clearRealmTerms | ||
Description |
Clears all realm terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentQueryRecord | ||
Description |
Gets the appointment query record corresponding to the
given | ||
Parameters | osid.type.Type | appointmentRecordType | an appointment record type |
Return | osid.personnel.records.AppointmentQueryRecord | the appointment query 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. |