public interface ProjectNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Project
objects. 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.
Notifications are triggered with changes to the Project
object itself. Adding and removing rooms result in notifications available
from the notification session for rooms.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForProjectNotifications()
Tests if this user can register for
Project
notifications. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
void |
registerForChangedProject(Id projectId)
Registers for notification of an updated project.
|
void |
registerForChangedProjects()
Registers for notification of updated projects.
|
void |
registerForChangedProjectsByBuilding(Id buildingId)
Registers for notification of a updated projectsfor a building.
|
void |
registerForDeletedProject(Id projectId)
Registers for notification of a deleted project.
|
void |
registerForDeletedProjects()
Registers for notification of deleted projects.
|
void |
registerForDeletedProjectsByBuilding(Id buildingId)
Registers for notification of a deleted project for a building.
|
void |
registerForNewProjects()
Register for notifications of new projects.
|
void |
registerForNewProjectsByBuilding(Id buildingId)
Registers for notification of new projects for a building.
|
void |
useFederatedCampusView()
Federates the view for methods in this session.
|
void |
useIsolatedCampusView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForProjectNotifications()
Project
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 useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. void registerForNewProjects() throws OperationFailedException, PermissionDeniedException
ProjectReceiver.newProjects()
is invoked when a new
Project
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProjectsByBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
ProjectReceiver.newProjects()
is invoked when a project for
the building is created.buildingId
- the Id
of the Building
to monitorNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProjects() throws OperationFailedException, PermissionDeniedException
ProjectReceiver.changedProjects()
is invoked when a project is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProjectsByBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
ProjectReceiver.changedProjects()
is invoked when a project
for the building is changed.buildingId
- the Id
of the Building
to monitorNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProject(Id projectId) throws OperationFailedException, PermissionDeniedException
ProjectReceiver.changedProjects()
is invoked when the
specified project is changed.projectId
- the Id
of the Project
to monitorNullArgumentException
- projectId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProjects() throws OperationFailedException, PermissionDeniedException
ProjectReceiver.deletedProjects()
is invoked when a project is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProjectsByBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
ProjectReceiver.deletedProjects()
is invoked when a project
for the building is deleted.buildingId
- the Id
of the Building
to monitorNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProject(Id projectId) throws OperationFailedException, PermissionDeniedException
ProjectReceiver.deletedProjects()
is invoked when the
specified project is deleted.projectId
- the Id
of the Project
to monitorNullArgumentException
- projectId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.