OSID - osid.resourcing.rules.AvailabilityEnablerQuery Service Interface Definition

Interface	osid.resourcing.rules.AvailabilityEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.resourcing.rules.AvailabilityEnablerQuerySession`
	`osid.resourcing.rules.AvailabilityEnablerSearchSession`
	`osid.resourcing.rules.AvailabilityEnablerSmartFoundrySession`
Description	This is the query for searching availability enablers. Each method match specifies a `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledAvailabilityId
Description	Matches mapped to an availability.
Parameters	`osid.id.Id`	`availabilityId`	the availability `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`availabilityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAvailabilityIdTerms
Description	Clears the availability `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledAvailabilityQuery
Description	Tests if an `AvailabilityQuery` is available.
Return	`boolean`		`true` if an availability query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledAvailabilityQuery
Description	Gets the query for an availability. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.AvailabilityQuery`		the availability query
Errors	UNIMPLEMENTED		`supportsRuledAvailabilityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledAvailabilityQuery()` is `true`.
Method	matchAnyRuledAvailability
Description	Matches mapped to any availability.
Parameters	`boolean`	`match`	`true` for mapped to any availability, `false` to match mapped to no availabilities
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAvailabilityTerms
Description	Clears the availability query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Matches mapped to the foundry.
Parameters	`osid.id.Id`	`foundryId`	the foundry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`foundryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFoundryIdTerms
Description	Clears the foundry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFoundryQuery
Description	Tests if a `FoundryQuery` is available.
Return	`boolean`		`true` if a foundry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryQuery
Description	Gets the query for a foundry. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.FoundryQuery`		the foundry query
Errors	UNIMPLEMENTED		`supportsFoundryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFoundryQuery()` is `true`.
Method	clearFoundryTerms
Description	Clears the foundry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablerQueryRecord
Description	Gets the availability enabler query record corresponding to the given `AvailabilityEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`availabilityEnablerRecordType`	an availability enabler record type
Return	`osid.resourcing.rules.records.AvailabilityEnablerQueryRecord`		the availability enabler query record
Errors	NULL_ARGUMENT		`availabilityEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(availabilityEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.