org.osid.profile

Interface ProfileQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface ProfileQuery
extends OsidCatalogQuery

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 Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorProfileIdTerms() Clears the ancestor profile Id query terms.
void	clearAncestorProfileTerms() Clears the ancestor profile query terms.
void	clearDescendantProfileIdTerms() Clears the descendant profile Id query terms.
void	clearDescendantProfileTerms() Clears the descendant profile query terms.
void	clearProfileEntryIdTerms() Clears the profile entry Id query terms.
void	clearProfileEntryTerms() Clears the profile entry query terms.
void	clearProfileItemIdTerms() Clears the profile item Id query terms.
void	clearProfileItemTerms() Clears the profile item query terms.
ProfileQuery	getAncestorProfileQuery() Gets the query for a profile.
ProfileQuery	getDescendantProfileQuery() Gets the query for a profile.
ProfileEntryQuery	getProfileEntryQuery() Gets the query for a profile entry.
ProfileItemQuery	getProfileItemQuery() Gets the query for a profile item.
ProfileQueryRecord	getProfileQueryRecord(Type profileRecordType) Gets the profile query record corresponding to the given Profile record Type.
void	matchAncestorProfileId(Id profileId, boolean match) Sets the profile Id for this query to match profiles that have the specified profile as an ancestor.
void	matchAnyAncestorProfile(boolean match) Matches profiles with any ancestor.
void	matchAnyDescendantProfile(boolean match) Matches profiles with any descendant.
void	matchAnyProfileEntry(boolean match) Matches profiles that have any profile entry.
void	matchAnyProfileItem(boolean match) Matches profiles that have any profile item.
void	matchDescendantProfileId(Id profileId, boolean match) Sets the profile Id for this query to match that have the specified profile as a descendant.
void	matchProfileEntryId(Id profileEntryId, boolean match) Sets the profile entry Id for this query.
void	matchProfileItemId(Id profileItemId, boolean match) Sets the profile item Id for this query.
boolean	supportsAncestorProfileQuery() Tests if a ProfileQuery is available.
boolean	supportsDescendantProfileQuery() Tests if a ProfileQuery is available.
boolean	supportsProfileEntryQuery() Tests if a ProfileEntryQuery is available.
boolean	supportsProfileItemQuery() Tests if a ProfileItemQuery is available.

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.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchProfileItemId

void matchProfileItemId(Id profileItemId,
                      boolean match)

Sets the profile item Id for this query.

Parameters:

profileItemId - a profile item Id

match - true for 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 query 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()

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

Returns:

the profile item query

Throws:

UnimplementedException - supportsProfileItemQuery() is false

Compliance:

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

matchAnyProfileItem

void matchAnyProfileItem(boolean match)

Matches profiles that have any profile item.

Parameters:

match - true to match profiles with any item mapping, false to match profiles with no item mapping

Compliance:

mandatory - This method must be implemented.

clearProfileItemTerms

void clearProfileItemTerms()

Clears the profile item query terms.

Compliance:

mandatory - This method must be implemented.

matchProfileEntryId

void matchProfileEntryId(Id profileEntryId,
                       boolean match)

Sets the profile entry Id for this query.

Parameters:

profileEntryId - a profile entry Id

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

Throws:

NullArgumentException - profileEntryId is null

Compliance:

mandatory - This method must be implemented.

clearProfileEntryIdTerms

void clearProfileEntryIdTerms()

Clears the profile entry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryQuery

boolean supportsProfileEntryQuery()

Tests if a ProfileEntryQuery is available.

Returns:

true if a profile entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProfileEntryQuery

ProfileEntryQuery getProfileEntryQuery()

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

Returns:

the profile entry query

Throws:

UnimplementedException - supportsProfileEntryQuery() is false

Compliance:

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

matchAnyProfileEntry

void matchAnyProfileEntry(boolean match)

Matches profiles that have any profile entry.

Parameters:

match - true to match profiles with any entry mapping, false to match profiles with no entry mapping

Compliance:

mandatory - This method must be implemented.

clearProfileEntryTerms

void clearProfileEntryTerms()

Clears the profile entry query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorProfileId

void matchAncestorProfileId(Id profileId,
                          boolean match)

Sets the profile Id for this query to match profiles that have the specified profile as an ancestor.

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.

clearAncestorProfileIdTerms

void clearAncestorProfileIdTerms()

Clears the ancestor profile Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorProfileQuery

boolean supportsAncestorProfileQuery()

Tests if a ProfileQuery is available.

Returns:

true if a profile query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorProfileQuery

ProfileQuery getAncestorProfileQuery()

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

Returns:

the profile query

Throws:

UnimplementedException - supportsAncestorProfileQuery() is false

Compliance:

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

matchAnyAncestorProfile

void matchAnyAncestorProfile(boolean match)

Matches profiles with any ancestor.

Parameters:

match - true to match profile with any ancestor, false to match root profiles

Compliance:

mandatory - This method must be implemented.

clearAncestorProfileTerms

void clearAncestorProfileTerms()

Clears the ancestor profile query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantProfileId

void matchDescendantProfileId(Id profileId,
                            boolean match)

Sets the profile Id for this query to match that have the specified profile as a descendant.

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.

clearDescendantProfileIdTerms

void clearDescendantProfileIdTerms()

Clears the descendant profile Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantProfileQuery

boolean supportsDescendantProfileQuery()

Tests if a ProfileQuery is available.

Returns:

true if a profile query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantProfileQuery

ProfileQuery getDescendantProfileQuery()

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

Returns:

the profile query

Throws:

UnimplementedException - supportsDescendantProfileQuery() is false

Compliance:

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

matchAnyDescendantProfile

void matchAnyDescendantProfile(boolean match)

Matches profiles with any descendant.

Parameters:

match - true to match profile with any descendant, false to match leaf profiles

Compliance:

mandatory - This method must be implemented.

clearDescendantProfileTerms

void clearDescendantProfileTerms()

Clears the descendant profile query terms.

Compliance:

mandatory - This method must be implemented.

getProfileQueryRecord

ProfileQueryRecord getProfileQueryRecord(Type profileRecordType)
                                         throws OperationFailedException

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

Parameters:

profileRecordType - a profile record type

Returns:

the profile query record

Throws:

NullArgumentException - profileRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileRecordType) is false

Compliance:

mandatory - This method must be implemented.