OSID - osid.sequencing.ChainQuery Service Interface Definition

Interface	osid.sequencing.ChainQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.sequencing.AntimatroidQuery`
	`osid.sequencing.ChainQuerySession`
	`osid.sequencing.ChainSearchSession`
	`osid.sequencing.ChainSmartAntimatroidSession`
Description	This is the query for searching chains. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchFifo
Description	Matches fifo chains.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearFifoTerms
Description	Clears the fifo query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchElement
Description	Sets the element `Id` for this query.
Parameters	`osid.id.Id`	`elementId`	the element `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`elementId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyElement
Description	Matches chains with any element.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearElementTerms
Description	Clears the element query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAntimatroidId
Description	Sets the action group `Id` for this query to match sequencinglers assigned to action groups.
Parameters	`osid.id.Id`	`actionGroupId`	the action group `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`actionGroupId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAntimatroidIdTerms
Description	Clears the antimatroid `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidQuery
Description	Tests if an `AntimatroidQuery` is available.
Return	`boolean`		`true` if an antimatroid query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroidQuery
Description	Gets the query for an antimatroid. Multiple retrievals produce a nested `OR` term.
Return	`osid.sequencing.AntimatroidQuery`		the antimatroid query
Errors	UNIMPLEMENTED		`supportsAntimatroidQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAntimatroidQuery()` is `true`.
Method	clearAntimatroidTerms
Description	Clears the antimatroid query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getChainQueryRecord
Description	Gets the query record corresponding to the given `Chain` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`chainRecordType`	a chain record type
Return	`osid.sequencing.records.ChainQueryRecord`		the chain query record
Errors	NULL_ARGUMENT		`chainRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(chainRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.