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.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchProfileItemId(Id profileItemId, boolean match)
Id
for this query.profileItemId
- a profile item Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- profileItemId
is
null
mandatory
- This method must be implemented. void clearProfileItemIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProfileItemQuery()
ProfileItemQuery
is available. true
if a profile item query is available,
false
otherwisemandatory
- This method must be implemented. ProfileItemQuery getProfileItemQuery()
OR
term.UnimplementedException
-
supportsProfileItemQuery()
is false
optional
- This method must be implemented if
supportsProfileItemQuery()
is true.
void matchAnyProfileItem(boolean match)
match
- true
to match profiles with any item
mapping, false
to match profiles with no item
mappingmandatory
- This method must be implemented. void clearProfileItemTerms()
mandatory
- This method must be implemented. void matchProfileEntryId(Id profileEntryId, boolean match)
Id
for this query.profileEntryId
- a profile entry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- profileEntryId
is null
mandatory
- This method must be implemented. void clearProfileEntryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProfileEntryQuery()
ProfileEntryQuery
is available. true
if a profile entry query is available,
false
otherwisemandatory
- This method must be implemented. ProfileEntryQuery getProfileEntryQuery()
OR
term.UnimplementedException
-
supportsProfileEntryQuery()
is false
optional
- This method must be implemented if
supportsProfileEntryQuery()
is true.
void matchAnyProfileEntry(boolean match)
match
- true
to match profiles with any entry
mapping, false
to match profiles with no entry
mappingmandatory
- This method must be implemented. void clearProfileEntryTerms()
mandatory
- This method must be implemented. void matchAncestorProfileId(Id profileId, boolean match)
Id
for this query to match profiles
that have the specified profile as an ancestor.profileId
- a profile Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- profileId
is
null
mandatory
- This method must be implemented. void clearAncestorProfileIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorProfileQuery()
ProfileQuery
is available. true
if a profile query is available,
false
otherwisemandatory
- This method must be implemented. ProfileQuery getAncestorProfileQuery()
OR
term.UnimplementedException
-
supportsAncestorProfileQuery()
is false
optional
- This method must be implemented if
supportsAncestorProfileQuery()
is true.
void matchAnyAncestorProfile(boolean match)
match
- true
to match profile with any ancestor,
false
to match root profilesmandatory
- This method must be implemented. void clearAncestorProfileTerms()
mandatory
- This method must be implemented. void matchDescendantProfileId(Id profileId, boolean match)
Id
for this query to match that have
the specified profile as a descendant.profileId
- a profile Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- profileId
is
null
mandatory
- This method must be implemented. void clearDescendantProfileIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantProfileQuery()
ProfileQuery
is available. true
if a profile query is available,
false
otherwisemandatory
- This method must be implemented. ProfileQuery getDescendantProfileQuery()
OR
term.UnimplementedException
-
supportsDescendantProfileQuery()
is false
optional
- This method must be implemented if
supportsDescendantProfileQuery()
is true.
void matchAnyDescendantProfile(boolean match)
match
- true
to match profile with any
descendant, false
to match leaf profilesmandatory
- This method must be implemented. void clearDescendantProfileTerms()
mandatory
- This method must be implemented. ProfileQueryRecord getProfileQueryRecord(Type profileRecordType) throws OperationFailedException
Profile
record Type.
Multiple record retrievals
produce a nested OR
term.profileRecordType
- a profile record typeNullArgumentException
- profileRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(profileRecordType)
is false
mandatory
- This method must be implemented.