OSID - osid.profile.ProfileQuery Service Interface Definition

Interface	osid.profile.ProfileQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching profiles. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchProfileItemId
Description	Sets the profile item `Id` for this query.
Parameters	`osid.id.Id`	`profileItemId`	a profile item `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`profileItemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProfileItemIdTerms
Description	Clears the profile item `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemQuery
Description	Tests if a `ProfileItemQuery` is available.
Return	`boolean`		`true` if a profile item query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemQuery
Description	Gets the query for a profile item. Multiple retrievals produce a nested `OR` term.
Return	`osid.profile.ProfileItemQuery`		the profile item query
Errors	UNIMPLEMENTED		`supportsProfileItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemQuery()` is `true.`
Method	matchAnyProfileItem
Description	Matches profiles that have any profile item.
Parameters	`boolean`	`match`	`true` to match profiles with any item mapping, `false` to match profiles with no item mapping
Compliance	`mandatory`		This method must be implemented.
Method	clearProfileItemTerms
Description	Clears the profile item query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProfileEntryId
Description	Sets the profile 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 a `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 profiles that have any profile entry.
Parameters	`boolean`	`match`	`true` to match profiles with any entry mapping, `false` to match profiles 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	matchAncestorProfileId
Description	Sets the profile `Id` for this query to match profiles that have the specified profile as an ancestor.
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	clearAncestorProfileIdTerms
Description	Clears the ancestor profile `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorProfileQuery
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	getAncestorProfileQuery
Description	Gets the query for a profile. Multiple retrievals produce a nested `OR` term.
Return	`osid.profile.ProfileQuery`		the profile query
Errors	UNIMPLEMENTED		`supportsAncestorProfileQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorProfileQuery()` is `true.`
Method	matchAnyAncestorProfile
Description	Matches profiles with any ancestor.
Parameters	`boolean`	`match`	`true` to match profile with any ancestor, `false` to match root profiles
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorProfileTerms
Description	Clears the ancestor profile query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantProfileId
Description	Sets the profile `Id` for this query to match that have the specified profile as a descendant.
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	clearDescendantProfileIdTerms
Description	Clears the descendant profile `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantProfileQuery
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	getDescendantProfileQuery
Description	Gets the query for a profile. Multiple retrievals produce a nested `OR` term.
Return	`osid.profile.ProfileQuery`		the profile query
Errors	UNIMPLEMENTED		`supportsDescendantProfileQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantProfileQuery()` is `true.`
Method	matchAnyDescendantProfile
Description	Matches profiles with any descendant.
Parameters	`boolean`	`match`	`true` to match profile with any descendant, `false` to match leaf profiles
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantProfileTerms
Description	Clears the descendant profile query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProfileQueryRecord
Description	Gets the profile query record corresponding to the given `Profile` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`profileRecordType`	a profile record type
Return	`osid.profile.records.ProfileQueryRecord`		the profile query record
Errors	NULL_ARGUMENT		`profileRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(profileRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.