public interface ProfileItemQuery extends OsidObjectQuery
This is the query for searching profile items. Each method match
request produces an AND
term while multiple invocations of
a method produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearProfileEntryIdTerms()
Clears the profile entry
Id query terms. |
void |
clearProfileEntryTerms()
Clears the profile entry query terms.
|
void |
clearProfileIdTerms()
Clears the profile
Id query terms. |
void |
clearProfileTerms()
Clears the profile entry query terms.
|
ProfileEntryQuery |
getProfileEntryQuery()
Gets the query for a profile entry.
|
ProfileItemQueryRecord |
getProfileItemQueryRecord(Type profileItemRecordType)
Gets the profile item query record corresponding to the given
ProfileItem record Type. |
ProfileQuery |
getProfileQuery()
Gets the query for a profile.
|
void |
matchAnyProfileEntry(boolean match)
Matches profile items that have any profile entry mapping.
|
void |
matchProfileEntryId(Id profileEntryId,
boolean match)
Sets the pofile entry
Id for this query. |
void |
matchProfileId(Id profileId,
boolean match)
Sets the profile
Id for this query. |
boolean |
supportsProfileEntryQuery()
Tests if an
ProfileEntryQuery is available. |
boolean |
supportsProfileQuery()
Tests if a
ProfileQuery 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
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 items with any entry
mapping, false
to match items with no entry
mappingmandatory
- This method must be implemented. void clearProfileEntryTerms()
mandatory
- This method must be implemented. void matchProfileId(Id profileId, boolean match)
Id
for this query.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 clearProfileIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProfileQuery()
ProfileQuery
is available. true
if a profile query is available,
false
otherwisemandatory
- This method must be implemented. ProfileQuery getProfileQuery()
OR
term.UnimplementedException
- supportsProfileQuery()
is false
optional
- This method must be implemented if
supportsProfileQuery()
is true.
void clearProfileTerms()
mandatory
- This method must be implemented. ProfileItemQueryRecord getProfileItemQueryRecord(Type profileItemRecordType) throws OperationFailedException
ProfileItem
record Type.
Multiple retrievals
produce a nested OR
term.profileItemRecordType
- a profile item record typeNullArgumentException
- profileItemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(profileItemRecordType)
is false
mandatory
- This method must be implemented.