public interface RequisiteNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Requisite
objects in this CourseCatalog.
This also includes existing courses that may appear or disappear due to
changes in the CourseCatalog
hierarchy, This session is
intended for consumers needing to synchronize their state with this
service without the use of polling. Notifications are cancelled when this
session is closed.
The two views defined in this session correspond to the views in the
RequisiteLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRequisiteNotification(Id notificationId)
Acknowledge a requisite notification.
|
boolean |
canRegisterForRequisiteNotifications()
Tests if this user can register for
Requisite
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedAssessmentRequirement(Id assessmentRequirementId)
Registers for notification of an updated assessment requirement.
|
void |
registerForChangedAssessmentRequirements()
Registers for notification of updated assessment requirements.
|
void |
registerForChangedAwardRequirement(Id awardRequirementId)
Registers for notification of an updated award requirement.
|
void |
registerForChangedAwardRequirements()
Registers for notification of updated award requirements.
|
void |
registerForChangedCourseRequirement(Id courseRequirementId)
Registers for notification of an updated course requirement.
|
void |
registerForChangedCourseRequirements()
Registers for notification of updated course requirements.
|
void |
registerForChangedCredentialRequirement(Id credentialRequirementId)
Registers for notification of an updated credential requirement.
|
void |
registerForChangedCredentialRequirements()
Registers for notification of updated credential requirements.
|
void |
registerForChangedLearningObjectiveRequirement(Id learningObjectiveRequirementId)
Registers for notification of an updated learning objective
requirement.
|
void |
registerForChangedLearningObjectiveRequirements()
Registers for notification of updated learning objective requirements.
|
void |
registerForChangedProgramRequirement(Id programRequirementId)
Registers for notification of an updated program requirement.
|
void |
registerForChangedProgramRequirements()
Registers for notification of updated program requirements.
|
void |
registerForChangedRequisite(Id requisiteId)
Registers for notification of an updated requisite.
|
void |
registerForChangedRequisites()
Registers for notification of updated requisites.
|
void |
registerForDeletedAssessmentRequirement(Id assessmentRequirementId)
Registers for notification of a deleted assessment requirement.
|
void |
registerForDeletedAssessmentRequirements()
Registers for notification of deleted assessment requirements.
|
void |
registerForDeletedAwardRequirement(Id awardRequirementId)
Registers for notification of a deleted award requirement.
|
void |
registerForDeletedAwardRequirements()
Registers for notification of deleted award requirements.
|
void |
registerForDeletedCourseRequirement(Id courseRequirementId)
Registers for notification of a deleted course requirement.
|
void |
registerForDeletedCourseRequirements()
Registers for notification of deleted course requirements.
|
void |
registerForDeletedCredentialRequirement(Id credentialRequirementId)
Registers for notification of a deleted credential requirement.
|
void |
registerForDeletedCredentialRequirements()
Registers for notification of deleted credential requirements.
|
void |
registerForDeletedLearningObjectiveRequirement(Id learningObjectiveRequirementId)
Registers for notification of a deleted learning objective
requirement.
|
void |
registerForDeletedLearningObjectiveRequirements()
Registers for notification of deleted learning objective requirements.
|
void |
registerForDeletedProgramRequirement(Id programRequirementId)
Registers for notification of a deleted program requirement.
|
void |
registerForDeletedProgramRequirements()
Registers for notification of deleted program requirements.
|
void |
registerForDeletedRequisite(Id requisiteId)
Registers for notification of a deleted requisite.
|
void |
registerForDeletedRequisites()
Registers for notification of deleted requisites.
|
void |
registerForNewAssessmentRequirements()
Register for notifications of new assessment requirements.
|
void |
registerForNewAwardRequirements()
Register for notifications of new award requirements.
|
void |
registerForNewCourseRequirements()
Register for notifications of new course requirements.
|
void |
registerForNewCredentialRequirements()
Register for notifications of new credential requirements.
|
void |
registerForNewLearningObjectiveRequirements()
Register for notifications of new learning objective requirements.
|
void |
registerForNewProgramRequirements()
Register for notifications of new program requirements.
|
void |
registerForNewRequisites()
Register for notifications of new requisites.
|
void |
reliableRequisiteNotifications()
Reliable notifications are desired.
|
void |
unreliableRequisiteNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForRequisiteNotifications()
Requisite
notifications. A return of true does not guarantee successful
authorization. A return of false indicates that it is known all
methods in this session will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void reliableRequisiteNotifications()
acknowledgeRequisiteNotification()
.mandatory
- This method is must be implemented. void unreliableRequisiteNotifications()
mandatory
- This method is must be implemented. void acknowledgeRequisiteNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRequisites() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.newRequisites()
is invoked when a new
Requisite
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRequisites() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedRequisites()
is invoked when a
requisite in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedRequisites()
is invoked when the
specified requisite in this course catalog is changed.requisiteId
- the Id
of the Requisite
to monitorNullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRequisites() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedRequisites()
is invoked when a
requisite is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedRequisites()
is invoked when the
specified requisite is deleted or removed from this course catalog.requisiteId
- the Id
of the Requisite
to monitorNullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCourseRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.newCourseRequirements()
is invoked when a
new CourseRequirement
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedCourseRequirements()
is invoked when
a course requirement in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseRequirement(Id courseRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedCourseRequirements()
is invoked when
the specified course requirement in this course catalog is changed.courseRequirementId
- the Id
of the
CourseRequirement
to monitorNullArgumentException
- courseRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedCourseRequirements()
is invoked when
a course requirement is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseRequirement(Id courseRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedCourseRequirements()
is invoked when
the specified course requirement is deleted or removed from this
course catalog.courseRequirementId
- the Id
of the
CourseRequirement
to monitorNullArgumentException
- courseRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProgramRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.newProgramRequirements()
is invoked when a
new ProgramRequirement
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProgramRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedProgramRequirements()
is invoked when
a program requirement in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProgramRequirement(Id programRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedProgramRequirements()
is invoked when
the specified program requirement in this course catalog is changed.programRequirementId
- the Id
of the
ProgramRequirement
to monitorNullArgumentException
- programRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProgramRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedProgramRequirements()
is invoked when
a program requirement is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProgramRequirement(Id programRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedProgramRequirements()
is invoked when
the specified program requirement is deleted or removed from this
course catalog.programRequirementId
- the Id
of the
ProgramRequirement
to monitorNullArgumentException
- programRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCredentialRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.newCredentialRequirements()
is invoked when
a new CredentialRequirement
appears in this course
catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCredentialRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedCredentialRequirements()
is invoked
when a credential requirement in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCredentialRequirement(Id credentialRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedCredentialRequirements()
is
invoked when the specified credential requirement in this course
catalog is changed.credentialRequirementId
- the Id
of the
CredentialRequirement
to monitorNullArgumentException
- credentialRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCredentialRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedCredentialRequirements()
is invoked
when a credential requirement is deleted or removed from this course
catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCredentialRequirement(Id credentialRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedCredentialRequirements()
is invoked
when the specified credential requirement is deleted or removed from
this course catalog.credentialRequirementId
- the Id
of the
CredentialRequirement
to monitorNullArgumentException
- credentialRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewLearningObjectiveRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.newLearningObjectiveRequirements()
is
invoked when a new LearningObjectiveRequirement
appears
in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLearningObjectiveRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedLearningObjectiveRequirements()
is invoked when a learning objective requirement in this
course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLearningObjectiveRequirement(Id learningObjectiveRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedLearningObjectiveRequirements()
is
invoked when the specified learning objective requirement in this
course catalog is changed.learningObjectiveRequirementId
- the Id
of the
LearningObjectiveRequirement
to monitorNullArgumentException
-
learningObjectiveRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLearningObjectiveRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedLearningObjectiveRequirements()
is invoked when a learning objective requirement is deleted or
removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLearningObjectiveRequirement(Id learningObjectiveRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedLearningObjectiveRequirements()
is
invoked when the specified learning objective requirement is deleted
or removed from this course catalog.learningObjectiveRequirementId
- the Id
of the
LearningObjectiveRequirement
to monitorNullArgumentException
-
learningObjectiveRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAssessmentRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.newAssessmentRequirements()
is invoked when
a new AssessmentRequirement
appears in this course
catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedAssessmentRequirements()
is invoked
when an assessment requirement in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentRequirement(Id assessmentRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedAssessmentRequirements()
is
invoked when the specified assessment requirement in this course
catalog is changed.assessmentRequirementId
- the Id
of the
AssessmentRequirement
to monitorNullArgumentException
- assessmentRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedAssessmentRequirements()
is invoked
when an assessment requirement is deleted or removed from this course
catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentRequirement(Id assessmentRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedAssessmentRequirements()
is invoked
when the specified assessment requirement is deleted or removed from
this course catalog.assessmentRequirementId
- the Id
of the
AssessmentRequirement
to monitorNullArgumentException
- assessmentRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAwardRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.newAwardRequirements()
is invoked when a new
AwardRequirement
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAwardRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedAwardRequirements()
is invoked when
an award requirement in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAwardRequirement(Id awardRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.changedAwardRequirements()
is invoked when
the specified award requirement in this course catalog is changed.awardRequirementId
- the Id
of the
AwardRequirement
to monitorNullArgumentException
- awardRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAwardRequirements() throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedAwardRequirements()
is invoked when
an award requirement is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAwardRequirement(Id awardRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteReceiver.deletedAwardRequirements()
is invoked when
the specified award requirement is deleted or removed from this course
catalog.awardRequirementId
- the Id
of the
AwardRequirement
to monitorNullArgumentException
- awardRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.