Interface | osid.personnel.PersonSearchSession | ||
---|---|---|---|
Implements | osid.personnel.PersonQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Persons may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getPersonSearch | ||
Description |
Gets a person search. | ||
Return | osid.personnel.PersonSearch | the person search | |
Compliance | mandatory | This method must be implemented. | |
Method | getPersonSearchOrder | ||
Description |
Gets a person search order. The | ||
Return | osid.personnel.PersonSearchOrder | the person search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getPersonsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.personnel.PersonQuery | personQuery | the person query |
osid.personnel.PersonSearch | personSearch | the person search | |
Return | osid.personnel.PersonSearchResults | the search results | |
Errors | NULL_ARGUMENT | personQuery or personSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | personQuery or personSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonQueryFromInspector | ||
Description |
Gets a person query from an inspector. The inspector is
available from a | ||
Parameters | osid.personnel.PersonQueryInspector | personQueryInspector | a person query inspector |
Return | osid.personnel.PersonQuery | the person query | |
Errors | NULL_ARGUMENT | personQueryInspector is null | |
UNSUPPORTED | personQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |