public interface ObjectiveBankQuery extends OsidCatalogQuery
This is the query for searching objective banks. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearActivityIdTerms()
Clears the activity
Id terms. |
void |
clearActivityTerms()
Clears the activity terms.
|
void |
clearAncestorObjectiveBankIdTerms()
Clears the ancestor objective bank
Id terms. |
void |
clearAncestorObjectiveBankTerms()
Clears the ancestor objective bank terms.
|
void |
clearDescendantObjectiveBankIdTerms()
Clears the descendant objective bank
Id terms. |
void |
clearDescendantObjectiveBankTerms()
Clears the descendant objective bank terms.
|
void |
clearObjectiveIdTerms()
Clears the objective
Id terms. |
void |
clearObjectiveTerms()
Clears the objective terms.
|
ActivityQuery |
getActivityQuery()
Gets the query for an activity.
|
ObjectiveBankQuery |
getAncestorObjectiveBankQuery()
Gets the query for an objective bank.
|
ObjectiveBankQuery |
getDescendantObjectiveBankQuery()
Gets the query for an objective bank.
|
ObjectiveBankQueryRecord |
getObjectiveBankQueryRecord(Type objectiveBankRecordType)
Gets the objective bank query record corresponding to the given
ObjectiveBank record Type. |
ObjectiveQuery |
getObjectiveQuery()
Gets the query for an objective.
|
void |
matchActivityId(Id activityId,
boolean match)
Sets the activity
Id for this query. |
void |
matchAncestorObjectiveBankId(Id objectiveBankId,
boolean match)
Sets the objective bank
Id for this query to match
objective banks that have the specified objective bank as an ancestor. |
void |
matchAnyActivity(boolean match)
Matches an objective bank that has any activity assigned.
|
void |
matchAnyAncestorObjectiveBank(boolean match)
Matches an objective bank that has any ancestor.
|
void |
matchAnyDescendantObjectiveBank(boolean match)
Matches an objective bank that has any descendant.
|
void |
matchAnyObjective(boolean match)
Matches an objective bank that has any objective assigned.
|
void |
matchDescendantObjectiveBankId(Id objectiveBankId,
boolean match)
Sets the objective bank
Id for this query to match
objective banks that have the specified objective bank as a
descendant. |
void |
matchObjectiveId(Id objectiveId,
boolean match)
Sets the objective
Id for this query. |
boolean |
supportsActivityQuery()
Tests if a
ActivityQuery is available for querying
activities. |
boolean |
supportsAncestorObjectiveBankQuery()
Tests if a
ObjectiveBankQuery is available for querying
ancestor objective banks. |
boolean |
supportsDescendantObjectiveBankQuery()
Tests if a
ObjectiveBankQuery is available for querying
descendant objective banks. |
boolean |
supportsObjectiveQuery()
Tests if an
ObjectiveQuery 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 matchObjectiveId(Id objectiveId, boolean match)
Id
for this query.objectiveId
- an objective Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectiveId
is
null
mandatory
- This method must be implemented. void clearObjectiveIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsObjectiveQuery()
ObjectiveQuery
is available. true
if an objective query is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveQuery getObjectiveQuery()
OR
term.UnimplementedException
-
supportsObjectiveQuery()
is false
optional
- This method must be implemented if
supportsObjectiveQuery()
is true.
void matchAnyObjective(boolean match)
match
- true
to match objective banks with any
objective, false
to match objective banks with
no objectivesmandatory
- This method must be implemented. void clearObjectiveTerms()
mandatory
- This method must be implemented. void matchActivityId(Id activityId, boolean match)
Id
for this query.activityId
- an activity Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- activityId
is
null
mandatory
- This method must be implemented. void clearActivityIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsActivityQuery()
ActivityQuery
is available for querying
activities. true
if an activity query is available,
false
otherwisemandatory
- This method must be implemented. ActivityQuery getActivityQuery()
OR
term.UnimplementedException
- supportsActivityQuery()
is false
optional
- This method must be implemented if
supportsActivityQuery()
is true.
void matchAnyActivity(boolean match)
match
- true
to match objective banks with any
activity, false
to match objective banks with
no activitiesmandatory
- This method must be implemented. void clearActivityTerms()
mandatory
- This method must be implemented. void matchAncestorObjectiveBankId(Id objectiveBankId, boolean match)
Id
for this query to match
objective banks that have the specified objective bank as an ancestor.objectiveBankId
- an objective bank Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectiveBankId
is null
mandatory
- This method must be implemented. void clearAncestorObjectiveBankIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorObjectiveBankQuery()
ObjectiveBankQuery
is available for querying
ancestor objective banks. true
if an objective bank query is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveBankQuery getAncestorObjectiveBankQuery()
OR
term.UnimplementedException
-
supportsAncestorObjectiveBankQuery()
is false
optional
- This method must be implemented if
supportsAncestorCalndarQuery()
is true.
void matchAnyAncestorObjectiveBank(boolean match)
match
- true
to match objective banks with any
ancestor, false
to match root objective banksmandatory
- This method must be implemented. void clearAncestorObjectiveBankTerms()
mandatory
- This method must be implemented. void matchDescendantObjectiveBankId(Id objectiveBankId, boolean match)
Id
for this query to match
objective banks that have the specified objective bank as a
descendant.objectiveBankId
- an objective bank Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectiveBankId
is null
mandatory
- This method must be implemented. void clearDescendantObjectiveBankIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantObjectiveBankQuery()
ObjectiveBankQuery
is available for querying
descendant objective banks. true
if an objective bank query is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveBankQuery getDescendantObjectiveBankQuery()
OR
term.UnimplementedException
-
supportsDescendantObjectiveBankQuery()
is false
optional
- This method must be implemented if
supportsDescendantCalndarQuery()
is true.
void matchAnyDescendantObjectiveBank(boolean match)
match
- true
to match objective banks with any
descendant, false
to match leaf objective banksmandatory
- This method must be implemented. void clearDescendantObjectiveBankTerms()
mandatory
- This method must be implemented. ObjectiveBankQueryRecord getObjectiveBankQueryRecord(Type objectiveBankRecordType) throws OperationFailedException
ObjectiveBank
record Type.
Multiple record
retrievals produce a nested OR
term.objectiveBankRecordType
- an objective bank record typeNullArgumentException
- objectiveBankRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(objectiveBankRecordType)
is false
mandatory
- This method must be implemented.