OSID - osid.ontology.SubjectSmartOntologySession Service Interface Definition

Interface	osid.ontology.SubjectSmartOntologySession
Implements	`osid.OsidSession`
Used By	`osid.ontology.OntologyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `SubjectQuery` can be retrieved from this session and mapped to this `Ontology` to create a virtual collection of `Subjects` . The entries may be sequenced using the `SubjectSearchOrder` from this session. This `Ontology` has a default query that matches any subject and a default search order that specifies no sequencing. The queries may be examined using a `SubjectQueryInspector` . The query may be modified by converting the inspector back to a `SubjectQuery` .
Method	getOntologyId
Description	Gets the `Ontology` `Id` associated with this session.
Return	`osid.id.Id`		the `Ontology Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOntology
Description	Gets the `Ontology` associated with this session.
Return	`osid.ontology.Ontology`		the `Ontology` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartOntologies
Description	Tests if this user can manage smart ontologies. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer smart operations.
Return	`boolean`		`false` if smart ontology methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectQuery
Description	Gets a subject query.
Return	`osid.ontology.SubjectQuery`		the subject query
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectSearchOrder
Description	Gets a subject search order.
Return	`osid.ontology.SubjectSearchOrder`		the subject search order
Compliance	`mandatory`		This method must be implemented.
Method	applySubjectQuery
Description	Applies a subject query to this ontology.
Parameters	`osid.ontology.SubjectQuery`	`subjectQuery`	the subject query
Errors	NULL_ARGUMENT		`subjectQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`subjectQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSubjectQuery
Description	Gets a subject query inspector for this ontology.
Return	`osid.ontology.SubjectQueryInspector`		the subject query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySubjectSequencing
Description	Applies a subject search order to this ontology.
Parameters	`osid.ontology.SubjectSearchOrder`	`subjectSearchOrder`	the subject search order
Errors	NULL_ARGUMENT		`subjectSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`subjectSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectQueryFromInspector
Description	Gets a subject query from an inspector.
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.