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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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 {@code supportsProfileItemQuery()} is {@code 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 {@code supportsProfileEntryQuery()} is {@code 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 {@code supportsAncestorProfileQuery()} is {@code 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 {@code supportsDescendantProfileQuery()} is {@code 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.