OSID - osid.profile.ProfileItemQuery Service Interface Definition

Interface	osid.profile.ProfileItemQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.profile.ProfileEntryQuery`
	`osid.profile.ProfileEntrySmartProfileSession`
	`osid.profile.ProfileItemQuerySession`
	`osid.profile.ProfileItemSearchSession`
	`osid.profile.ProfileItemSmartProfileSession`
	`osid.profile.ProfileQuery`
Description	This is the query for searching profile items. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR` .
Method	matchProfileEntryId
Description	Sets the pofile entry `Id` for this query.
Parameters	`osid.id.Id`	`profileEntryId`	a profile entry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`profileEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProfileEntryIdTerms
Description	Clears the profile entry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryQuery
Description	Tests if an `ProfileEntryQuery` is available.
Return	`boolean`		`true` if a profile entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryQuery
Description	Gets the query for a profile entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.profile.ProfileEntryQuery`		the profile entry query
Errors	UNIMPLEMENTED		`supportsProfileEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryQuery()` is `true` .
Method	matchAnyProfileEntry
Description	Matches profile items that have any profile entry mapping.
Parameters	`boolean`	`match`	`true` to match items with any entry mapping, `false` to match items with no entry mapping
Compliance	`mandatory`		This method must be implemented.
Method	clearProfileEntryTerms
Description	Clears the profile entry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProfileId
Description	Sets the profile `Id` for this query.
Parameters	`osid.id.Id`	`profileId`	a profile `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`profileId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProfileIdTerms
Description	Clears the profile `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileQuery
Description	Tests if a `ProfileQuery` is available.
Return	`boolean`		`true` if a profile query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileQuery
Description	Gets the query for a profile. Multiple retrievals produce a nested `OR` term.
Return	`osid.profile.ProfileQuery`		the profile query
Errors	UNIMPLEMENTED		`supportsProfileQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileQuery()` is `true` .
Method	clearProfileTerms
Description	Clears the profile entry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemQueryRecord
Description	Gets the profile item query record corresponding to the given `ProfileItem` record `Type` . Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`profileItemRecordType`	a profile item record type
Return	`osid.profile.records.ProfileItemQueryRecord`		the profile item query record
Errors	NULL_ARGUMENT		`profileItemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(profileItemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.