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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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 {@code supportsObjectiveQuery()} is {@code 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 {@code supportsActivityQuery()} is {@code 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 {@code supportsAncestorCalndarQuery()} is {@code 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 {@code supportsDescendantCalndarQuery()} is {@code 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.