OSID - osid.ontology.SubjectSearchSession Service Interface Definition

Interface	osid.ontology.SubjectSearchSession
Implements	`osid.ontology.SubjectQuerySession`
Description	This session provides methods for searching `Subject` objects. The search query is constructed using the `SubjectQuery.` The subject record `Type` also specifies the record for the subject query. `getSubjectsByQuery()` is the basic search method and returns a list of `Subjects.` A more advanced search may be performed with `getSubjectsBySearch().` It accepts a `SubjectSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSubjectsBySearch()` returns a `SubjectSearchResults` that can be used to access the resulting `SubjectList` or be used to perform a search within the result set through `SubjectSearch.` This session defines views that offer differing behaviors for searching. federated ontology view: searches include subjects in ontologies of which this ontology is a ancestor in the ontology hierarchy isolated ontology view: searches are restricted to subjects in this ontology Subjects may have a query record indicated by their respective record types. The query record is accessed via the `SubjectQuery.`
Method	getSubjectSearch
Description	Gets a subject search.
Return	`osid.ontology.SubjectSearch`		the subject search
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectSearchOrder
Description	Gets a subject search order. The `SubjectSearchOrder` is supplied to a `SubjectSearch` to specify the ordering of results.
Return	`osid.ontology.SubjectSearchOrder`		the subject search order
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.ontology.SubjectQuery`	`subjectQuery`	the subject query
Parameters	`osid.ontology.SubjectSearch`	`subjectSearch`	the subject search
Return	`osid.ontology.SubjectSearchResults`		the subject search results
Errors	NULL_ARGUMENT		`subjectQuery` or `subjectSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`subjectSearch` or `subjectQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectQueryFromInspector
Description	Gets a subject query from an inspector. The inspector is available from a `SubjecttSearchResults.`
Parameters	`osid.ontology.SubjectQueryInspector`	`subjectQueryInspector`	a subject query inspector
Return	`osid.ontology.SubjectQuery`		the subject query
Errors	NULL_ARGUMENT		`subjectQueryInspector` is `null`
Errors	UNSUPPORTED		`subjectQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.