All Superinterfaces:: Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface ActivityQuery extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching activities. Each method match request produces an AND term while multiple invocations of a method produces a nested OR .

Method Summary

Modifier and Type

Method

Description

void

clearAssessmentIdTerms()

Clears the assessment Id terms.

void

clearAssessmentTerms()

Clears the assessment terms.

void

clearAssetIdTerms()

Clears the asset Id terms.

void

clearAssetTerms()

Clears the asset terms.

void

clearCourseIdTerms()

Clears the course Id terms.

void

clearCourseTerms()

Clears the course terms.

void

clearObjectiveBankIdTerms()

Clears the objective bank Id terms.

void

clearObjectiveBankTerms()

Clears the objective bank terms.

void

clearObjectiveIdTerms()

Clears the objective Id terms.

void

clearObjectiveTerms()

Clears the objective terms.

ActivityQueryRecord

getActivityQueryRecord(Type activityRecordType)

Gets the activity query record corresponding to the given Activity record Type .Multiple retrievals produce a nested OR term.

AssessmentQuery

getAssessmentQuery()

Gets the query for an assessment.

AssetQuery

getAssetQuery()

Gets the query for an asset.

CourseQuery

getCourseQuery()

Gets the query for a course.

ObjectiveBankQuery

getObjectiveBankQuery()

Gets the query for an objective bank.

ObjectiveQuery

getObjectiveQuery()

Gets the query for an objective.

void

matchAnyAssessment(boolean match)

Matches an activity that has any assessment assigned.

void

matchAnyAsset(boolean match)

Matches an activity that has any objective assigned.

void

matchAnyCourse(boolean match)

Matches an activity that has any course assigned.

void

matchAssessmentId(Id assessmentId, boolean match)

Sets the assessment Id for this query.

void

matchAssetId(Id assetId, boolean match)

Sets the asset Id for this query.

void

matchCourseId(Id courseId, boolean match)

Sets the course Id for this query.

void

matchObjectiveBankId(Id objectiveBankId, boolean match)

Sets the objective bank Id for this query.

void

matchObjectiveId(Id objectiveId, boolean match)

Sets the objective Id for this query.

boolean

supportsAssessmentQuery()

Tests if an AssessmentQuery is available for querying assessments.

boolean

supportsAssetQuery()

Tests if an AssetQuery is available for querying objectives.

boolean

supportsCourseQuery()

Tests if a CourseQuery is available for querying courses.

boolean

supportsObjectiveBankQuery()

Tests if a ObjectiveBankQuery is available for querying resources.

boolean

supportsObjectiveQuery()

Tests if an ObjectiveQuery is available for querying objectives.

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.

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 for querying objectives.
  
  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} .
- clearObjectiveTerms
  
  void clearObjectiveTerms()
  
  Clears the objective terms.
  
  Compliance:
  mandatory - This method must be implemented.
- matchAssetId
  
  void matchAssetId(Id assetId, boolean match)
  
  Sets the asset Id for this query.
  
  Parameters:
  
  assetId - an asset Id
  
  match - true for a positive match, false for a negative match
  
  Throws:
  
  NullArgumentException - assetId is null
  
  Compliance:
  mandatory - This method must be implemented.
- clearAssetIdTerms
  
  void clearAssetIdTerms()
  
  Clears the asset Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsAssetQuery
  
  boolean supportsAssetQuery()
  
  Tests if an AssetQuery is available for querying objectives.
  
  Returns:
  
  true if an asset query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getAssetQuery
  
  AssetQuery getAssetQuery()
  
  Gets the query for an asset. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  the asset query
  
  Throws:
  
  UnimplementedException - supportsAssetQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsObjectiveQuery()} is {@code true} .
- matchAnyAsset
  
  void matchAnyAsset(boolean match)
  
  Matches an activity that has any objective assigned.
  
  Parameters:
  
  match - true to match activities with any asset, false to match activities with no asset
  
  Compliance:
  mandatory - This method must be implemented.
- clearAssetTerms
  
  void clearAssetTerms()
  
  Clears the asset terms.
  
  Compliance:
  mandatory - This method must be implemented.
- matchCourseId
  
  void matchCourseId(Id courseId, boolean match)
  
  Sets the course Id for this query.
  
  Parameters:
  
  courseId - a course Id
  
  match - true for a positive match, false for a negative match
  
  Throws:
  
  NullArgumentException - courseId is null
  
  Compliance:
  mandatory - This method must be implemented.
- clearCourseIdTerms
  
  void clearCourseIdTerms()
  
  Clears the course Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsCourseQuery
  
  boolean supportsCourseQuery()
  
  Tests if a CourseQuery is available for querying courses.
  
  Returns:
  
  true if a course query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getCourseQuery
  
  CourseQuery getCourseQuery()
  
  Gets the query for a course. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  the course query
  
  Throws:
  
  UnimplementedException - supportsCourseQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsCourseQuery()} is {@code true} .
- matchAnyCourse
  
  void matchAnyCourse(boolean match)
  
  Matches an activity that has any course assigned.
  
  Parameters:
  
  match - true to match activities with any courses, false to match activities with no courses
  
  Compliance:
  mandatory - This method must be implemented.
- clearCourseTerms
  
  void clearCourseTerms()
  
  Clears the course terms.
  
  Compliance:
  mandatory - This method must be implemented.
- matchAssessmentId
  
  void matchAssessmentId(Id assessmentId, boolean match)
  
  Sets the assessment Id for this query.
  
  Parameters:
  
  assessmentId - an assessment Id
  
  match - true for a positive match, false for a negative match
  
  Throws:
  
  NullArgumentException - assessmentId is null
  
  Compliance:
  mandatory - This method must be implemented.
- clearAssessmentIdTerms
  
  void clearAssessmentIdTerms()
  
  Clears the assessment Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsAssessmentQuery
  
  boolean supportsAssessmentQuery()
  
  Tests if an AssessmentQuery is available for querying assessments.
  
  Returns:
  
  true if an assessment query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getAssessmentQuery
  
  AssessmentQuery getAssessmentQuery()
  
  Gets the query for an assessment. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  the assessment query
  
  Throws:
  
  UnimplementedException - supportsAssessmentQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsAssessmentQuery()} is {@code true} .
- matchAnyAssessment
  
  void matchAnyAssessment(boolean match)
  
  Matches an activity that has any assessment assigned.
  
  Parameters:
  
  match - true to match activities with any assessments, false to match activities with no assessments
  
  Compliance:
  mandatory - This method must be implemented.
- clearAssessmentTerms
  
  void clearAssessmentTerms()
  
  Clears the assessment terms.
  
  Compliance:
  mandatory - This method must be implemented.
- matchObjectiveBankId
  
  void matchObjectiveBankId(Id objectiveBankId, boolean match)
  
  Sets the objective bank Id for this query.
  
  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.
- clearObjectiveBankIdTerms
  
  void clearObjectiveBankIdTerms()
  
  Clears the objective bank Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsObjectiveBankQuery
  
  boolean supportsObjectiveBankQuery()
  
  Tests if a ObjectiveBankQuery is available for querying resources.
  
  Returns:
  
  true if an objective bank query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getObjectiveBankQuery
  
  ObjectiveBankQuery getObjectiveBankQuery()
  
  Gets the query for an objective bank. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  the objective bank query
  
  Throws:
  
  UnimplementedException - supportsObjectiveBankQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsObjectiveBankQuery()} is {@code true} .
- clearObjectiveBankTerms
  
  void clearObjectiveBankTerms()
  
  Clears the objective bank terms.
  
  Compliance:
  mandatory - This method must be implemented.
- getActivityQueryRecord
  
  ActivityQueryRecord getActivityQueryRecord(Type activityRecordType) throws OperationFailedException
  
  Gets the activity query record corresponding to the given Activity record Type .Multiple retrievals produce a nested OR term.
  
  Parameters:
  
  activityRecordType - an activity query record type
  
  Returns:
  
  the activity query record
  
  Throws:
  
  NullArgumentException - activityRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(activityRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.

Interface ActivityQuery

Method Summary

Methods inherited from interface Extensible

Methods inherited from interface OsidExtensibleQuery

Methods inherited from interface OsidIdentifiableQuery

Methods inherited from interface OsidObjectQuery

Methods inherited from interface OsidQuery

Method Details

matchObjectiveId

clearObjectiveIdTerms

supportsObjectiveQuery

getObjectiveQuery

clearObjectiveTerms

matchAssetId

clearAssetIdTerms

supportsAssetQuery

getAssetQuery

matchAnyAsset

clearAssetTerms

matchCourseId

clearCourseIdTerms

supportsCourseQuery

getCourseQuery

matchAnyCourse

clearCourseTerms

matchAssessmentId

clearAssessmentIdTerms

supportsAssessmentQuery

getAssessmentQuery

matchAnyAssessment

clearAssessmentTerms

matchObjectiveBankId

clearObjectiveBankIdTerms

supportsObjectiveBankQuery

getObjectiveBankQuery

clearObjectiveBankTerms

getActivityQueryRecord