OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
personnel package
Version 3.0.0
Release Candidate Preview
| Interface | osid.personnel.OrganizationSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getOrganizations | ||
| Description |
Gets the organization list resulting from a search. | ||
| Return | osid.personnel.OrganizationList | the organization list | |
| Errors | ILLEGAL_STATE | the list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrganizationQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.personnel.OrganizationQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrganizationSearchResultsRecord | ||
| Description |
Gets the record corresponding to the given organization
search record | ||
| Parameters | osid.type.Type | organizationSearchRecordType | an organization search record type |
| Return | osid.personnel.records.OrganizationSearchResultsRecord | the organization search results record | |
| Errors | NULL_ARGUMENT | organizationSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(organizationSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |