OSID - osid.contact.ContactQuery Service Interface Definition

Interface	osid.contact.ContactQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.contact.AddressBookQuery`
	`osid.contact.AddressQuery`
	`osid.contact.ContactQuerySession`
	`osid.contact.ContactSearchSession`
	`osid.contact.ContactSmartAddressBookSession`
	`osid.contact.rules.ContactEnablerQuery`
Description	This is the query for searching contacts. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchReferenceId
Description	Sets a reference `Id` .
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`referenceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearReferenceIdTerms
Description	Clears the reference `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAddresseeId
Description	Sets a resource `Id` .
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddresseeIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddresseeQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAddresseeQuery
Description	Gets the query for a resource query. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsAddresseeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddresseeQuery()` is `true` .
Method	clearAddresseeTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAddressId
Description	Sets an address `Id` .
Parameters	`osid.id.Id`	`addressId`	an address `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`addressId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddressIdTerms
Description	Clears the address `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressQuery
Description	Tests if an `AddressQuery` is available.
Return	`boolean`		`true` if an address query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAddressQuery
Description	Gets the query for an address query. Multiple retrievals produce a nested `OR` term.
Return	`osid.contact.AddressQuery`		the address query
Errors	UNIMPLEMENTED		`supportsAddressQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressrQuery()` is `true` .
Method	clearAddressTerms
Description	Clears the address terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAddressBookId
Description	Sets the address `Id` for this query to match contacts assigned to address books.
Parameters	`osid.id.Id`	`addressBookId`	an 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` 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 query. 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 terms.
Compliance	`mandatory`		This method must be implemented.
Method	getContactQueryRecord
Description	Gets the contact query record corresponding to the given `Contact` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`contactRecordType`	a contact record type
Return	`osid.contact.records.ContactQueryRecord`		the contact query record
Errors	NULL_ARGUMENT		`contactRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(contactRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.