Interface | osid.personnel.OrganizationSearchSession | ||
---|---|---|---|
Implements | osid.personnel.OrganizationQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Organizations may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getOrganizationSearch | ||
Description |
Gets an organization search. | ||
Return | osid.personnel.OrganizationSearch | the organization search | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationSearchOrder | ||
Description |
Gets an organization search order. The | ||
Return | osid.personnel.OrganizationSearchOrder | the organization search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.personnel.OrganizationQuery | organizationQuery | the organization query |
osid.personnel.OrganizationSearch | organizationSearch | the organization search | |
Return | osid.personnel.OrganizationSearchResults | the search results | |
Errors | NULL_ARGUMENT | organizationQuery or organizationSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | organizationQuery or organizationSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationQueryFromInspector | ||
Description |
Gets an organization query from an inspector. The
inspector is available from an | ||
Parameters | osid.personnel.OrganizationQueryInspector | organizationQueryInspector | an organization query inspector |
Return | osid.personnel.OrganizationQuery | the organization query | |
Errors | NULL_ARGUMENT | organizationQueryInspector is null | |
UNSUPPORTED | organizationQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |