NotificationInterface (PluginBase 1.5.107 API)

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

NotificationInterfaceAdaptor
```
public interface NotificationInterface
extends PublicInterface
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`closedProgressOnProjectTopic(Long poid, Long topicId)` Called when the progress topic related to a project has been closed
`void`	`closedProgressOnRevisionTopic(Long poid, Long roid, Long topicId)` Called when the progress topic related to a revision is closed
`void`	`closedProgressOnServerTopic(Long topicId)` Called when the progress topic on a server has been closed
`void`	`newExtendedData(Long roid, Long edid)` Called when there is new extended data added to a revision
`void`	`newProgressOnProjectTopic(Long poid, Long topicId)` Called when there is a new progress topic related to a project
`void`	`newProgressOnRevisionTopic(Long poid, Long roid, Long topicId)` Called then there is a new progress topic related to a revision
`void`	`newProgressOnServerTopic(Long topicId)` Called when there is a new progress topic on a server
`void`	`newProgressTopic(Long topicId)` Called when there is a new progress topic
`void`	`newProject(Long poid)` Called when a new project has been added
`void`	`newRevision(Long poid, Long roid)` Called when there is a new revision
`void`	`newUser(Long uoid)` Called when a new user has been added
`void`	`progress(Long topicId, SLongActionState state)` Called when new progress is available on a topic

Method Detail

newRevision

void newRevision(Long poid,
                 Long roid)
          throws UserException,
                 ServerException

Called when there is a new revision

Parameters:: poid - ProjectID; roid - RevisionID
Throws:: UserException; ServerException

newProgressOnProjectTopic

void newProgressOnProjectTopic(Long poid,
                               Long topicId)
                        throws UserException,
                               ServerException

Called when there is a new progress topic related to a project

Parameters:: poid - ProjectID; topicId - The TopicID
Throws:: UserException; ServerException

closedProgressOnProjectTopic

void closedProgressOnProjectTopic(Long poid,
                                  Long topicId)
                           throws UserException,
                                  ServerException

Called when the progress topic related to a project has been closed

Parameters:: poid - ProjectID; topicId - TopicID
Throws:: UserException; ServerException

newProgressOnServerTopic

void newProgressOnServerTopic(Long topicId)
                       throws UserException,
                              ServerException

Called when there is a new progress topic on a server

Parameters:: topicId -
Throws:: UserException; ServerException

closedProgressOnServerTopic

void closedProgressOnServerTopic(Long topicId)
                          throws UserException,
                                 ServerException

Called when the progress topic on a server has been closed

Parameters:: topicId -
Throws:: UserException; ServerException

newProgressOnRevisionTopic

void newProgressOnRevisionTopic(Long poid,
                                Long roid,
                                Long topicId)
                         throws UserException,
                                ServerException

Called then there is a new progress topic related to a revision

Parameters:: poid - ProjectID; roid - RevisionID; topicId - TopicID
Throws:: UserException; ServerException

closedProgressOnRevisionTopic

void closedProgressOnRevisionTopic(Long poid,
                                   Long roid,
                                   Long topicId)
                            throws UserException,
                                   ServerException

Called when the progress topic related to a revision is closed

Parameters:: poid - ProjectID; roid - RevisionID; topicId - TopicID
Throws:: UserException; ServerException

newProgressTopic

void newProgressTopic(Long topicId)
               throws UserException,
                      ServerException

Called when there is a new progress topic

Parameters:: topicId - TopicID
Throws:: UserException; ServerException

newExtendedData

void newExtendedData(Long roid,
                     Long edid)
              throws UserException,
                     ServerException

Called when there is new extended data added to a revision

Parameters:: roid - RevisionID; edid - ExtendedDataID
Throws:: UserException; ServerException

newProject

void newProject(Long poid)
         throws UserException,
                ServerException

Called when a new project has been added

Parameters:: poid - ProjectID
Throws:: UserException; ServerException

newUser
```
void newUser(Long uoid)
      throws UserException,
             ServerException
```
Called when a new user has been added

Parameters:

uoid - UserID

Throws:

UserException

ServerException

progress

void progress(Long topicId,
              SLongActionState state)
       throws UserException,
              ServerException

Called when new progress is available on a topic

Parameters:: topicId - TopicID; state - Details of the progress update
Throws:: UserException; ServerException

Interface NotificationInterface