OSID - osid.contact.AddressQuery Service Interface Definition

Interface	osid.contact.AddressQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching for addresses. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchResourceId
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	clearResourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
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	getResourceQuery
Description	Gets the query for a resource query. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true.`
Method	clearResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAddressText
Description	Matches the address text.
Parameters	`string`	`address`	the address text
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`address` or `stringMatchType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddressTextTerms
Description	Clears the text address terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContactId
Description	Sets the contact `Id` for this query to match contacts assigned to addresses.
Parameters	`osid.id.Id`	`contactId`	a contact `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`contactId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearContactIdTerms
Description	Clears the contact `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactQuery
Description	Tests if a contact query is available.
Return	`boolean`		`true` if a contact query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContactQuery
Description	Gets the query for an address.
Return	`osid.contact.ContactQuery`		the contact query
Errors	UNIMPLEMENTED		`supportsContactQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactQuery()` is `true.`
Method	matchAnyContact
Description	Matches addresses with any contact.
Parameters	`boolean`	`match`	`true` to match addresses with any contact, `false` to match addresses with no contacts
Compliance	`mandatory`		This method must be implemented.
Method	clearContactTerms
Description	Clears the contact 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	getAddressQueryRecord
Description	Gets the address query record corresponding to the given `Address` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`addressRecordType`	an address record type
Return	`osid.contact.records.AddressQueryRecord`		the address query record
Errors	NULL_ARGUMENT		`addressRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(addressRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.