OSID - osid.contact.rules.ContactEnablerQuery Service Interface Definition

Interface	osid.contact.rules.ContactEnablerQuery
Implements	`osid.OsidEnablerQuery`
Description	This is the query for searching contact enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchRuledContactId
Description	Matches enablers mapped to the contact.
Parameters	`osid.id.Id`	`contactId`	the contact book `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`contactBookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledContactIdTerms
Description	Clears the contact `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledContactQuery
Description	Tests if a `ContactBookQuery` is available.
Return	`boolean`		`true` if a contact query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledContactQuery
Description	Gets the query for a contact. Multiple retrievals produce a nested `OR` term.
Return	`osid.contact.ContactQuery`		the address book query
Errors	UNIMPLEMENTED		`supportsContactQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactQuery()` is `true.`
Method	matchAnyRuledContact
Description	Matches enablers mapped to any contact.
Parameters	`boolean`	`match`	`true` for enablers mapped to any contact, `false` to match enablers mapped to no contact
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledContactTerms
Description	Clears the contact query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAddressBookId
Description	Matches enablers mapped to the address book.
Parameters	`osid.id.Id`	`addressBookId`	the address book `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`addressBookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddressBookIdTerms
Description	Clears the address book `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookQuery
Description	Tests if an `AddressBookQuery` is available.
Return	`boolean`		`true` if an address book query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBookQuery
Description	Gets the query for an address book. Multiple retrievals produce a nested `OR` term.
Return	`osid.contact.AddressBookQuery`		the address book query
Errors	UNIMPLEMENTED		`supportsAddressBookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookQuery()` is `true.`
Method	clearAddressBookTerms
Description	Clears the address book query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablerQueryRecord
Description	Gets the contact enabler query record corresponding to the given `ContactEnabler` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`contactEnablerRecordType`	a contact enabler record type
Return	`osid.contact.rules.records.ContactEnablerQueryRecord`		the contact enabler query record
Errors	NULL_ARGUMENT		`contactEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(contactEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.