Interface | osid.inquiry.InquiryNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getInquestId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Inquest Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquest | ||
Description |
Gets the | ||
Return | osid.inquiry.Inquest | the inquest | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForInquiryNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedInquestView | ||
Description |
Federates the view for methods in this session. A federated view will include inquiries in inquests which are children of this inquest in the inquest hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedInquestView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this inquest only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableInquiryNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableInquiryNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeInquiryNotification | ||
Description |
Acknowledge an inquiry notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewInquiries | ||
Description |
Register for notifications of new inquiries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewInquiriesForAudit | ||
Description |
Register for notifications of new inquiries for the
given audit | ||
Parameters | osid.id.Id | auditId | the Id of the audit to monitor |
Errors | NULL_ARGUMENT | auditId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedInquiries | ||
Description |
Registers for notification of updated inquiries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedInquiriesForAudit | ||
Description |
Register for notifications of updated inquiries for the
given audit | ||
Parameters | osid.id.Id | auditId | the Id of the audit to monitor |
Errors | NULL_ARGUMENT | auditId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedInquiry | ||
Description |
Registers for notification of an updated inquiry.
| ||
Parameters | osid.id.Id | inquiryId | the Id of the Inquiry to monitor |
Errors | NULL_ARGUMENT | inquiryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInquiries | ||
Description |
Registers for notification of deleted inquiries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInquiriesForAudit | ||
Description |
Register for notifications of deleted inquiries for the
given audit | ||
Parameters | osid.id.Id | auditId | the Id of the audit to monitor |
Errors | NULL_ARGUMENT | auditId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInquiry | ||
Description |
Registers for notification of a deleted inquiry. | ||
Parameters | osid.id.Id | inquiryId | the Id of the Inquiry to monitor |
Errors | NULL_ARGUMENT | inquiryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |