org.bimserver.shared.interfaces.bimsie1

Interface Bimsie1NotificationRegistryInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

Bimsie1NotificationRegistryInterfaceAdaptor

public interface Bimsie1NotificationRegistryInterface
extends PublicInterface

Method Summary

Modifier and Type	Method and Description
SLongActionState	getProgress(Long topicId)
List<Long>	getProgressTopicsOnProject(Long poid)
List<Long>	getProgressTopicsOnRevision(Long poid, Long roid)
List<Long>	getProgressTopicsOnServer()
void	registerChangeProgressOnProject(Long endPointId, Long poid)
void	registerChangeProgressOnRevision(Long endPointId, Long roid, Long poid)
void	registerChangeProgressOnServer(Long endPointId)
void	registerNewExtendedDataOnRevisionHandler(Long endPointId, Long roid) Register the given endpoint to be notified about extended data being added to the given revision
void	registerNewProjectHandler(Long endPointId) Register this endpoint to be notified when a project has been added
void	registerNewRevisionHandler(Long endPointId) Register the given endpoint to be notified about new revisions
void	registerNewRevisionOnSpecificProjectHandler(Long endPointId, Long poid) Register the given endpoint to be notified about new revisions on the given project
void	registerNewUserHandler(Long endPointId) Register this endpoint to be notified when a new user has been added
void	registerProgressHandler(Long topicId, Long endPointId)
Long	registerProgressOnProjectTopic(SProgressTopicType type, Long poid, String description) Register a new progress topic that is related to the given project
Long	registerProgressOnRevisionTopic(SProgressTopicType type, Long poid, Long roid, String description)
Long	registerProgressTopic(SProgressTopicType type, String description) Register a progress topic, remember to unregister with unregisterProgressTopic when done
void	unregisterChangeProgressOnProject(Long endPointId, Long poid)
void	unregisterChangeProgressOnRevision(Long endPointId, Long roid, Long poid)
void	unregisterChangeProgressOnServer(Long endPointId)
void	unregisterNewExtendedDataOnRevisionHandler(Long endPointId, Long roid) Unregister, called after registerNewExtendedDataOnRevisionHandler
void	unregisterNewProjectHandler(Long endPointId) Unregister this endpoint to be notified when a project has been added
void	unregisterNewRevisionHandler(Long endPointId)
void	unregisterNewRevisionOnSpecificProjectHandler(Long endPointId, Long poid)
void	unregisterNewUserHandler(Long endPointId) Unregister this endpoint to be notified when a new user has been added
void	unregisterProgressHandler(Long topicId, Long endPointId)
void	unregisterProgressTopic(Long topicId) Unregister a progress topic on this server
void	updateProgressTopic(Long topicId, SLongActionState state) Update the progress information on the given topic

Method Detail

registerProgressTopic

Long registerProgressTopic(SProgressTopicType type,
                           String description)
                    throws UserException,
                           ServerException

Register a progress topic, remember to unregister with unregisterProgressTopic when done

Parameters:

type - The type of progress

description - A description of the running service

Returns:

A TopicID, which can be used by updateProgressTopic

Throws:

UserException

ServerException

updateProgressTopic

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

Update the progress information on the given topic

Parameters:

topicId - TopicID

state - The new state

Throws:

UserException

ServerException

unregisterProgressTopic

void unregisterProgressTopic(Long topicId)
                      throws UserException,
                             ServerException

Unregister a progress topic on this server

Parameters:

topicId - TopicID

Throws:

UserException

ServerException

registerProgressHandler

void registerProgressHandler(Long topicId,
                             Long endPointId)
                      throws UserException,
                             ServerException

Parameters:

topicId - Register an endpoint to be notified of update on the given (progress) topic

endPointId - EndPointID, which identifies the endpoint

Throws:

UserException

ServerException

registerNewRevisionOnSpecificProjectHandler

void registerNewRevisionOnSpecificProjectHandler(Long endPointId,
                                                 Long poid)
                                          throws UserException,
                                                 ServerException

Register the given endpoint to be notified about new revisions on the given project

Parameters:

endPointId - EndPointID

poid - Project OID

Throws:

UserException

ServerException

registerNewRevisionHandler

void registerNewRevisionHandler(Long endPointId)
                         throws UserException,
                                ServerException

Register the given endpoint to be notified about new revisions

Parameters:

endPointId - EndPointID

Throws:

UserException

ServerException

registerNewExtendedDataOnRevisionHandler

void registerNewExtendedDataOnRevisionHandler(Long endPointId,
                                              Long roid)
                                       throws UserException,
                                              ServerException

Register the given endpoint to be notified about extended data being added to the given revision

Parameters:

endPointId - EndPointID

roid - Revision OID

Throws:

UserException

ServerException

unregisterNewExtendedDataOnRevisionHandler

void unregisterNewExtendedDataOnRevisionHandler(Long endPointId,
                                                Long roid)
                                         throws UserException,
                                                ServerException

Unregister, called after registerNewExtendedDataOnRevisionHandler

Parameters:

endPointId -

roid -

Throws:

UserException

ServerException

registerNewProjectHandler

void registerNewProjectHandler(Long endPointId)
                        throws UserException,
                               ServerException

Register this endpoint to be notified when a project has been added

Parameters:

endPointId -

Throws:

UserException

ServerException

unregisterNewProjectHandler

void unregisterNewProjectHandler(Long endPointId)
                          throws UserException,
                                 ServerException

Unregister this endpoint to be notified when a project has been added

Parameters:

endPointId -

Throws:

UserException

ServerException

registerNewUserHandler

void registerNewUserHandler(Long endPointId)
                     throws UserException,
                            ServerException

Register this endpoint to be notified when a new user has been added

Parameters:

endPointId -

Throws:

UserException

ServerException

unregisterNewUserHandler

void unregisterNewUserHandler(Long endPointId)
                       throws UserException,
                              ServerException

Unregister this endpoint to be notified when a new user has been added

Parameters:

endPointId -

Throws:

UserException

ServerException

unregisterNewRevisionOnSpecificProjectHandler

void unregisterNewRevisionOnSpecificProjectHandler(Long endPointId,
                                                   Long poid)
                                            throws UserException,
                                                   ServerException

Parameters:

endPointId -

poid -

Throws:

UserException

ServerException

unregisterNewRevisionHandler

void unregisterNewRevisionHandler(Long endPointId)
                           throws UserException,
                                  ServerException

Parameters:

endPointId -

Throws:

UserException

ServerException

unregisterProgressHandler

void unregisterProgressHandler(Long topicId,
                               Long endPointId)
                        throws UserException,
                               ServerException

Parameters:

topicId -

endPointId -

Throws:

UserException

ServerException

getProgress

SLongActionState getProgress(Long topicId)
                      throws UserException,
                             ServerException

Parameters:

topicId -

Returns:

Throws:

UserException

ServerException

getProgressTopicsOnRevision

List<Long> getProgressTopicsOnRevision(Long poid,
                                       Long roid)
                                throws UserException,
                                       ServerException

Parameters:

poid -

roid -

Returns:

Throws:

UserException

ServerException

getProgressTopicsOnProject

List<Long> getProgressTopicsOnProject(Long poid)
                               throws UserException,
                                      ServerException

Parameters:

poid -

Returns:

Throws:

UserException

ServerException

getProgressTopicsOnServer

List<Long> getProgressTopicsOnServer()
                              throws UserException,
                                     ServerException

Returns:

Throws:

UserException

ServerException

registerProgressOnRevisionTopic

Long registerProgressOnRevisionTopic(SProgressTopicType type,
                                     Long poid,
                                     Long roid,
                                     String description)
                              throws UserException,
                                     ServerException

Parameters:

type -

poid -

roid -

description -

Returns:

Throws:

UserException

ServerException

registerProgressOnProjectTopic

Long registerProgressOnProjectTopic(SProgressTopicType type,
                                    Long poid,
                                    String description)
                             throws UserException,
                                    ServerException

Register a new progress topic that is related to the given project

Parameters:

type -

poid -

description -

Returns:

Throws:

UserException

ServerException

registerChangeProgressOnProject

void registerChangeProgressOnProject(Long endPointId,
                                     Long poid)
                              throws ServerException,
                                     UserException

Parameters:

endPointId -

poid -

Throws:

ServerException

UserException

registerChangeProgressOnServer

void registerChangeProgressOnServer(Long endPointId)
                             throws ServerException,
                                    UserException

Parameters:

endPointId -

Throws:

ServerException

UserException

unregisterChangeProgressOnServer

void unregisterChangeProgressOnServer(Long endPointId)
                               throws ServerException,
                                      UserException

Parameters:

endPointId -

Throws:

ServerException

UserException

registerChangeProgressOnRevision

void registerChangeProgressOnRevision(Long endPointId,
                                      Long roid,
                                      Long poid)
                               throws ServerException,
                                      UserException

Parameters:

endPointId -

roid -

poid -

Throws:

ServerException

UserException

unregisterChangeProgressOnProject

void unregisterChangeProgressOnProject(Long endPointId,
                                       Long poid)
                                throws ServerException,
                                       UserException

Parameters:

endPointId -

poid -

Throws:

ServerException

UserException

unregisterChangeProgressOnRevision

void unregisterChangeProgressOnRevision(Long endPointId,
                                        Long roid,
                                        Long poid)
                                 throws ServerException,
                                        UserException

Parameters:

endPointId -

roid -

poid -

Throws:

ServerException

UserException