OSID - osid.hold.OublietteQueryInspector Service Interface Definition

Interface	osid.hold.OublietteQueryInspector
Implements	`osid.OsidCatalogQueryInspector`
Used By	`osid.hold.BlockQueryInspector`
	`osid.hold.HoldQueryInspector`
	`osid.hold.IssueQueryInspector`
	`osid.hold.OublietteQueryInspector`
	`osid.hold.OublietteSearchResults`
	`osid.hold.rules.HoldEnablerQueryInspector`
	`osid.hold.rules.IssueConstrainerEnablerQueryInspector`
	`osid.hold.rules.IssueConstrainerQueryInspector`
	`osid.hold.rules.IssueEnablerQueryInspector`
	`osid.hold.rules.IssueProcessorEnablerQueryInspector`
	show 1 more…
`osid.hold.rules.IssueProcessorQueryInspector`
Description	This is the query inspector for examining oubliette queries. Like all `OsidQueryInspectors`, `OublietteQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getBlockIdTerms
Description	Gets the block `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getBlockTerms
Description	Gets the block query terms.
Return	`osid.hold.BlockQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getIssueIdTerms
Description	Gets the issue `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getIssueTerms
Description	Gets the issue query terms.
Return	`osid.hold.IssueQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getHoldIdTerms
Description	Gets the hold `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getHoldTerms
Description	Gets the hold query terms.
Return	`osid.hold.HoldQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorOublietteIdTerms
Description	Gets the ancestor oubliette `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorOublietteTerms
Description	Gets the ancestor oubliette query terms.
Return	`osid.hold.OublietteQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantOublietteIdTerms
Description	Gets the descendant oubliette `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantOublietteTerms
Description	Gets the descendant oubliette query terms.
Return	`osid.hold.OublietteQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteQueryInspectorRecord
Description	Gets the oubliette query inspector record corresponding to the given `Oubliette` record `Type`.
Parameters	`osid.type.Type`	`oublietteRecordType`	an oubliette record type
Return	`osid.hold.records.OublietteQueryInspectorRecord`		the oubliette query inspector record
Errors	NULL_ARGUMENT		`oublietteRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(oublietteRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.