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

Interface	osid.provisioning.rules.ProvisionEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.ProvisionEnablerQuerySession`
	`osid.provisioning.rules.ProvisionEnablerSearchSession`
	`osid.provisioning.rules.ProvisionEnablerSmartDistributorSession`
Description	This is the query for searching provision enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledProvisionId
Description	Matches mapped to the provision.
Parameters	`osid.id.Id`	`provisionId`	the provision `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`provisionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledProvisionIdTerms
Description	Clears the provision `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledProvisionQuery
Description	Tests if a `ProvisionQuery` is available.
Return	`boolean`		`true` if a provision query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledProvisionQuery
Description	Gets the query for a provision. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionQuery`		the provision query
Errors	UNIMPLEMENTED		`supportsRuledProvisionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledProvisionQuery()` is `true`.
Method	matchAnyRuledProvision
Description	Matches mapped to any provision.
Parameters	`boolean`	`match`	`true` for mapped to any provision, `false` to match mapped to no provision
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledProvisionTerms
Description	Clears the provision query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Sets the distributor `Id` for this query to match provision 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	getProvisionEnablerQueryRecord
Description	Gets the provision enabler query record corresponding to the given `ProvisionEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`provisionEnablerRecordType`	a provision enabler record type
Return	`osid.provisioning.rules.records.ProvisionEnablerQueryRecord`		the provision enabler query record
Errors	NULL_ARGUMENT		`provisionEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(provisionEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.