Interface | osid.offering.ParticipantNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getCatalogueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalogue Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Return | osid.offering.Catalogue | the catalogue | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForParticipantNotifications | ||
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 | useFederatedCatalogueView | ||
Description |
Federates the view for methods in this session. A federated view will include notifications for participants in catalogues which are children of this catalogue in the catalogue hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogueView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewParticipants | ||
Description |
Register for notifications of new participants. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewParticipantsForOffering | ||
Description |
Register for notifications of new participants for an
offering. | ||
Parameters | osid.id.Id | offeringId | an offering to monitor |
Errors | NULL_ARGUMENT | offeringId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewParticipantsForResource | ||
Description |
Register for notifications of new participants for a
resource. | ||
Parameters | osid.id.Id | resourceId | a resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedParticipants | ||
Description |
Registers for notification of updated participants.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedParticipantsForOffering | ||
Description |
Register for notifications of changed participants for
the given offering. | ||
Parameters | osid.id.Id | offeringId | an offering to monitor |
Errors | NULL_ARGUMENT | offeringId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedParticipantsForResource | ||
Description |
Register for notifications of changed participants for
the given resource. | ||
Parameters | osid.id.Id | resourceId | a resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedParticipant | ||
Description |
Registers for notification of an updated participant.
| ||
Parameters | osid.id.Id | participantId | the Id of the Participant to monitor |
Errors | NOT_FOUND | a participant was not found identified by the given Id | |
NULL_ARGUMENT | participantId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedParticipants | ||
Description |
Registers for notification of deleted participants.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedParticipantsForOffering | ||
Description |
Register for notifications of deleted participants for
the given offering. | ||
Parameters | osid.id.Id | offeringId | an offering to monitor |
Errors | NULL_ARGUMENT | offeringId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedParticipantsForResource | ||
Description |
Register for notifications of deleted participants for
the given resource. | ||
Parameters | osid.id.Id | resourceId | a resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedParticipant | ||
Description |
Registers for notification of a deleted participants.
| ||
Parameters | osid.id.Id | participantId | the Id of the Participant to monitor |
Errors | NOT_FOUND | a participant was not found identified by the given Id | |
NULL_ARGUMENT | participantId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |