org.osid.learning

Interface ObjectiveBankQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Method Summary

Methods

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.

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

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

Method Detail

matchObjectiveId

void matchObjectiveId(Id objectiveId,
                    boolean match)

Sets the objective Id for this query.

Parameters:

objectiveId - an objective Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - objectiveId is null

Compliance:

mandatory - This method must be implemented.

clearObjectiveIdTerms

void clearObjectiveIdTerms()

Clears the objective Id terms.

Compliance:

mandatory - This method must be implemented.

supportsObjectiveQuery

boolean supportsObjectiveQuery()

Tests if an ObjectiveQuery is available.

Returns:

true if an objective query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getObjectiveQuery

ObjectiveQuery getObjectiveQuery()

Gets the query for an objective. Multiple retrievals produce a nested OR term.

Returns:

the objective query

Throws:

UnimplementedException - supportsObjectiveQuery() is false

Compliance:

optional - This method must be implemented if supportsObjectiveQuery() is true.

matchAnyObjective

void matchAnyObjective(boolean match)

Matches an objective bank that has any objective assigned.

Parameters:

match - true to match objective banks with any objective, false to match objective banks with no objectives

Compliance:

mandatory - This method must be implemented.

clearObjectiveTerms

void clearObjectiveTerms()

Clears the objective terms.

Compliance:

mandatory - This method must be implemented.

matchActivityId

void matchActivityId(Id activityId,
                   boolean match)

Sets the activity Id for this query.

Parameters:

activityId - an activity Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivityIdTerms

void clearActivityIdTerms()

Clears the activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if a ActivityQuery is available for querying activities.

Returns:

true if an activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

Gets the query for an activity. Multiple retrievals produce a nested OR term.

Returns:

the activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsActivityQuery() is true.

matchAnyActivity

void matchAnyActivity(boolean match)

Matches an objective bank that has any activity assigned.

Parameters:

match - true to match objective banks with any activity, false to match objective banks with no activities

Compliance:

mandatory - This method must be implemented.

clearActivityTerms

void clearActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorObjectiveBankId

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.

Parameters:

objectiveBankId - an objective bank Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - objectiveBankId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorObjectiveBankIdTerms

void clearAncestorObjectiveBankIdTerms()

Clears the ancestor objective bank Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorObjectiveBankQuery

boolean supportsAncestorObjectiveBankQuery()

Tests if a ObjectiveBankQuery is available for querying ancestor objective banks.

Returns:

true if an objective bank query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorObjectiveBankQuery

ObjectiveBankQuery getAncestorObjectiveBankQuery()

Gets the query for an objective bank. Multiple retrievals produce a nested OR term.

Returns:

the objective bank query

Throws:

UnimplementedException - supportsAncestorObjectiveBankQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorCalndarQuery() is true.

matchAnyAncestorObjectiveBank

void matchAnyAncestorObjectiveBank(boolean match)

Matches an objective bank that has any ancestor.

Parameters:

match - true to match objective banks with any ancestor, false to match root objective banks

Compliance:

mandatory - This method must be implemented.

clearAncestorObjectiveBankTerms

void clearAncestorObjectiveBankTerms()

Clears the ancestor objective bank terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantObjectiveBankId

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.

Parameters:

objectiveBankId - an objective bank Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - objectiveBankId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantObjectiveBankIdTerms

void clearDescendantObjectiveBankIdTerms()

Clears the descendant objective bank Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantObjectiveBankQuery

boolean supportsDescendantObjectiveBankQuery()

Tests if a ObjectiveBankQuery is available for querying descendant objective banks.

Returns:

true if an objective bank query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantObjectiveBankQuery

ObjectiveBankQuery getDescendantObjectiveBankQuery()

Gets the query for an objective bank. Multiple retrievals produce a nested OR term.

Returns:

the objective bank query

Throws:

UnimplementedException - supportsDescendantObjectiveBankQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantCalndarQuery() is true.

matchAnyDescendantObjectiveBank

void matchAnyDescendantObjectiveBank(boolean match)

Matches an objective bank that has any descendant.

Parameters:

match - true to match objective banks with any descendant, false to match leaf objective banks

Compliance:

mandatory - This method must be implemented.

clearDescendantObjectiveBankTerms

void clearDescendantObjectiveBankTerms()

Clears the descendant objective bank terms.

Compliance:

mandatory - This method must be implemented.

getObjectiveBankQueryRecord

ObjectiveBankQueryRecord getObjectiveBankQueryRecord(Type objectiveBankRecordType)
                                                     throws OperationFailedException

Gets the objective bank query record corresponding to the given ObjectiveBank record Type. Multiple record retrievals produce a nested OR term.

Parameters:

objectiveBankRecordType - an objective bank record type

Returns:

the objective bank query record

Throws:

NullArgumentException - objectiveBankRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(objectiveBankRecordType) is false

Compliance:

mandatory - This method must be implemented.