public interface ActivityRegistrationQuery extends OsidRelationshipQuery
This is the query for searching activity registrations. Each method
match 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 |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearRegistrationIdTerms()
Clears the registration
Id terms. |
void |
clearRegistrationTerms()
Clears the registration terms.
|
void |
clearStudentIdTerms()
Clears the student resource
Id terms. |
void |
clearStudentTerms()
Clears the student resource terms.
|
ActivityQuery |
getActivityQuery()
Gets the query for an activity.
|
ActivityRegistrationQueryRecord |
getActivityRegistrationQueryRecord(Type activityRegistrationRecordType)
Gets the activity registration query record corresponding to the given
Course record Type. |
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
RegistrationQuery |
getRegistrationQuery()
Gets the query for a registration.
|
ResourceQuery |
getStudentQuery()
Gets the query for a student.
|
void |
matchActivityId(Id activityId,
boolean match)
Sets the activity
Id for this query. |
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query. |
void |
matchRegistrationId(Id registrationId,
boolean match)
Sets the registration
Id for this query. |
void |
matchStudentId(Id resourceId,
boolean match)
Sets the student resource
Id for this query. |
boolean |
supportsActivityQuery()
Tests if an
ActivityQuery is available. |
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsRegistrationQuery()
Tests if a
RegistrationQuery is available. |
boolean |
supportsStudentQuery()
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 matchRegistrationId(Id registrationId, boolean match)
Id
for this query.registrationId
- a registration Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- registrationId
is null
mandatory
- This method must be implemented. void clearRegistrationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRegistrationQuery()
RegistrationQuery
is available. true
if a registration query is available,
false
otherwisemandatory
- This method must be implemented. RegistrationQuery getRegistrationQuery()
OR
term.UnimplementedException
-
supportsRegistrationQuery()
is false
optional
- This method must be implemented if
supportsRegistrationQuery()
is true.
void clearRegistrationTerms()
mandatory
- This method must be implemented. void matchActivityId(Id activityId, boolean match)
Id
for this query.activityId
- an activity Id
match
- true
if 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. 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 clearActivityTerms()
mandatory
- This method must be implemented. void matchStudentId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearStudentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsStudentQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getStudentQuery()
OR
term.UnimplementedException
- supportsStudentQuery()
is false
optional
- This method must be implemented if
supportsStudentQuery()
is true.
void clearStudentTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query.courseCatalogId
- the course catalog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. void clearCourseCatalogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseCatalogQuery()
CourseCatalogQuery
is available. true
if a course catalog query is available,
false
otherwisemandatory
- This method must be implemented. CourseCatalogQuery getCourseCatalogQuery()
OR
term.UnimplementedException
-
supportsCourseCatalogQuery()
is false
optional
- This method must be implemented if
supportsCourseCatalogQuery()
is true.
void clearCourseCatalogTerms()
mandatory
- This method must be implemented. ActivityRegistrationQueryRecord getActivityRegistrationQueryRecord(Type activityRegistrationRecordType) throws OperationFailedException
Course
record Type.
Multiple record
retrievals produce a nested OR
term.activityRegistrationRecordType
- an activity registration record
typeNullArgumentException
-
activityRegistrationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRegistrationRecordType)
is
false
mandatory
- This method must be implemented.