org.osid.course.requisite

Interface RequisiteNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForRequisiteNotifications

boolean canRegisterForRequisiteNotifications()

Tests if this user can register for 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include requisites in catalogs which are children of this catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

reliableRequisiteNotifications

void reliableRequisiteNotifications()

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeRequisiteNotification() .

Compliance:

mandatory - This method is must be implemented.

unreliableRequisiteNotifications

void unreliableRequisiteNotifications()

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliance:

mandatory - This method is must be implemented.

acknowledgeRequisiteNotification

void acknowledgeRequisiteNotification(Id notificationId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Acknowledge a requisite notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewRequisites

void registerForNewRequisites()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new requisites. RequisiteReceiver.newRequisites() is invoked when a new Requisite appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRequisites

void registerForChangedRequisites()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated requisites. RequisiteReceiver.changedRequisites() is invoked when a requisite in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRequisite

void registerForChangedRequisite(Id requisiteId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated requisite. RequisiteReceiver.changedRequisites() is invoked when the specified requisite in this course catalog is changed.

Parameters:

requisiteId - the Id of the Requisite to monitor

Throws:

NullArgumentException - requisiteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRequisites

void registerForDeletedRequisites()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deleted requisites. RequisiteReceiver.deletedRequisites() is invoked when a requisite is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRequisite

void registerForDeletedRequisite(Id requisiteId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted requisite. RequisiteReceiver.deletedRequisites() is invoked when the specified requisite is deleted or removed from this course catalog.

Parameters:

requisiteId - the Id of the Requisite to monitor

Throws:

NullArgumentException - requisiteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewCourseRequirements

void registerForNewCourseRequirements()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of new course requirements. RequisiteReceiver.newCourseRequirements() is invoked when a new CourseRequirement appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCourseRequirements

void registerForChangedCourseRequirements()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of updated course requirements. RequisiteReceiver.changedCourseRequirements() is invoked when a course requirement in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCourseRequirement

void registerForChangedCourseRequirement(Id courseRequirementId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of an updated course requirement. RequisiteReceiver.changedCourseRequirements() is invoked when the specified course requirement in this course catalog is changed.

Parameters:

courseRequirementId - the Id of the CourseRequirement to monitor

Throws:

NullArgumentException - courseRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCourseRequirements

void registerForDeletedCourseRequirements()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of deleted course requirements. RequisiteReceiver.deletedCourseRequirements() is invoked when a course requirement is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCourseRequirement

void registerForDeletedCourseRequirement(Id courseRequirementId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of a deleted course requirement. RequisiteReceiver.deletedCourseRequirements() is invoked when the specified course requirement is deleted or removed from this course catalog.

Parameters:

courseRequirementId - the Id of the CourseRequirement to monitor

Throws:

NullArgumentException - courseRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewProgramRequirements

void registerForNewProgramRequirements()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Register for notifications of new program requirements. RequisiteReceiver.newProgramRequirements() is invoked when a new ProgramRequirement appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedProgramRequirements

void registerForChangedProgramRequirements()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification of updated program requirements. RequisiteReceiver.changedProgramRequirements() is invoked when a program requirement in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedProgramRequirement

void registerForChangedProgramRequirement(Id programRequirementId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of an updated program requirement. RequisiteReceiver.changedProgramRequirements() is invoked when the specified program requirement in this course catalog is changed.

Parameters:

programRequirementId - the Id of the ProgramRequirement to monitor

Throws:

NullArgumentException - programRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedProgramRequirements

void registerForDeletedProgramRequirements()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification of deleted program requirements. RequisiteReceiver.deletedProgramRequirements() is invoked when a program requirement is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedProgramRequirement

void registerForDeletedProgramRequirement(Id programRequirementId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of a deleted program requirement. RequisiteReceiver.deletedProgramRequirements() is invoked when the specified program requirement is deleted or removed from this course catalog.

Parameters:

programRequirementId - the Id of the ProgramRequirement to monitor

Throws:

NullArgumentException - programRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewCredentialRequirements

void registerForNewCredentialRequirements()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of new credential requirements. RequisiteReceiver.newCredentialRequirements() is invoked when a new CredentialRequirement appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCredentialRequirements

void registerForChangedCredentialRequirements()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of updated credential requirements. RequisiteReceiver.changedCredentialRequirements() is invoked when a credential requirement in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCredentialRequirement

void registerForChangedCredentialRequirement(Id credentialRequirementId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of an updated credential requirement. RequisiteReceiver.changedCredentialRequirements() is invoked when the specified credential requirement in this course catalog is changed.

Parameters:

credentialRequirementId - the Id of the CredentialRequirement to monitor

Throws:

NullArgumentException - credentialRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCredentialRequirements

void registerForDeletedCredentialRequirements()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of deleted credential requirements. RequisiteReceiver.deletedCredentialRequirements() is invoked when a credential requirement is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCredentialRequirement

void registerForDeletedCredentialRequirement(Id credentialRequirementId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of a deleted credential requirement. RequisiteReceiver.deletedCredentialRequirements() is invoked when the specified credential requirement is deleted or removed from this course catalog.

Parameters:

credentialRequirementId - the Id of the CredentialRequirement to monitor

Throws:

NullArgumentException - credentialRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewLearningObjectiveRequirements

void registerForNewLearningObjectiveRequirements()
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Register for notifications of new learning objective requirements. RequisiteReceiver.newLearningObjectiveRequirements() is invoked when a new LearningObjectiveRequirement appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLearningObjectiveRequirements

void registerForChangedLearningObjectiveRequirements()
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Registers for notification of updated learning objective requirements. RequisiteReceiver.changedLearningObjectiveRequirements() is invoked when a learning objective requirement in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLearningObjectiveRequirement

void registerForChangedLearningObjectiveRequirement(Id learningObjectiveRequirementId)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Registers for notification of an updated learning objective requirement. RequisiteReceiver.changedLearningObjectiveRequirements() is invoked when the specified learning objective requirement in this course catalog is changed.

Parameters:

learningObjectiveRequirementId - the Id of the LearningObjectiveRequirement to monitor

Throws:

NullArgumentException - learningObjectiveRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLearningObjectiveRequirements

void registerForDeletedLearningObjectiveRequirements()
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Registers for notification of deleted learning objective requirements. RequisiteReceiver.deletedLearningObjectiveRequirements() is invoked when a learning objective requirement is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLearningObjectiveRequirement

void registerForDeletedLearningObjectiveRequirement(Id learningObjectiveRequirementId)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Registers for notification of a deleted learning objective requirement. RequisiteReceiver.deletedLearningObjectiveRequirements() is invoked when the specified learning objective requirement is deleted or removed from this course catalog.

Parameters:

learningObjectiveRequirementId - the Id of the LearningObjectiveRequirement to monitor

Throws:

NullArgumentException - learningObjectiveRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewAssessmentRequirements

void registerForNewAssessmentRequirements()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of new assessment requirements. RequisiteReceiver.newAssessmentRequirements() is invoked when a new AssessmentRequirement appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAssessmentRequirements

void registerForChangedAssessmentRequirements()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of updated assessment requirements. RequisiteReceiver.changedAssessmentRequirements() is invoked when an assessment requirement in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAssessmentRequirement

void registerForChangedAssessmentRequirement(Id assessmentRequirementId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of an updated assessment requirement. RequisiteReceiver.changedAssessmentRequirements() is invoked when the specified assessment requirement in this course catalog is changed.

Parameters:

assessmentRequirementId - the Id of the AssessmentRequirement to monitor

Throws:

NullArgumentException - assessmentRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAssessmentRequirements

void registerForDeletedAssessmentRequirements()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of deleted assessment requirements. RequisiteReceiver.deletedAssessmentRequirements() is invoked when an assessment requirement is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAssessmentRequirement

void registerForDeletedAssessmentRequirement(Id assessmentRequirementId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of a deleted assessment requirement. RequisiteReceiver.deletedAssessmentRequirements() is invoked when the specified assessment requirement is deleted or removed from this course catalog.

Parameters:

assessmentRequirementId - the Id of the AssessmentRequirement to monitor

Throws:

NullArgumentException - assessmentRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewAwardRequirements

void registerForNewAwardRequirements()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Register for notifications of new award requirements. RequisiteReceiver.newAwardRequirements() is invoked when a new AwardRequirement appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAwardRequirements

void registerForChangedAwardRequirements()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of updated award requirements. RequisiteReceiver.changedAwardRequirements() is invoked when an award requirement in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAwardRequirement

void registerForChangedAwardRequirement(Id awardRequirementId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of an updated award requirement. RequisiteReceiver.changedAwardRequirements() is invoked when the specified award requirement in this course catalog is changed.

Parameters:

awardRequirementId - the Id of the AwardRequirement to monitor

Throws:

NullArgumentException - awardRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAwardRequirements

void registerForDeletedAwardRequirements()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of deleted award requirements. RequisiteReceiver.deletedAwardRequirements() is invoked when an award requirement is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAwardRequirement

void registerForDeletedAwardRequirement(Id awardRequirementId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of a deleted award requirement. RequisiteReceiver.deletedAwardRequirements() is invoked when the specified award requirement is deleted or removed from this course catalog.

Parameters:

awardRequirementId - the Id of the AwardRequirement to monitor

Throws:

NullArgumentException - awardRequirementId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.