OSID - osid.sequencing.AntimatroidQuery Service Interface Definition

Interface	osid.sequencing.AntimatroidQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.sequencing.AntimatroidQuery`
	`osid.sequencing.AntimatroidQuerySession`
	`osid.sequencing.AntimatroidSearchSession`
	`osid.sequencing.ChainQuery`
Description	This is the query for searching antimatroids. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchChainId
Description	Sets the chain `Id` for this query.
Parameters	`osid.id.Id`	`chainId`	the chain `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`chainId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearChainIdTerms
Description	Clears the chain `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInputQuery
Description	Tests if a `ChainQuery` is available.
Return	`boolean`		`true` if an input query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getChainQuery
Description	Gets the query for a chain. Multiple retrievals produce a nested `OR` term.
Return	`osid.sequencing.ChainQuery`		the chain query
Errors	UNIMPLEMENTED		`supportsChainQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChainQuery()` is `true`.
Method	matchAnyChain
Description	Matches action groups with any chain.
Parameters	`boolean`	`match`	`true` to match antimatroids with any chain, `false` to match antimatroids with no chains
Compliance	`mandatory`		This method must be implemented.
Method	clearChainTerms
Description	Clears the chain query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorAntimatroidId
Description	Sets the antimatroid `Id` for this query to match antimatroids that have the specified antimatroid as an ancestor.
Parameters	`osid.id.Id`	`antimatroidId`	an antimatroid `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`antimatroidId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorAntimatroidIdTerms
Description	Clears the ancestor antimatroid `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorAntimatroidQuery
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	getAncestorAntimatroidQuery
Description	Gets the query for an antimatroid. Multiple retrievals produce a nested `OR` term.
Return	`osid.sequencing.AntimatroidQuery`		the antimatroid query
Errors	UNIMPLEMENTED		`supportsAncestorAntimatroidQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorAntimatroidQuery()` is `true`.
Method	matchAnyAncestorAntimatroid
Description	Matches antimatroids with any ancestor.
Parameters	`boolean`	`match`	`true` to match antimatroids with any ancestor, `false` to match root antimatroids
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorAntimatroidTerms
Description	Clears the ancestor antimatroid query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantAntimatroidId
Description	Sets the antimatroid `Id` for this query to match antimatroids that have the specified antimatroid as a descendant.
Parameters	`osid.id.Id`	`antimatroidId`	an antimatroid `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`antimatroidId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantAntimatroidIdTerms
Description	Clears the descendant antimatroid `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantAntimatroidQuery
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	getDescendantAntimatroidQuery
Description	Gets the query for an antimatroid/ Multiple retrievals produce a nested `OR` term.
Return	`osid.sequencing.AntimatroidQuery`		the antimatroid query
Errors	UNIMPLEMENTED		`supportsDescendantAntimatroidQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantAntimatroidQuery()` is `true`.
Method	matchAnyDescendantAntimatroid
Description	Matches antimatroids with any descendant.
Parameters	`boolean`	`match`	`true` to match antimatroids with any descendant, `false` to match leaf antimatroids
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantAntimatroidTerms
Description	Clears the descendant antimatroid query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroidQueryRecord
Description	Gets the antimatroid query record corresponding to the given `Antimatroid` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`antimatroidRecordType`	an antimatroid record type
Return	`osid.sequencing.records.AntimatroidQueryRecord`		the antimatroid query record
Errors	NULL_ARGUMENT		`antimatroidRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(antimatroidRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.