OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
personnel package
Version 3.0.0
Release Candidate Preview
| Interface | osid.personnel.OrganizationSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing organization searches. | ||
| Method | searchAmongOrganizations | ||
| Description |
Execute this search among the given list of organizations. | ||
| Parameters | osid.id.IdList | organizationIds | list of organizations |
| Errors | NULL_ARGUMENT | organizationIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOrganizationResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.personnel.OrganizationSearchOrder | organizationSearchOrder | organization search order |
| Errors | NULL_ARGUMENT | organizationSearchOrder is null | |
| UNSUPPORTED | organizationSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrganizationSearchRecord | ||
| 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.OrganizationSearchRecord | the organization search 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. | |