org.bimserver.shared.interfaces

Class ServiceInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.ServiceInterfaceAdaptor

All Implemented Interfaces:

PublicInterface, ServiceInterface

public class ServiceInterfaceAdaptor
extends Object
implements ServiceInterface

Constructor Summary

Constructors

Constructor and Description
ServiceInterfaceAdaptor()

Method Summary

Modifier and Type	Method and Description
Long	addExtendedDataSchema(SExtendedDataSchema extendedDataSchema) Add an extended data schema.
void	addExtendedDataToProject(Long poid, SExtendedData extendedData)
void	addLocalServiceToProject(Long poid, SService sService, Long internalServiceOid) Add a local service to a project
Long	addModelChecker(SModelCheckerInstance modelCheckerInstance)
void	addModelCheckerToProject(Long poid, Long modelCheckerOid) Add a model checker to a project
Long	addServiceToProject(Long poid, SService sService)
SUser	addUser(String username, String name, SUserType type, Boolean selfRegistration, String resetUrl) Add a new user
void	addUserToExtendedDataSchema(Long uoid, Long edsid)
Boolean	addUserToProject(Long uoid, Long poid) Add a user to a project (authorization wise)
SUser	addUserWithPassword(String username, String password, String name, SUserType type, Boolean selfRegistration, String resetUrl) Add a new user with a given password
void	changeUserType(Long uoid, SUserType userType) Change the type of a user
Long	checkin(Long poid, String comment, Long deserializerOid, Long fileSize, String fileName, DataHandler data, Boolean merge, Boolean sync) Checkin a new model by sending a serialized form
Long	checkinFromUrl(Long poid, String comment, Long deserializerOid, String fileName, String url, Boolean merge, Boolean sync) Checkin a new model by sending a serialized form
Long	checkinInitiated(Long topicId, Long poid, String comment, Long deserializerOid, Long fileSize, String fileName, DataHandler data, Boolean merge, Boolean sync)
void	cleanupLongAction(Long topicId) Cleanup a long running action, this is important to keep memory usage of BIMserver down
SCompareResult	compare(Long roid1, Long roid2, SCompareType sCompareType, Long mcid) Compare two models
void	deleteService(Long oid)
Boolean	deleteUser(Long uoid) Delete a User, Users van be undeleted with the undeleteUser method
Long	downloadCompareResults(Long serializerOid, Long roid1, Long roid2, Long mcid, SCompareType type, Boolean sync) Download a compare of a model
List<SUser>	getAllAuthorizedUsersOfProject(Long poid) Get a list of users that have been authorized on the given project
List<SCheckout>	getAllCheckoutsByUser(Long uoid) Get a list of checkouts by the given user
List<SCheckout>	getAllCheckoutsOfProject(Long poid) Get all checkouts of the given project
List<SCheckout>	getAllCheckoutsOfProjectAndSubProjects(Long poid) Get a list of all checkouts of the given project and it's sub projects
List<SCheckout>	getAllCheckoutsOfRevision(Long roid) Get a list of checkouts on the given revision
List<SExtendedDataSchema>	getAllExtendedDataSchemas()
List<SProfileDescriptor>	getAllLocalProfiles(String serviceIdentifier)
List<SServiceDescriptor>	getAllLocalServiceDescriptors()
List<SModelCheckerInstance>	getAllModelCheckers() Get all model checkers
List<SModelCheckerInstance>	getAllModelCheckersOfProject(Long poid) Get a list of all the model checkers attached to the given Project
List<SProject>	getAllNonAuthorizedProjectsOfUser(Long uoid) Get a list of all Projects the given User does not have authorization for
List<SUser>	getAllNonAuthorizedUsersOfProject(Long poid) Get a list of all Users not authoriazed on the given Project
List<SProfileDescriptor>	getAllPrivateProfiles(String notificationsUrl, String serviceIdentifier, String token)
List<SProfileDescriptor>	getAllPublicProfiles(String notificationsUrl, String serviceIdentifier)
List<SProject>	getAllReadableProjects() Get a list of all Projects the user is authorized for to read from
List<SProjectSmall>	getAllRelatedProjects(Long poid) Get a list of a project's related projects.
List<SExtendedDataSchema>	getAllRepositoryExtendedDataSchemas()
List<SModelCheckerInstance>	getAllRepositoryModelCheckers()
List<SRevision>	getAllRevisionsByUser(Long uoid) Get a list of revisions a user has committed
List<SServiceDescriptor>	getAllServiceDescriptors()
List<SService>	getAllServicesOfProject(Long poid) Get a list of all the services attached to the given project
List<SUser>	getAllUsers() Get a list of all users
List<SProject>	getAllWritableProjects() Get a list of all Projects the user is authorized for to write to
Double	getArea(Long roid, Long oid) Get the area of the given object
List<String>	getAvailableClasses() Returns a list of all available classes
List<String>	getAvailableClassesInRevision(Long roid) Returns a list of all the classes that are used in the given revision
Set<String>	getCheckinWarnings(Long poid) Checkin warnings are given to users
Set<String>	getCheckoutWarnings(Long poid) Checkout warnings are given to users when checkouts are done by other users
SExtendedDataSchema	getExtendedDataSchemaFromRepository(String namespace)
SFile	getFile(Long fileId)
SGeometryInfo	getGeometryInfo(Long roid, Long oid)
SGeoTag	getGeoTag(Long goid) Get the GeoTag attached to the given Project
SIfcHeader	getIfcHeader(Long croid) Get the IfcHeader of the given ConcreteRevision-ID
SModelCheckerInstance	getModelCheckerInstance(Long mcioid) Get a model checker instance by it's id
Long	getNrPrimitives(Long roid)
Long	getOidByGuid(Long roid, String guid) Get the oid of the given GUID, will throw a UserException if the GUID was not found
String	getQueryEngineExample(Long qeid, String key) Returns a query engine example (get the key from getQueryEngineExampleKeys)
List<String>	getQueryEngineExampleKeys(Long qeid) Get a list of query engine example keys (which you can then use for getQueryEngineExample)
SRevisionSummary	getRevisionSummary(Long roid) Get a revision summary
SService	getService(Long soid)
SServiceDescriptor	getServiceDescriptor(String baseUrl, String serviceIdentifier)
SUser	getUserByUoid(Long uoid) Get a user by its User ObjectID
SUser	getUserByUserName(String username) Get a User by its UserNmae (e-mail address)
List<SLogAction>	getUserRelatedLogs(Long uoid) Get all log entries linked to the given user
SUserSettings	getUserSettings() Get the user settings of the current user
List<SProject>	getUsersProjects(Long uoid) Get a list of projects a user is authorized on
Double	getVolume(Long roid, Long oid) Get the volume of the given object
void	importData(String address, String username, String password, String path) Import data from another BIMserver, mainly used for migrations.
Long	initiateCheckin(Long poid, Long deserializerOid) Start uploading a new model, the main reason for this call is to get a TopicID, which you can use to get progress updates
void	removeModelCheckerFromProject(Long poid, Long modelCheckerOid) Remove the given model checker from the given project
void	removeServiceFromProject(Long poid, Long serviceOid) Remove the given service from the given project
void	removeUserFromExtendedDataSchema(Long uoid, Long edsid)
Boolean	removeUserFromProject(Long uoid, Long poid) Remove a user from a project (authorization wise)
void	sendCompareEmail(SCompareType sCompareType, Long mcid, Long poid, Long roid1, Long roid2, String address) Send an e-mail with the results of a compare
void	setRevisionTag(Long roid, String tag) Set a tag on a specific revision
String	shareRevision(Long roid) Share a revision
void	triggerNewExtendedData(Long edid, Long soid)
void	triggerNewRevision(Long roid, Long soid)
Boolean	undeleteUser(Long uoid) Undelete a previously deleted User, Users can be deleted with the deleteUser method
void	updateGeoTag(SGeoTag sGeoTag) Update the GeoTag of a project
void	updateModelChecker(SModelCheckerInstance modelCheckerInstance)
void	updateProject(SProject sProject) Update project properties, the only three properties that can be updated with this call are "name", "description" and "exportLengthMeasurePrefix"
void	updateRevision(SRevision sRevision) Update a revision, not much can be changed afterwards, actually only the tag
Long	uploadFile(SFile file)
Boolean	userHasCheckinRights(Long uoid, Long poid) Check whether the given user has rights on the given project
Boolean	userHasRights(Long poid) Returns whether the currents user has rights on the given project
void	validateModelChecker(Long oid) Validate a model checker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceInterfaceAdaptor

public ServiceInterfaceAdaptor()

Method Detail

addExtendedDataSchema

public Long addExtendedDataSchema(SExtendedDataSchema extendedDataSchema)
                           throws UserException,
                                  ServerException

Description copied from interface: ServiceInterface

Add an extended data schema.

Specified by:

addExtendedDataSchema in interface ServiceInterface

Parameters:

extendedDataSchema - ExtendedDataSchema to add

Throws:

UserException

ServerException

addExtendedDataToProject

public void addExtendedDataToProject(Long poid,
                                     SExtendedData extendedData)
                              throws UserException,
                                     ServerException

Specified by:

addExtendedDataToProject in interface ServiceInterface

extendedData - ExtendedData to add

Throws:

UserException

ServerException

addLocalServiceToProject

public void addLocalServiceToProject(Long poid,
                                     SService sService,
                                     Long internalServiceOid)
                              throws UserException,
                                     ServerException

Description copied from interface: ServiceInterface

Add a local service to a project

Specified by:

addLocalServiceToProject in interface ServiceInterface

Throws:

UserException

ServerException

addModelChecker

public Long addModelChecker(SModelCheckerInstance modelCheckerInstance)
                     throws UserException,
                            ServerException

Specified by:

addModelChecker in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

addModelCheckerToProject

public void addModelCheckerToProject(Long poid,
                                     Long modelCheckerOid)
                              throws UserException,
                                     ServerException

Description copied from interface: ServiceInterface

Add a model checker to a project

Specified by:

addModelCheckerToProject in interface ServiceInterface

Parameters:

poid - Project-ID

modelCheckerOid - ModelChecker ID

Throws:

UserException

ServerException

addServiceToProject

public Long addServiceToProject(Long poid,
                                SService sService)
                         throws UserException,
                                ServerException

Specified by:

addServiceToProject in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

addUser

public SUser addUser(String username,
                     String name,
                     SUserType type,
                     Boolean selfRegistration,
                     String resetUrl)
              throws UserException,
                     ServerException

Description copied from interface: ServiceInterface

Add a new user

Specified by:

addUser in interface ServiceInterface

Parameters:

username - The username (must be a valid e-mail address)

name - The name (e.g. "Bill Gates")

type - Type of user

selfRegistration - Whether this is a self-registration (for example e-mails will be different)

resetUrl - Reset URL (webbased clients can provide a url that handles the activation of the account)

Returns:

The ObjectID of the created User object

Throws:

UserException

ServerException

addUserToExtendedDataSchema

public void addUserToExtendedDataSchema(Long uoid,
                                        Long edsid)
                                 throws UserException,
                                        ServerException

Specified by:

addUserToExtendedDataSchema in interface ServiceInterface

Parameters:

uoid - ObjectID of the User

edsid - ObjectID of the ExtendedDataSchema

Throws:

UserException

ServerException

addUserToProject

public Boolean addUserToProject(Long uoid,
                                Long poid)
                         throws UserException,
                                ServerException

Description copied from interface: ServiceInterface

Add a user to a project (authorization wise)

Specified by:

addUserToProject in interface ServiceInterface

Parameters:

uoid - The ObejctID of the User

poid - The ObjectID of the Project

Returns:

Whether the User has been added to the Project

Throws:

UserException

ServerException

addUserWithPassword

public SUser addUserWithPassword(String username,
                                 String password,
                                 String name,
                                 SUserType type,
                                 Boolean selfRegistration,
                                 String resetUrl)
                          throws UserException,
                                 ServerException

Description copied from interface: ServiceInterface

Add a new user with a given password

Specified by:

addUserWithPassword in interface ServiceInterface

Parameters:

username - The username (must be a valid e-mail address)

name - The name (e.g. "Bill Gates")

type - Type of user

selfRegistration - Whether this is a self-registration (for example e-mails will be different)

Returns:

The ObjectID of the created User object

Throws:

UserException

ServerException

changeUserType

public void changeUserType(Long uoid,
                           SUserType userType)
                    throws UserException,
                           ServerException

Description copied from interface: ServiceInterface

Change the type of a user

Specified by:

changeUserType in interface ServiceInterface

Parameters:

uoid - The User's ObjectID

userType - The new type

Throws:

UserException

ServerException

checkin

public Long checkin(Long poid,
                    String comment,
                    Long deserializerOid,
                    Long fileSize,
                    String fileName,
                    DataHandler data,
                    Boolean merge,
                    Boolean sync)
             throws UserException,
                    ServerException

Description copied from interface: ServiceInterface

Checkin a new model by sending a serialized form

Specified by:

checkin in interface ServiceInterface

Parameters:

poid - The Project's ObjectID

comment - A comment

deserializerOid - ObjectId of the deserializer to use, use getAllDeserializers to get a list of available deserializers

fileSize - The size of the file in bytes

fileName - Name of the file

data - The actual data

merge - Whether to use checkin merging (this will alter your model!) DEPRICATED

sync - Whether the call should return immediately (async) or wait for completion (sync)

Returns:

An id, which you can use for the getCheckinState method

Throws:

UserException

ServerException

checkinFromUrl

public Long checkinFromUrl(Long poid,
                           String comment,
                           Long deserializerOid,
                           String fileName,
                           String url,
                           Boolean merge,
                           Boolean sync)
                    throws UserException,
                           ServerException

Description copied from interface: ServiceInterface

Checkin a new model by sending a serialized form

Specified by:

checkinFromUrl in interface ServiceInterface

Parameters:

poid - The Project's ObjectID

comment - A comment

deserializerOid - ObjectId of the deserializer to use, use getAllDeserializers to get a list of available deserializers

fileName - Name of the file

url - A URL to the 'file'

merge - Whether to use checkin merging (this will alter your model!)

sync - Whether the call should return immediately (async) or wait for completion (sync)

Returns:

An id, which you can use for the getCheckinState method

Throws:

UserException

ServerException

checkinInitiated

public Long checkinInitiated(Long topicId,
                             Long poid,
                             String comment,
                             Long deserializerOid,
                             Long fileSize,
                             String fileName,
                             DataHandler data,
                             Boolean merge,
                             Boolean sync)
                      throws UserException,
                             ServerException

Specified by:

checkinInitiated in interface ServiceInterface

Throws:

UserException

ServerException

cleanupLongAction

public void cleanupLongAction(Long topicId)
                       throws UserException,
                              ServerException

Description copied from interface: ServiceInterface

Cleanup a long running action, this is important to keep memory usage of BIMserver down

Specified by:

cleanupLongAction in interface ServiceInterface

Throws:

UserException

ServerException

compare

public SCompareResult compare(Long roid1,
                              Long roid2,
                              SCompareType sCompareType,
                              Long mcid)
                       throws UserException,
                              ServerException

Description copied from interface: ServiceInterface

Compare two models

Specified by:

compare in interface ServiceInterface

Parameters:

roid1 - The ObjectID of the first Revision

roid2 - The ObjectID of the second Revision

sCompareType - How to compare (All, Only Added, Only Modified or Only Deleted)

Returns:

The result of the compare

Throws:

UserException

ServerException

deleteService

public void deleteService(Long oid)
                   throws UserException,
                          ServerException

Specified by:

deleteService in interface ServiceInterface

Throws:

UserException

ServerException

deleteUser

public Boolean deleteUser(Long uoid)
                   throws UserException,
                          ServerException

Description copied from interface: ServiceInterface

Delete a User, Users van be undeleted with the undeleteUser method

Specified by:

deleteUser in interface ServiceInterface

Parameters:

uoid - ObjectID of the User

Returns:

Whether the User has been deleted

Throws:

UserException

ServerException

downloadCompareResults

public Long downloadCompareResults(Long serializerOid,
                                   Long roid1,
                                   Long roid2,
                                   Long mcid,
                                   SCompareType type,
                                   Boolean sync)
                            throws UserException,
                                   ServerException

Description copied from interface: ServiceInterface

Download a compare of a model

Specified by:

downloadCompareResults in interface ServiceInterface

Returns:

An id, which you can use for the getDownloadState and getDownloadData methods

Throws:

UserException

ServerException

getAllAuthorizedUsersOfProject

public List<SUser> getAllAuthorizedUsersOfProject(Long poid)
                                           throws UserException,
                                                  ServerException

Description copied from interface: ServiceInterface

Get a list of users that have been authorized on the given project

Specified by:

getAllAuthorizedUsersOfProject in interface ServiceInterface

Returns:

A list of all users authorized on the given project

Throws:

UserException

ServerException

getAllCheckoutsByUser

public List<SCheckout> getAllCheckoutsByUser(Long uoid)
                                      throws UserException,
                                             ServerException

Description copied from interface: ServiceInterface

Get a list of checkouts by the given user

Specified by:

getAllCheckoutsByUser in interface ServiceInterface

Parameters:

uoid - ObjectID of the User

Returns:

A list of Checkouts belonging to the given User

Throws:

UserException

ServerException

getAllCheckoutsOfProject

public List<SCheckout> getAllCheckoutsOfProject(Long poid)
                                         throws UserException,
                                                ServerException

Description copied from interface: ServiceInterface

Get all checkouts of the given project

Specified by:

getAllCheckoutsOfProject in interface ServiceInterface

Parameters:

poid - The ObjectID of the Project

Returns:

A list of Checkouts belonging to this Project

Throws:

UserException

ServerException

getAllCheckoutsOfProjectAndSubProjects

public List<SCheckout> getAllCheckoutsOfProjectAndSubProjects(Long poid)
                                                       throws UserException,
                                                              ServerException

Description copied from interface: ServiceInterface

Get a list of all checkouts of the given project and it's sub projects

Specified by:

getAllCheckoutsOfProjectAndSubProjects in interface ServiceInterface

Parameters:

poid - Project-ID of the given Project

Returns:

Throws:

UserException

ServerException

getAllCheckoutsOfRevision

public List<SCheckout> getAllCheckoutsOfRevision(Long roid)
                                          throws UserException,
                                                 ServerException

Description copied from interface: ServiceInterface

Get a list of checkouts on the given revision

Specified by:

getAllCheckoutsOfRevision in interface ServiceInterface

Parameters:

roid - ObjectID of the Revision

Returns:

A list of Checkouts belonging to the given Revision

Throws:

UserException

ServerException

getAllExtendedDataSchemas

public List<SExtendedDataSchema> getAllExtendedDataSchemas()
                                                    throws UserException,
                                                           ServerException

Specified by:

getAllExtendedDataSchemas in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllLocalProfiles

public List<SProfileDescriptor> getAllLocalProfiles(String serviceIdentifier)
                                             throws UserException,
                                                    ServerException

Specified by:

getAllLocalProfiles in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllLocalServiceDescriptors

public List<SServiceDescriptor> getAllLocalServiceDescriptors()
                                                       throws UserException,
                                                              ServerException

Specified by:

getAllLocalServiceDescriptors in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllModelCheckers

public List<SModelCheckerInstance> getAllModelCheckers()
                                                throws UserException,
                                                       ServerException

Description copied from interface: ServiceInterface

Get all model checkers

Specified by:

getAllModelCheckers in interface ServiceInterface

Returns:

A list of model checkers

Throws:

UserException

ServerException

getAllModelCheckersOfProject

public List<SModelCheckerInstance> getAllModelCheckersOfProject(Long poid)
                                                         throws UserException,
                                                                ServerException

Description copied from interface: ServiceInterface

Get a list of all the model checkers attached to the given Project

Specified by:

getAllModelCheckersOfProject in interface ServiceInterface

Parameters:

poid - Project-ID of the Project

Returns:

Throws:

UserException

ServerException

getAllNonAuthorizedProjectsOfUser

public List<SProject> getAllNonAuthorizedProjectsOfUser(Long uoid)
                                                 throws UserException,
                                                        ServerException

Description copied from interface: ServiceInterface

Get a list of all Projects the given User does not have authorization for

Specified by:

getAllNonAuthorizedProjectsOfUser in interface ServiceInterface

Returns:

The list of Users

Throws:

UserException

ServerException

getAllNonAuthorizedUsersOfProject

public List<SUser> getAllNonAuthorizedUsersOfProject(Long poid)
                                              throws UserException,
                                                     ServerException

Description copied from interface: ServiceInterface

Get a list of all Users not authoriazed on the given Project

Specified by:

getAllNonAuthorizedUsersOfProject in interface ServiceInterface

Parameters:

poid - The ObjectID of the Project

Returns:

A list of Users

Throws:

UserException

ServerException

getAllPrivateProfiles

public List<SProfileDescriptor> getAllPrivateProfiles(String notificationsUrl,
                                                      String serviceIdentifier,
                                                      String token)
                                               throws UserException,
                                                      ServerException

Specified by:

getAllPrivateProfiles in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllPublicProfiles

public List<SProfileDescriptor> getAllPublicProfiles(String notificationsUrl,
                                                     String serviceIdentifier)
                                              throws UserException,
                                                     ServerException

Specified by:

getAllPublicProfiles in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllReadableProjects

public List<SProject> getAllReadableProjects()
                                      throws UserException,
                                             ServerException

Description copied from interface: ServiceInterface

Get a list of all Projects the user is authorized for to read from

Specified by:

getAllReadableProjects in interface ServiceInterface

Returns:

A list of all projects that are readable for the current user

Throws:

UserException

ServerException

getAllRelatedProjects

public List<SProjectSmall> getAllRelatedProjects(Long poid)
                                          throws UserException,
                                                 ServerException

Description copied from interface: ServiceInterface

Get a list of a project's related projects. Will search through all the parent/child relations, recursively

Specified by:

getAllRelatedProjects in interface ServiceInterface

Parameters:

poid - The projectID of the project

Returns:

Throws:

UserException

ServerException

getAllRepositoryExtendedDataSchemas

public List<SExtendedDataSchema> getAllRepositoryExtendedDataSchemas()
                                                              throws UserException,
                                                                     ServerException

Specified by:

getAllRepositoryExtendedDataSchemas in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllRepositoryModelCheckers

public List<SModelCheckerInstance> getAllRepositoryModelCheckers()
                                                          throws UserException,
                                                                 ServerException

Specified by:

getAllRepositoryModelCheckers in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllRevisionsByUser

public List<SRevision> getAllRevisionsByUser(Long uoid)
                                      throws UserException,
                                             ServerException

Description copied from interface: ServiceInterface

Get a list of revisions a user has committed

Specified by:

getAllRevisionsByUser in interface ServiceInterface

Parameters:

uoid - ObjectID of the Project

Returns:

A list of Revisions belonging to this Project

Throws:

UserException

ServerException

getAllServiceDescriptors

public List<SServiceDescriptor> getAllServiceDescriptors()
                                                  throws UserException,
                                                         ServerException

Specified by:

getAllServiceDescriptors in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getAllServicesOfProject

public List<SService> getAllServicesOfProject(Long poid)
                                       throws UserException,
                                              ServerException

Description copied from interface: ServiceInterface

Get a list of all the services attached to the given project

Specified by:

getAllServicesOfProject in interface ServiceInterface

Parameters:

poid - Project-ID of the Project

Returns:

Throws:

UserException

ServerException

getAllUsers

public List<SUser> getAllUsers()
                        throws UserException,
                               ServerException

Description copied from interface: ServiceInterface

Get a list of all users

Specified by:

getAllUsers in interface ServiceInterface

Returns:

All users

Throws:

UserException

ServerException

getAllWritableProjects

public List<SProject> getAllWritableProjects()
                                      throws UserException,
                                             ServerException

Description copied from interface: ServiceInterface

Get a list of all Projects the user is authorized for to write to

Specified by:

getAllWritableProjects in interface ServiceInterface

Returns:

A list of all projects that are writeable for the current user

Throws:

UserException

ServerException

getArea

public Double getArea(Long roid,
                      Long oid)
               throws UserException,
                      ServerException

Description copied from interface: ServiceInterface

Get the area of the given object

Specified by:

getArea in interface ServiceInterface

Parameters:

roid - Revision-ID of the revision this object belongs to

oid - Object-ID of the object

Returns:

Throws:

UserException

ServerException

getAvailableClasses

public List<String> getAvailableClasses()
                                 throws UserException,
                                        ServerException

Description copied from interface: ServiceInterface

Returns a list of all available classes

Specified by:

getAvailableClasses in interface ServiceInterface

Returns:

A list of available classes in the BIMserver, only classes from the IFC model will be returned

Throws:

UserException

ServerException

getAvailableClassesInRevision

public List<String> getAvailableClassesInRevision(Long roid)
                                           throws UserException,
                                                  ServerException

Description copied from interface: ServiceInterface

Returns a list of all the classes that are used in the given revision

Specified by:

getAvailableClassesInRevision in interface ServiceInterface

Parameters:

roid - ObjectID of the Revision

Returns:

A list of classes of which a least one instance is available in the given Revision

Throws:

UserException

ServerException

getCheckinWarnings

public Set<String> getCheckinWarnings(Long poid)
                               throws UserException,
                                      ServerException

Description copied from interface: ServiceInterface

Checkin warnings are given to users

Specified by:

getCheckinWarnings in interface ServiceInterface

Parameters:

poid - ObjectID of the Project

Returns:

A set of String containing possible warnings for this Project

Throws:

UserException

ServerException

getCheckoutWarnings

public Set<String> getCheckoutWarnings(Long poid)
                                throws UserException,
                                       ServerException

Description copied from interface: ServiceInterface

Checkout warnings are given to users when checkouts are done by other users

Specified by:

getCheckoutWarnings in interface ServiceInterface

Parameters:

poid - ObjectID of the Project

Returns:

A set of String containing possible warnings for this Project

Throws:

UserException

ServerException

getExtendedDataSchemaFromRepository

public SExtendedDataSchema getExtendedDataSchemaFromRepository(String namespace)
                                                        throws UserException,
                                                               ServerException

Specified by:

getExtendedDataSchemaFromRepository in interface ServiceInterface

Throws:

UserException

ServerException

getFile

public SFile getFile(Long fileId)
              throws UserException,
                     ServerException

Specified by:

getFile in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getGeoTag

public SGeoTag getGeoTag(Long goid)
                  throws UserException,
                         ServerException

Description copied from interface: ServiceInterface

Get the GeoTag attached to the given Project

Specified by:

getGeoTag in interface ServiceInterface

Parameters:

goid - The ObjectID of the GeoTag

Returns:

The GeoTag object

Throws:

UserException

ServerException

getGeometryInfo

public SGeometryInfo getGeometryInfo(Long roid,
                                     Long oid)
                              throws UserException,
                                     ServerException

Specified by:

getGeometryInfo in interface ServiceInterface

Parameters:

roid - Revision-ID of the revision this object belongs to

oid - Object-ID of the object (IfcProduct subtype)

Returns:

SGeometryInfo with basic info about geometry

Throws:

UserException

ServerException

getIfcHeader

public SIfcHeader getIfcHeader(Long croid)
                        throws UserException,
                               ServerException

Description copied from interface: ServiceInterface

Get the IfcHeader of the given ConcreteRevision-ID

Specified by:

getIfcHeader in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getModelCheckerInstance

public SModelCheckerInstance getModelCheckerInstance(Long mcioid)
                                              throws UserException,
                                                     ServerException

Description copied from interface: ServiceInterface

Get a model checker instance by it's id

Specified by:

getModelCheckerInstance in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getNrPrimitives

public Long getNrPrimitives(Long roid)
                     throws UserException,
                            ServerException

Specified by:

getNrPrimitives in interface ServiceInterface

Throws:

UserException

ServerException

getOidByGuid

public Long getOidByGuid(Long roid,
                         String guid)
                  throws UserException,
                         ServerException

Description copied from interface: ServiceInterface

Get the oid of the given GUID, will throw a UserException if the GUID was not found

Specified by:

getOidByGuid in interface ServiceInterface

Parameters:

roid - Revision in which to look

guid - GUID

Returns:

Throws:

UserException

ServerException

getQueryEngineExample

public String getQueryEngineExample(Long qeid,
                                    String key)
                             throws UserException,
                                    ServerException

Description copied from interface: ServiceInterface

Returns a query engine example (get the key from getQueryEngineExampleKeys)

Specified by:

getQueryEngineExample in interface ServiceInterface

Returns:

A list of QueryEngines

Throws:

UserException

ServerException

getQueryEngineExampleKeys

public List<String> getQueryEngineExampleKeys(Long qeid)
                                       throws UserException,
                                              ServerException

Description copied from interface: ServiceInterface

Get a list of query engine example keys (which you can then use for getQueryEngineExample)

Specified by:

getQueryEngineExampleKeys in interface ServiceInterface

Returns:

A list of QueryEngines

Throws:

UserException

ServerException

getRevisionSummary

public SRevisionSummary getRevisionSummary(Long roid)
                                    throws UserException,
                                           ServerException

Description copied from interface: ServiceInterface

Get a revision summary

Specified by:

getRevisionSummary in interface ServiceInterface

Parameters:

roid - ObjectID of the Revision

Returns:

A summary of the given Revision

Throws:

UserException

ServerException

getService

public SService getService(Long soid)
                    throws UserException,
                           ServerException

Specified by:

getService in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getServiceDescriptor

public SServiceDescriptor getServiceDescriptor(String baseUrl,
                                               String serviceIdentifier)
                                        throws UserException,
                                               ServerException

Specified by:

getServiceDescriptor in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getUserByUoid

public SUser getUserByUoid(Long uoid)
                    throws UserException,
                           ServerException

Description copied from interface: ServiceInterface

Get a user by its User ObjectID

Specified by:

getUserByUoid in interface ServiceInterface

Parameters:

uoid - The ObjectID of the User

Returns:

The User with the given User ObjectID

Throws:

UserException

ServerException

getUserByUserName

public SUser getUserByUserName(String username)
                        throws UserException,
                               ServerException

Description copied from interface: ServiceInterface

Get a User by its UserNmae (e-mail address)

Specified by:

getUserByUserName in interface ServiceInterface

Parameters:

username - The username (must be a valid e-mail address)

Returns:

The SUser Object if found, otherwise null

Throws:

UserException

ServerException

getUserRelatedLogs

public List<SLogAction> getUserRelatedLogs(Long uoid)
                                    throws UserException,
                                           ServerException

Description copied from interface: ServiceInterface

Get all log entries linked to the given user

Specified by:

getUserRelatedLogs in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getUserSettings

public SUserSettings getUserSettings()
                              throws UserException,
                                     ServerException

Description copied from interface: ServiceInterface

Get the user settings of the current user

Specified by:

getUserSettings in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

getUsersProjects

public List<SProject> getUsersProjects(Long uoid)
                                throws UserException,
                                       ServerException

Description copied from interface: ServiceInterface

Get a list of projects a user is authorized on

Specified by:

getUsersProjects in interface ServiceInterface

Returns:

A list of projects a user has been authorized for

Throws:

UserException

ServerException

getVolume

public Double getVolume(Long roid,
                        Long oid)
                 throws UserException,
                        ServerException

Description copied from interface: ServiceInterface

Get the volume of the given object

Specified by:

getVolume in interface ServiceInterface

Parameters:

roid - Revision-ID of the revision this object belongs to

oid - Object-ID of the object

Returns:

Throws:

UserException

ServerException

importData

public void importData(String address,
                       String username,
                       String password,
                       String path)
                throws UserException,
                       ServerException

Description copied from interface: ServiceInterface

Import data from another BIMserver, mainly used for migrations. EXPERIMENTAL CODE!

Specified by:

importData in interface ServiceInterface

Parameters:

address - Address of the other BIMserver (http(s)://host:port/[contextpath])

username - Username of the admin user on the remote server

password - Password of the admin user on the remote server

path - A local path pointing to a copy of the incoming directory of the original server

Throws:

UserException

ServerException

initiateCheckin

public Long initiateCheckin(Long poid,
                            Long deserializerOid)
                     throws UserException,
                            ServerException

Description copied from interface: ServiceInterface

Start uploading a new model, the main reason for this call is to get a TopicID, which you can use to get progress updates

Specified by:

initiateCheckin in interface ServiceInterface

Parameters:

poid - ProjectID of the project you want to upload to

deserializerOid - Deserializer OID

Returns:

Throws:

UserException

ServerException

removeModelCheckerFromProject

public void removeModelCheckerFromProject(Long poid,
                                          Long modelCheckerOid)
                                   throws UserException,
                                          ServerException

Description copied from interface: ServiceInterface

Remove the given model checker from the given project

Specified by:

removeModelCheckerFromProject in interface ServiceInterface

Parameters:

poid - Project-ID

modelCheckerOid - Model Checker ID

Throws:

UserException

ServerException

removeServiceFromProject

public void removeServiceFromProject(Long poid,
                                     Long serviceOid)
                              throws UserException,
                                     ServerException

Description copied from interface: ServiceInterface

Remove the given service from the given project

Specified by:

removeServiceFromProject in interface ServiceInterface

Parameters:

poid - Project-ID

serviceOid - Service-ID

Throws:

UserException

ServerException

removeUserFromExtendedDataSchema

public void removeUserFromExtendedDataSchema(Long uoid,
                                             Long edsid)
                                      throws UserException,
                                             ServerException

Specified by:

removeUserFromExtendedDataSchema in interface ServiceInterface

Parameters:

uoid - ObjectID of the User

edsid - ObjectID of the ExtendedDataSchema

Throws:

UserException

ServerException

removeUserFromProject

public Boolean removeUserFromProject(Long uoid,
                                     Long poid)
                              throws UserException,
                                     ServerException

Description copied from interface: ServiceInterface

Remove a user from a project (authorization wise)

Specified by:

removeUserFromProject in interface ServiceInterface

Parameters:

uoid - ObjectID of the User

poid - ObjectID of the Project

Returns:

Whether the User has been removed from the Project

Throws:

UserException

ServerException

sendCompareEmail

public void sendCompareEmail(SCompareType sCompareType,
                             Long mcid,
                             Long poid,
                             Long roid1,
                             Long roid2,
                             String address)
                      throws UserException,
                             ServerException

Description copied from interface: ServiceInterface

Send an e-mail with the results of a compare

Specified by:

sendCompareEmail in interface ServiceInterface

Parameters:

sCompareType - How to compare (All, Only Added, Only Modified or Only Deleted)

poid - The ObjectID of the Project

roid1 - The ObjectID of the first Revision

roid2 - The ObjectID of the second Revision

address - The e-mail address to send the e-mail to

Throws:

UserException

ServerException

setRevisionTag

public void setRevisionTag(Long roid,
                           String tag)
                    throws UserException,
                           ServerException

Description copied from interface: ServiceInterface

Set a tag on a specific revision

Specified by:

setRevisionTag in interface ServiceInterface

Parameters:

roid - The Revision ObjectID

tag - Tag

Throws:

UserException

ServerException

shareRevision

public String shareRevision(Long roid)
                     throws UserException,
                            ServerException

Description copied from interface: ServiceInterface

Share a revision

Specified by:

shareRevision in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

triggerNewExtendedData

public void triggerNewExtendedData(Long edid,
                                   Long soid)
                            throws UserException,
                                   ServerException

Specified by:

triggerNewExtendedData in interface ServiceInterface

Throws:

UserException

ServerException

triggerNewRevision

public void triggerNewRevision(Long roid,
                               Long soid)
                        throws UserException,
                               ServerException

Specified by:

triggerNewRevision in interface ServiceInterface

Throws:

UserException

ServerException

undeleteUser

public Boolean undeleteUser(Long uoid)
                     throws UserException,
                            ServerException

Description copied from interface: ServiceInterface

Undelete a previously deleted User, Users can be deleted with the deleteUser method

Specified by:

undeleteUser in interface ServiceInterface

Returns:

Whether the deletion was successfull

Throws:

UserException

ServerException

updateGeoTag

public void updateGeoTag(SGeoTag sGeoTag)
                  throws UserException,
                         ServerException

Description copied from interface: ServiceInterface

Update the GeoTag of a project

Specified by:

updateGeoTag in interface ServiceInterface

Parameters:

sGeoTag - A GeoTag object containing the new properties

Throws:

UserException

ServerException

updateModelChecker

public void updateModelChecker(SModelCheckerInstance modelCheckerInstance)
                        throws UserException,
                               ServerException

Specified by:

updateModelChecker in interface ServiceInterface

Throws:

UserException

ServerException

updateProject

public void updateProject(SProject sProject)
                   throws UserException,
                          ServerException

Description copied from interface: ServiceInterface

Update project properties, the only three properties that can be updated with this call are "name", "description" and "exportLengthMeasurePrefix"

Specified by:

updateProject in interface ServiceInterface

Parameters:

sProject - A Project object containing the new properties

Throws:

UserException

ServerException

updateRevision

public void updateRevision(SRevision sRevision)
                    throws UserException,
                           ServerException

Description copied from interface: ServiceInterface

Update a revision, not much can be changed afterwards, actually only the tag

Specified by:

updateRevision in interface ServiceInterface

Parameters:

sRevision - The Revision object containing the new properties

Throws:

UserException

ServerException

uploadFile

public Long uploadFile(SFile file)
                throws UserException,
                       ServerException

Specified by:

uploadFile in interface ServiceInterface

Returns:

Throws:

UserException

ServerException

userHasCheckinRights

public Boolean userHasCheckinRights(Long uoid,
                                    Long poid)
                             throws UserException,
                                    ServerException

Description copied from interface: ServiceInterface

Check whether the given user has rights on the given project

Specified by:

userHasCheckinRights in interface ServiceInterface

poid - ObjectID of the Project

Returns:

Whether the current use has checkin rights on the given Project

Throws:

UserException

ServerException

userHasRights

public Boolean userHasRights(Long poid)
                      throws UserException,
                             ServerException

Description copied from interface: ServiceInterface

Returns whether the currents user has rights on the given project

Specified by:

userHasRights in interface ServiceInterface

Parameters:

poid - ObjectID of the Project

Returns:

Whether the current User has rights on the given Project

Throws:

UserException

ServerException

validateModelChecker

public void validateModelChecker(Long oid)
                          throws UserException,
                                 ServerException

Description copied from interface: ServiceInterface

Validate a model checker

Specified by:

validateModelChecker in interface ServiceInterface

Throws:

UserException

ServerException