public interface RequestNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Request
objects in this Distributor.
This
also includes existing requests that may appear or disappear due to
changes in the Dstributor
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
RequestLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForRequestNotifications()
Tests if this user can register for
Request
notifications. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
registerForChangedRequest(Id requestId)
Registers for notification of an updated request.
|
void |
registerForChangedRequests()
Registers for notification of updated requests.
|
void |
registerForChangedRequestsForQueue(Id queueId)
Register for notifications of updated requests for the given queue
Id. |
void |
registerForChangedRequestsForResource(Id resourceId)
Register for notifications of updated requests for the given resource
Id. |
void |
registerForDeletedRequest(Id requestId)
Registers for notification of a deleted request.
|
void |
registerForDeletedRequests()
Registers for notification of deleted requests.
|
void |
registerForDeletedRequestsForQueue(Id queueId)
Register for notifications of deleted requests for the given queue
Id. |
void |
registerForDeletedRequestsForResource(Id resourceId)
Register for notifications of deleted requests for the given resource
Id. |
void |
registerForNewRequests()
Register for notifications of new requests.
|
void |
registerForNewRequestsForQueue(Id queueId)
Register for notifications of new requests for the given queue
Id. |
void |
registerForNewRequestsForResource(Id resourceId)
Register for notifications of new requests for the given resource
Id. |
void |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForRequestNotifications()
Request
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 useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. void registerForNewRequests() throws OperationFailedException, PermissionDeniedException
RequestReceiver.newRequests()
is invoked when a new
Request
appears in this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRequestsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
RequestReceiver.newRequests()
is
invoked when a new Request
is created.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRequestsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
Id.
RequestReceiver.newRequests()
is invoked
when a new Request
is created.queueId
- the Id
of the queue to monitorNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRequests() throws OperationFailedException, PermissionDeniedException
RequestReceiver.changedRequests()
is invoked when a request in
this distributor is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRequestsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
RequestReceiver.changedRequests()
is
invoked when a Request
in this distributor is changed.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRequestsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
Id.
RequestReceiver.changedRequests()
is
invoked when a Request
in this distributor is changed.queueId
- the Id of the queue to monitorNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
RequestReceiver.changedRequests()
is invoked when the
specified request in this distributor is changed.requestId
- the Id
of the Request
to monitorNullArgumentException
- requestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRequests() throws OperationFailedException, PermissionDeniedException
RequestReceiver.deletedRequests()
is invoked when a request is
deleted or removed from this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRequestsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
RequestReceiver.deletedRequests()
is
invoked when a Request
is deleted or removed from this
distributor.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRequestsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
Id.
RequestReceiver.deletedRequests()
is
invoked when a Request
is deleted or removed from this
distributor.queueId
- the Id of the queue to monitorNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
RequestReceiver.deletedRequests()
is invoked when the
specified request is deleted or removed from this distributor.requestId
- the Id
of the Request
to monitorNullArgumentException
- requestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.