OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
personnel package
Version 3.0.0
Release Candidate Preview
| Interface | osid.personnel.OrganizationQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidFederateableQueryInspector | |||
osid.OsidTemporalQueryInspector | |||
| Description |
The query inspectors provide a means of accessing the match
terms of a query. These interfaces are used to examine the
actual query terms used in a search or that may be used to
create a smart catalog. Query inspectors may be converted to
| ||
| Method | getDisplayLabelTerms | ||
| Description |
Gets the display label query terms. | ||
| Return | osid.search.terms.StringTerm[] | the display label terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorOrganizationIdTerms | ||
| Description |
Gets the ancestor organization | ||
| Return | osid.search.terms.IdTerm[] | the ancestor organization Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorOrganizationTerms | ||
| Description |
Gets the ancestor organization query terms. | ||
| Return | osid.personnel.OrganizationQueryInspector[] | the ancestor organization terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantOrganizationIdTerms | ||
| Description |
Gets the descendant organization | ||
| Return | osid.search.terms.IdTerm[] | the descendant organization Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantOrganizationTerms | ||
| Description |
Gets the descendant organization query terms. | ||
| Return | osid.personnel.OrganizationQueryInspector[] | the descendant organization terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRealmIdTerms | ||
| Description |
Gets the realm | ||
| Return | osid.search.terms.IdTerm[] | the realm Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRealmTerms | ||
| Description |
Gets the realm query terms. | ||
| Return | osid.personnel.RealmQueryInspector[] | the realm terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrganizationQueryInspectorRecord | ||
| Description |
Gets the organization query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | organizationRecordType | an organization record type |
| Return | osid.personnel.records.OrganizationQueryInspectorRecord | the organization inspector query record | |
| Errors | NULL_ARGUMENT | organizationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(organizationRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |