OSID - osid.personnel.OrganizationSearchSession Service Interface Definition

Interface	osid.personnel.OrganizationSearchSession
Implements	`osid.personnel.OrganizationQuerySession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session provides methods for searching `Organization` objects. The search query is constructed using the `OrganizationQuery` . The organization record `Type` also specifies the record for the organization query. `getOrganizationsByQuery()` is the basic search method and returns a list of `Organization` elements. A more advanced search may be performed with `getOrganizationsBySearch()` . It accepts an `OrganizationSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getOrganizationsBySearch()` returns an `OrganizationSearchResults` that can be used to access the resulting `OrganizationList` or be used to perform a search within the result set through `OrganizationSearch` . This session defines views that offer differing behaviors for searching. federated realm view: searches include organizations in realms of which this realm is an ancestor in the realm hierarchy isolated realm view: searches are restricted to organizations in this realm Organizations may have a query record indicated by their respective record types. The query record is accessed via the `OrganizationQuery` . The returns in this session may not be cast directly to these interfaces.
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 `OrganizationSearchOrder` is supplied to an `OrganizationSearch` to specify the ordering of results.
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
Parameters	`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 `OrganizationSearchResults` .
Parameters	`osid.personnel.OrganizationQueryInspector`	`organizationQueryInspector`	an organization query inspector
Return	`osid.personnel.OrganizationQuery`		the organization query
Errors	NULL_ARGUMENT		`organizationQueryInspector` is `null`
Errors	UNSUPPORTED		`organizationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.