OSID - osid.profile.ProfileEntryQuery Service Interface Definition

Interface	osid.profile.ProfileEntryQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.profile.ProfileEntryQuery`
	`osid.profile.ProfileEntryQuerySession`
	`osid.profile.ProfileEntrySearchSession`
	`osid.profile.ProfileEntrySmartProfileSession`
	`osid.profile.ProfileItemQuery`
	`osid.profile.ProfileQuery`
	`osid.profile.rules.ProfileEntryEnablerQuery`
Description	The query for profile entries.
Method	matchImplicit
Description	Matches implicit profile entries.
Parameters	`boolean`	`match`	`true` ito match implicit profile entries, `false` to match implciit profile entries
Compliance	`mandatory`		This method must be implemented.
Method	clearImplicitTerms
Description	Clears the implicit profile entries query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRelatedProfileEntryId
Description	Adds an `Id` to match an explicit or implicitly related profile entries depending on `matchExplicitProfileEntries()`. Multiple `Ids` can be added to perform a boolean `OR` among them.
Parameters	`osid.id.Id`	`id`	`Id` to match
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`id` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRelatedProfileEntryIdTerms
Description	Clears the related profile entry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelatedProfileEntryQuery
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	getRelatedProfileEntryQuery
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		`supportsRelatedProfileEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelatedProfileEntryQuery()` is `true`.
Method	clearRelatedProfileEntryTerms
Description	Clears the related profile entry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResourceId
Description	Matches the resource identified by the given `Id`.
Parameters	`osid.id.Id`	`resourceId`	the Id of the `Resource`
Parameters	`boolean`	`match`	`true` if 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 resource query.
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Return	`osid.resource.ResourceQuery`		the `ResourceQuery`
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	matchAgentId
Description	Matches the agent identified by the given `Id`.
Parameters	`osid.id.Id`	`agentId`	the Id of the `Agent`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentIdTerms
Description	Clears the agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
Description	Tests if an `AgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentQuery
Description	Gets the agent query.
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Return	`osid.authentication.AgentQuery`		the `AgentQuery`
Errors	UNIMPLEMENTED		`supportsAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` is `true`.
Method	clearAgentTerms
Description	Clears the agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProfileItemId
Description	Matches the profile item identified by the given `Id`.
Parameters	`osid.id.Id`	`profileItemId`	the Id of the `ProfileItem`
Parameters	`boolean`	`match`	`true` if 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` 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 profile item query.
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Return	`osid.profile.ProfileItemQuery`		the `FunctinQuery`
Errors	UNIMPLEMENTED		`supportsProfileItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemQuery()` is `true`.
Method	clearProfileItemTerms
Description	Clears the profile item 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 interface 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	getProfileEntryQueryRecord
Description	Gets the profile entry query record corresponding to the given `ProfileEntry` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`profileEntryRecordType`	a profile entry record type
Return	`osid.profile.records.ProfileEntryQueryRecord`		the profile entry query record
Errors	NULL_ARGUMENT		`profileEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(profileEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.