OSID - osid.provisioning.rules.ProvisionableEnablerQuery Service Interface Definition

Interface	osid.provisioning.rules.ProvisionableEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.ProvisionableEnablerQuerySession`
	`osid.provisioning.rules.ProvisionableEnablerSearchSession`
	`osid.provisioning.rules.ProvisionableEnablerSmartDistributorSession`
Description	This is the query for searching provisionable enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledProvisionableId
Description	Matches mapped to the provisionable.
Parameters	`osid.id.Id`	`provisionableId`	the provisionable `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`provisionableId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledProvisionableIdTerms
Description	Clears the provisionable `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledProvisionableQuery
Description	Tests if a `ProvisionableQuery` is available.
Return	`boolean`		`true` if a provisionable query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledProvisionableQuery
Description	Gets the query for a provisionable. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionableQuery`		the provisionable query
Errors	UNIMPLEMENTED		`supportsRuledProvisionableQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledProvisionableQuery()` is `true`.
Method	matchAnyRuledProvisionable
Description	Matches mapped to any provisionable.
Parameters	`boolean`	`match`	`true` for mapped to any provisionable, `false` to match mapped to no provisionable
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledProvisionableTerms
Description	Clears the provisionable query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Sets the distributor `Id` for this query to match provisionables assigned to distributors.
Parameters	`osid.id.Id`	`distributorId`	the distributor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`distributorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributorIdTerms
Description	Clears the distributor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDistributorQuery
Description	Tests if a `DistributorQuery` is available.
Return	`boolean`		`true` if a distributor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorQuery
Description	Gets the query for a distributor. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.DistributorQuery`		the distributor query
Errors	UNIMPLEMENTED		`supportsDistributorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDistributorQuery()` is `true`.
Method	clearDistributorTerms
Description	Clears the distributor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableEnablerQueryRecord
Description	Gets the provisionable enabler query record corresponding to the given `ProvisionableEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`provisionableEnablerRecordType`	a provisionable enabler record type
Return	`osid.provisioning.rules.records.ProvisionableEnablerQueryRecord`		the provisionable enabler query record
Errors	NULL_ARGUMENT		`provisionableEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(provisionableEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.