public interface ProfileEntryQuery extends OsidRelationshipQuery
The query for profile entries.
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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchImplicit(boolean match)
match
- true
ito match implicit profile entries,
false
to match implciit profile entriesmandatory
- This method must be implemented. void clearImplicitTerms()
mandatory
- This method must be implemented. void matchRelatedProfileEntryId(Id id, boolean match)
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.id
- Id
to matchmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- id
is
null
mandatory
- This method must be implemented. void clearRelatedProfileEntryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRelatedProfileEntryQuery()
ProfileEntryQuery
is available. true
if a profile entry query is available,
false
otherwisemandatory
- This method must be implemented. ProfileEntryQuery getRelatedProfileEntryQuery()
OR
term.UnimplementedException
-
supportsRelatedProfileEntryQuery()
is false
optional
- This method must be implemented if
supportsRelatedProfileEntryQuery()
is true.
void clearRelatedProfileEntryTerms()
mandatory
- This method must be implemented. void matchResourceId(Id resourceId, boolean match)
Id.
resourceId
- the Id of the Resource
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery(boolean match)
match
- true
if a positive match, false
for a negative match ResourceQuery
UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
mandatory
- This method must be implemented. void matchAgentId(Id agentId, boolean match)
Id.
agentId
- the Id of the Agent
match
- true
if a positive match, false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearAgentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAgentQuery()
AgentQuery
is available. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getAgentQuery(boolean match)
match
- true
if a positive match, false
for a negative match AgentQuery
UnimplementedException
- supportsAgentQuery()
is false
optional
- This method must be implemented if
supportsAgentQuery()
is true.
void clearAgentTerms()
mandatory
- This method must be implemented. void matchProfileItemId(Id profileItemId, boolean match)
Id.
profileItemId
- the Id of the ProfileItem
match
- true
if a positive match, false
for a negative matchNullArgumentException
- profileItemId
is
null
mandatory
- This method must be implemented. void clearProfileItemIdTerms()
Id
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(boolean match)
match
- true
if a positive match, false
for a negative match FunctinQuery
UnimplementedException
-
supportsProfileItemQuery()
is false
optional
- This method must be implemented if
supportsProfileItemQuery()
is true.
void clearProfileItemTerms()
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. ProfileEntryQueryRecord getProfileEntryQueryRecord(Type profileEntryRecordType) throws OperationFailedException
ProfileEntry
record Type.
Multiple retrievals
produce a nested OR
term.profileEntryRecordType
- a profile entry record typeNullArgumentException
- profileEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(profileEntryRecordType)
is false
mandatory
- This method must be implemented.