org.osid.profile

Interface ProfileEntryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface ProfileEntryQuery
extends OsidRelationshipQuery

The query for profile entries.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAgentIdTerms() Clears the agent Id terms.
void	clearAgentTerms() Clears the agent terms.
void	clearImplicitTerms() Clears the implicit profile entries query terms.
void	clearProfileIdTerms() Clears the profile Id query terms.
void	clearProfileItemIdTerms() Clears the profile item Id terms.
void	clearProfileItemTerms() Clears the profile item terms.
void	clearProfileTerms() Clears the profile entry query terms.
void	clearRelatedProfileEntryIdTerms() Clears the related profile entry Id query terms.
void	clearRelatedProfileEntryTerms() Clears the related profile entry query terms.
void	clearResourceIdTerms() Clears the resource Id terms.
void	clearResourceTerms() Clears the resource terms.
AgentQuery	getAgentQuery(boolean match) Gets the agent query.
ProfileEntryQueryRecord	getProfileEntryQueryRecord(Type profileEntryRecordType) Gets the profile entry query record corresponding to the given ProfileEntry record Type.
ProfileItemQuery	getProfileItemQuery(boolean match) Gets the profile item query.
ProfileQuery	getProfileQuery() Gets the query interface for a profile.
ProfileEntryQuery	getRelatedProfileEntryQuery() Gets the query for a profile entry.
ResourceQuery	getResourceQuery(boolean match) Gets the resource query.
void	matchAgentId(Id agentId, boolean match) Matches the agent identified by the given Id.
void	matchImplicit(boolean match) Matches implicit profile entries.
void	matchProfileId(Id profileId, boolean match) Sets the profile Id for this query.
void	matchProfileItemId(Id profileItemId, boolean match) Matches the profile item identified by the given Id.
void	matchRelatedProfileEntryId(Id id, boolean match) Adds an Id to match an explicit or implicitly related profile entries depending on matchExplicitProfileEntries().
void	matchResourceId(Id resourceId, boolean match) Matches the resource identified by the given Id.
boolean	supportsAgentQuery() Tests if an AgentQuery is available.
boolean	supportsProfileItemQuery() Tests if a ProfileItemQuery is available.
boolean	supportsProfileQuery() Tests if a ProfileQuery is available.
boolean	supportsRelatedProfileEntryQuery() Tests if a ProfileEntryQuery is available.
boolean	supportsResourceQuery() Tests if a ResourceQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchImplicit

void matchImplicit(boolean match)

Matches implicit profile entries.

Parameters:

match - true ito match implicit profile entries, false to match implciit profile entries

Compliance:

mandatory - This method must be implemented.

clearImplicitTerms

void clearImplicitTerms()

Clears the implicit profile entries query terms.

Compliance:

mandatory - This method must be implemented.

matchRelatedProfileEntryId

void matchRelatedProfileEntryId(Id id,
                              boolean match)

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:

id - Id to match

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - id is null

Compliance:

mandatory - This method must be implemented.

clearRelatedProfileEntryIdTerms

void clearRelatedProfileEntryIdTerms()

Clears the related profile entry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRelatedProfileEntryQuery

boolean supportsRelatedProfileEntryQuery()

Tests if a ProfileEntryQuery is available.

Returns:

true if a profile entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRelatedProfileEntryQuery

ProfileEntryQuery getRelatedProfileEntryQuery()

Gets the query for a profile entry. Multiple retrievals produce a nested OR term.

Returns:

the profile entry query

Throws:

UnimplementedException - supportsRelatedProfileEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsRelatedProfileEntryQuery() is true.

clearRelatedProfileEntryTerms

void clearRelatedProfileEntryTerms()

Clears the related profile entry query terms.

Compliance:

mandatory - This method must be implemented.

matchResourceId

void matchResourceId(Id resourceId,
                   boolean match)

Matches the resource identified by the given Id.

Parameters:

resourceId - the Id of the Resource

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery(boolean match)

Gets the resource query.

Parameters:

match - true if a positive match, false for a negative match

Returns:

the ResourceQuery

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

optional - This method must be implemented if supportsResourceQuery() is true.

clearResourceTerms

void clearResourceTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchAgentId

void matchAgentId(Id agentId,
                boolean match)

Matches the agent identified by the given Id.

Parameters:

agentId - the Id of the Agent

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearAgentIdTerms

void clearAgentIdTerms()

Clears the agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAgentQuery

boolean supportsAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentQuery

AgentQuery getAgentQuery(boolean match)

Gets the agent query.

Parameters:

match - true if a positive match, false for a negative match

Returns:

the AgentQuery

Throws:

UnimplementedException - supportsAgentQuery() is false

Compliance:

optional - This method must be implemented if supportsAgentQuery() is true.

clearAgentTerms

void clearAgentTerms()

Clears the agent terms.

Compliance:

mandatory - This method must be implemented.

matchProfileItemId

void matchProfileItemId(Id profileItemId,
                      boolean match)

Matches the profile item identified by the given Id.

Parameters:

profileItemId - the Id of the ProfileItem

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - profileItemId is null

Compliance:

mandatory - This method must be implemented.

clearProfileItemIdTerms

void clearProfileItemIdTerms()

Clears the profile item Id terms.

Compliance:

mandatory - This method must be implemented.

supportsProfileItemQuery

boolean supportsProfileItemQuery()

Tests if a ProfileItemQuery is available.

Returns:

true if a profile item query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProfileItemQuery

ProfileItemQuery getProfileItemQuery(boolean match)

Gets the profile item query.

Parameters:

match - true if a positive match, false for a negative match

Returns:

the FunctinQuery

Throws:

UnimplementedException - supportsProfileItemQuery() is false

Compliance:

optional - This method must be implemented if supportsProfileItemQuery() is true.

clearProfileItemTerms

void clearProfileItemTerms()

Clears the profile item terms.

Compliance:

mandatory - This method must be implemented.

matchProfileId

void matchProfileId(Id profileId,
                  boolean match)

Sets the profile Id for this query.

Parameters:

profileId - a profile Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - profileId is null

Compliance:

mandatory - This method must be implemented.

clearProfileIdTerms

void clearProfileIdTerms()

Clears the profile Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProfileQuery

boolean supportsProfileQuery()

Tests if a ProfileQuery is available.

Returns:

true if a profile query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProfileQuery

ProfileQuery getProfileQuery()

Gets the query interface for a profile. Multiple retrievals produce a nested OR term.

Returns:

the profile query

Throws:

UnimplementedException - supportsProfileQuery() is false

Compliance:

optional - This method must be implemented if supportsProfileQuery() is true.

clearProfileTerms

void clearProfileTerms()

Clears the profile entry query terms.

Compliance:

mandatory - This method must be implemented.

getProfileEntryQueryRecord

ProfileEntryQueryRecord getProfileEntryQueryRecord(Type profileEntryRecordType)
                                                   throws OperationFailedException

Gets the profile entry query record corresponding to the given ProfileEntry record Type. Multiple retrievals produce a nested OR term.

Parameters:

profileEntryRecordType - a profile entry record type

Returns:

the profile entry query record

Throws:

NullArgumentException - profileEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.