ServiceInterface (PluginBase 1.5.107 API)

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

ServiceInterfaceAdaptor
```
public interface ServiceInterface
extends PublicInterface
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Long`	`addExtendedDataSchema(SExtendedDataSchema extendedDataSchema)` Add an extended data schema.
`void`	`addExtendedDataToProject(Long poid, SExtendedData extendedData)`
`void`	`addExtendedDataToRevision(Long roid, 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`	`addNewServiceToProject(Long poid, SNewService sService, SAction sAction)`
`SProject`	`addProject(String projectName, String schema)` Add a new project
`SProject`	`addProjectAsSubProject(String projectName, Long parentPoid, String schema)` Add a new project as a subproject of another 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
`String`	`bcfToJson(Long extendedDataId)`
`Long`	`branchToExistingProject(Long roid, Long destPoid, String comment, Boolean sync)` Branch a given Revision as a new Revision in the given Project, branching is always synchronous
`Long`	`branchToNewProject(Long roid, String projectName, String comment, Boolean sync)` Branch a given Revision as a new Revision on a new Project, branching is always synchronous
`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)`
`Boolean`	`checkInternetConnection()`
`Long`	`checkout(Long roid, Long serializerOid, Boolean sync)` Checkout an existing model, checkout is the same as download, except a "checkout" will tell the server and other users you are working on it
`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
`Boolean`	`deleteProject(Long poid)` Delete a Project, Projects can be undeleted with the undeleteProject method
`void`	`deleteService(Long oid)`
`Boolean`	`deleteUser(Long uoid)` Delete a User, Users van be undeleted with the undeleteUser method
`Long`	`download(Set<Long> roids, String query, Long serializerOid, Boolean sync)` Download a model in serialized format by giving a set of revisions and a set of class names to filter on
`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<SExtendedData>`	`getAllExtendedDataOfRevision(Long roid)`
`List<SExtendedData>`	`getAllExtendedDataOfRevisionAndSchema(Long roid, Long schemaId)`
`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<SNewService>`	`getAllNewServicesOfProject(Long poid)` Get a list of all the services 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)`
`List<SProject>`	`getAllProjects(Boolean onlyTopLevel, Boolean onlyActive)` Get a list of all Projects the user is authorized for
`List<SProjectSmall>`	`getAllProjectsSmall()`
`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(Boolean usePre)`
`List<SModelCheckerInstance>`	`getAllRepositoryModelCheckers()`
`List<SRevision>`	`getAllRevisionsByUser(Long uoid)` Get a list of revisions a user has committed
`List<SRevision>`	`getAllRevisionsOfProject(Long poid)` Get a list of all Revisions of a Project
`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
`SDensity`	`getDensityThreshold(Long roid, Long nrTriangles, Set<String> excludedTypes)`
`SDeserializerPluginConfiguration`	`getDeserializerById(Long oid)`
`SDeserializerPluginConfiguration`	`getDeserializerByName(String deserializerName)`
`SDownloadResult`	`getDownloadData(Long topicId)` Get the data for a download/checkout
`SExtendedData`	`getExtendedData(Long oid)`
`SExtendedDataSchema`	`getExtendedDataSchemaById(Long oid)`
`SExtendedDataSchema`	`getExtendedDataSchemaByName(String name)`
`SExtendedDataSchema`	`getExtendedDataSchemaFromRepository(String namespace)`
`SFile`	`getFile(Long fileId)`
`SFile`	`getFileMeta(Long fileId)`
`Set<Long>`	`getGeometryDataToReuse(Set<Long> roids, Set<String> excludedTypes, Integer trianglesToSave)`
`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
`SExtendedData`	`getLastExtendedDataOfRevisionAndSchema(Long roid, Long schemaId)`
`SBounds`	`getModelBounds(Long roid)`
`SBounds`	`getModelBoundsForConcreteRevision(Long croid)`
`SBounds`	`getModelBoundsUntransformed(Long roid)`
`SBounds`	`getModelBoundsUntransformedForConcreteRevision(Long croid)`
`SModelCheckerInstance`	`getModelCheckerInstance(Long mcioid)` Get a model checker instance by it's id
`SVector3f`	`getModelMaxBounds(Long roid)`
`SVector3f`	`getModelMinBounds(Long roid)`
`SNewService`	`getNewService(Long soid)`
`Long`	`getNrPrimitives(Long roid)`
`Long`	`getNrPrimitivesTotal(Set<Long> roids)`
`Long`	`getOidByGuid(Long roid, String guid)` Get the oid of the given GUID, will throw a UserException if the GUID was not found
`SProject`	`getProjectByPoid(Long poid)`
`List<SProject>`	`getProjectsByName(String name)`
`SProjectSmall`	`getProjectSmallByPoid(Long poid)`
`SQueryEnginePluginConfiguration`	`getQueryEngineById(Long oid)`
`SQueryEnginePluginConfiguration`	`getQueryEngineByName(String name)`
`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)
`SRevision`	`getRevision(Long roid)`
`SRevisionSummary`	`getRevisionSummary(Long roid)` Get a revision summary
`SSerializerPluginConfiguration`	`getSerializerByContentType(String contentType)`
`SSerializerPluginConfiguration`	`getSerializerById(Long oid)`
`SSerializerPluginConfiguration`	`getSerializerByName(String serializerName)`
`SService`	`getService(Long soid)`
`SServiceDescriptor`	`getServiceDescriptor(String baseUrl, String serviceIdentifier)`
`SProject`	`getSubProjectByName(Long parentProjectId, String name)`
`List<SProject>`	`getSubProjects(Long poid)`
`SDeserializerPluginConfiguration`	`getSuggestedDeserializerForExtension(String extension, Long poid)` Get a suggested deserializer for the given file extension and project
`List<Integer>`	`getTileCounts(Set<Long> roids, Set<String> excludedTypes, Set<Long> geometryIdsToReuse, Float minimumThreshold, Float maximumThreshold, Integer depth)`
`SProject`	`getTopLevelProjectByName(String name)`
`SBounds`	`getTotalBounds(Set<Long> roids)`
`SBounds`	`getTotalUntransformedBounds(Set<Long> roids)`
`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)`
`List<SBounds>`	`listBoundingBoxes(Set<Long> roids)`
`Long`	`regenerateGeometry(Long roid, Long eoid)`
`void`	`removeModelCheckerFromProject(Long poid, Long modelCheckerOid)` Remove the given model checker from the given project
`void`	`removeNewServiceFromProject(Long poid, Long serviceOid)` Remove the given service 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`	`terminateLongRunningAction(Long topicId)` Terminate a long running action
`void`	`triggerNewExtendedData(Long edid, Long soid)`
`void`	`triggerNewRevision(Long roid, Long soid)`
`void`	`triggerRevisionService(Long roid, Long soid)`
`Boolean`	`undeleteProject(Long poid)` Undelete a previously deleted Project, Projets can be deleted with the deleteProject method
`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

Method Detail

initiateCheckin

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

Throws:: ServerException; UserException

terminateLongRunningAction
```
void terminateLongRunningAction(Long topicId)
                         throws ServerException,
                                UserException
```
Terminate a long running action

Parameters:

topicId - The actionId returned by one of the download or checkout methods

Throws:

ServerException, - UserException

ServerException

UserException

checkout
```
Long checkout(Long roid,
              Long serializerOid,
              Boolean sync)
       throws ServerException,
              UserException
```
Checkout an existing model, checkout is the same as download, except a "checkout" will tell the server and other users you are working on it

Parameters:

roid - Revision ObjectID

serializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeres

sync - Whether to return immediately (async) or wait for completion (sync)

Returns:

A topicId, which you can use for the NotificationRegistryInterface.getProgress method

Throws:

ServerException, - UserException

ServerException

UserException

download
```
Long download(Set<Long> roids,
              String query,
              Long serializerOid,
              Boolean sync)
       throws ServerException,
              UserException
```
Download a model in serialized format by giving a set of revisions and a set of class names to filter on

Parameters:

roids - A set of Revision ObjectIDs

query - The query to use (JSON). If you are using the BIMserver API over JSON, make sure this is BASE64 encoded

serializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializers

sync - Whether to return immediately (async) or wait for completion (sync)

Returns:

A topicId, which you can use for the NotificationRegistryInterface.getProgress method, ServiceInterface.getDownloadData and the download servlet (/download)

Throws:

ServerException, - UserException

ServerException

UserException

getDownloadData
```
SDownloadResult getDownloadData(Long topicId)
                         throws ServerException,
                                UserException
```
Get the data for a download/checkout

Parameters:

topicId - The topicId returned by one of the download or checkout methods

Returns:

An SDownloadResult containing the serialized data

Throws:

ServerException, - UserException

ServerException

UserException

getSerializerByName

SSerializerPluginConfiguration getSerializerByName(String serializerName)
                                            throws ServerException,
                                                   UserException

Parameters:: serializerName - Name of the Serializer
Returns:: Serializer
Throws:: ServerException, - UserException; ServerException; UserException

getDeserializerById

SDeserializerPluginConfiguration getDeserializerById(Long oid)
                                              throws ServerException,
                                                     UserException

Parameters:: oid - ObjectID of the Deserializer
Returns:: Deserializer
Throws:: ServerException, - UserException; ServerException; UserException

getDeserializerByName

SDeserializerPluginConfiguration getDeserializerByName(String deserializerName)
                                                throws ServerException,
                                                       UserException

Parameters:: deserializerName - Name of the Deserializer
Returns:: Deserializer
Throws:: ServerException, - UserException; ServerException; UserException

getSerializerById

SSerializerPluginConfiguration getSerializerById(Long oid)
                                          throws ServerException,
                                                 UserException

Parameters:: oid - ObjectID of the Serializer
Returns:: Serializer
Throws:: ServerException, - UserException; ServerException; UserException

getSerializerByContentType

SSerializerPluginConfiguration getSerializerByContentType(String contentType)
                                                   throws ServerException,
                                                          UserException

Parameters:: contentType - The ContentType
Returns:: Serializer supporting the given ContentType
Throws:: ServerException, - UserException; ServerException; UserException

getQueryEngineByName

SQueryEnginePluginConfiguration getQueryEngineByName(String name)
                                              throws ServerException,
                                                     UserException

Parameters:: name - Name of the QueryEngine
Returns:: QueryEngine
Throws:: ServerException, - UserException; ServerException; UserException

getQueryEngineById

SQueryEnginePluginConfiguration getQueryEngineById(Long oid)
                                            throws ServerException,
                                                   UserException

Parameters:: oid - ObjectID of the QueryEngine
Returns:: QueryEngine
Throws:: ServerException, - UserException; ServerException; UserException

getSuggestedDeserializerForExtension

SDeserializerPluginConfiguration getSuggestedDeserializerForExtension(String extension,
                                                                      Long poid)
                                                               throws ServerException,
                                                                      UserException

Get a suggested deserializer for the given file extension and project

Parameters:: extension - File extension without the dot(.), for example "ifc"; poid - ProjectID of the project, this is relevant because a project has a specific schema, so we are looking for a deserializer that can handle this schema
Returns:: The name of the suggested deserializer
Throws:: ServerException; UserException

addExtendedDataToRevision

void addExtendedDataToRevision(Long roid,
                               SExtendedData extendedData)
                        throws ServerException,
                               UserException

Parameters:: roid - ObjectID of the Revision; extendedData - ExtendedData to add
Throws:: ServerException, - UserException; ServerException; UserException

getExtendedData

SExtendedData getExtendedData(Long oid)
                       throws ServerException,
                              UserException

Parameters:: oid - ObjectID of the ExtendedData
Returns:: ExtendedData
Throws:: ServerException, - UserException; ServerException; UserException

getAllExtendedDataOfRevision

List<SExtendedData> getAllExtendedDataOfRevision(Long roid)
                                          throws ServerException,
                                                 UserException

Parameters:: roid - ObjectID of the Revision
Returns:: ExtendedData
Throws:: ServerException, - UserException; ServerException; UserException

getAllExtendedDataOfRevisionAndSchema

List<SExtendedData> getAllExtendedDataOfRevisionAndSchema(Long roid,
                                                          Long schemaId)
                                                   throws ServerException,
                                                          UserException

Parameters:: roid - ObjectID of the Revision
Returns:: ExtendedData
Throws:: ServerException, - UserException; ServerException; UserException

getLastExtendedDataOfRevisionAndSchema

SExtendedData getLastExtendedDataOfRevisionAndSchema(Long roid,
                                                     Long schemaId)
                                              throws ServerException,
                                                     UserException

Parameters:: roid - ObjectID of the Revision
Returns:: ExtendedData
Throws:: ServerException, - UserException; ServerException; UserException

getProjectByPoid

SProject getProjectByPoid(Long poid)
                   throws ServerException,
                          UserException

Parameters:: poid - ObjectID of the Project
Returns:: The Project
Throws:: ServerException, - UserException; ServerException; UserException

getProjectSmallByPoid

SProjectSmall getProjectSmallByPoid(Long poid)
                             throws ServerException,
                                    UserException

Parameters:: poid - ObjectID of the Project
Returns:: The Project
Throws:: ServerException, - UserException; ServerException; UserException

getRevision
```
SRevision getRevision(Long roid)
               throws ServerException,
                      UserException
```
Parameters:

roid - ObjectID of the Revision

Returns:

The Revision

Throws:

ServerException, - UserException

ServerException

UserException

undeleteProject
```
Boolean undeleteProject(Long poid)
                 throws ServerException,
                        UserException
```
Undelete a previously deleted Project, Projets can be deleted with the deleteProject method

Parameters:

poid - The ObjectID of the Project to undelete

Returns:

Whether the Project was successfully undeleted

Throws:

ServerException, - UserException

ServerException

UserException

branchToNewProject
```
Long branchToNewProject(Long roid,
                        String projectName,
                        String comment,
                        Boolean sync)
                 throws ServerException,
                        UserException
```
Branch a given Revision as a new Revision on a new Project, branching is always synchronous

Parameters:

roid - ObjectID of the Revision to branch

projectName - Name of the to be created Project

comment - A comment describing the new Revision

Returns:

The result of this branch, you can use getCheckinState with this ID

Throws:

ServerException, - UserException

ServerException

UserException

branchToExistingProject
```
Long branchToExistingProject(Long roid,
                             Long destPoid,
                             String comment,
                             Boolean sync)
                      throws ServerException,
                             UserException
```
Branch a given Revision as a new Revision in the given Project, branching is always synchronous

Parameters:

roid - ObjectID of the Revision to branch

destPoid - ObjectID of the Project to which a branch should be made

comment - A comment describing the new Revision

Returns:

The result of this branch, you can use getCheckinState with this ID

Throws:

ServerException, - UserException

ServerException

UserException

getProjectsByName
```
List<SProject> getProjectsByName(String name)
                          throws ServerException,
                                 UserException
```
Parameters:

name -

Returns:

A list of projects with the given name (can be multiple because subprojects are also returned)

Throws:

ServerException, - UserException

ServerException

UserException

getTopLevelProjectByName
```
SProject getTopLevelProjectByName(String name)
                           throws ServerException,
                                  UserException
```
Parameters:

name -

Returns:

Get the (top level) project with the given name, there can be only one, because top-level projects always are unique

Throws:

ServerException, - UserException

ServerException

UserException

getSubProjects

List<SProject> getSubProjects(Long poid)
                       throws ServerException,
                              UserException

Parameters:: poid -
Returns:: A list of all subprojects of the given project
Throws:: ServerException, - UserException; ServerException; UserException

getExtendedDataSchemaById

SExtendedDataSchema getExtendedDataSchemaById(Long oid)
                                       throws ServerException,
                                              UserException

Parameters:: oid - ObjectID of the ExtendedDataSchema
Returns:: ExtendedDataSchema
Throws:: ServerException, - UserException; ServerException; UserException

getAllRevisionsOfProject

List<SRevision> getAllRevisionsOfProject(Long poid)
                                  throws ServerException,
                                         UserException

Get a list of all Revisions of a Project

Parameters:: poid - ObjectID of the Project
Returns:: A list of all Revisions
Throws:: ServerException, - UserException; ServerException; UserException

getAllProjects

List<SProject> getAllProjects(Boolean onlyTopLevel,
                              Boolean onlyActive)
                       throws ServerException,
                              UserException

Get a list of all Projects the user is authorized for

Returns:: A list of Projects
Throws:: ServerException, - UserException; ServerException; UserException

addProject
```
SProject addProject(String projectName,
                    String schema)
             throws ServerException,
                    UserException
```
Add a new project

Parameters:

projectName - Name of the project, must be a unique name within all root-projects

schema - Schema of the project, you can only checkin models of this schema (available options are: "ifc2x3tc1" and "ifc4")

Returns:

The created Project

Throws:

ServerException, - UserException

ServerException

UserException

addProjectAsSubProject

SProject addProjectAsSubProject(String projectName,
                                Long parentPoid,
                                String schema)
                         throws ServerException,
                                UserException

Add a new project as a subproject of another project

Parameters:: projectName - Name of the project, must be a unique name within the parent project; parentPoid - The ObjectID of the parent project
Returns:: The created Project
Throws:: ServerException, - UserException; ServerException; UserException

deleteProject
```
Boolean deleteProject(Long poid)
               throws ServerException,
                      UserException
```
Delete a Project, Projects can be undeleted with the undeleteProject method

Parameters:

poid - ObjectID of the Project to delete

Returns:

Whether the Project has been deleted

Throws:

ServerException, - UserException

ServerException

UserException

getExtendedDataSchemaByName

SExtendedDataSchema getExtendedDataSchemaByName(String name)
                                         throws UserException,
                                                ServerException

Throws:: UserException; ServerException

getAllProjectsSmall

List<SProjectSmall> getAllProjectsSmall()
                                 throws ServerException,
                                        UserException

Throws:: ServerException; UserException

checkin
```
Long checkin(Long poid,
             String comment,
             Long deserializerOid,
             Long fileSize,
             String fileName,
             DataHandler data,
             Boolean merge,
             Boolean sync)
      throws ServerException,
             UserException
```
Checkin a new model by sending a serialized form

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:

ServerException, - UserException

ServerException

UserException

checkinInitiated

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

Throws:: ServerException; UserException

checkinFromUrl
```
Long checkinFromUrl(Long poid,
                    String comment,
                    Long deserializerOid,
                    String fileName,
                    String url,
                    Boolean merge,
                    Boolean sync)
             throws ServerException,
                    UserException
```
Checkin a new model by sending a serialized form

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:

ServerException, - UserException

ServerException

UserException

downloadCompareResults
```
Long downloadCompareResults(Long serializerOid,
                            Long roid1,
                            Long roid2,
                            Long mcid,
                            SCompareType type,
                            Boolean sync)
                     throws ServerException,
                            UserException
```
Download a compare of a model

Parameters:

serializerOid - The ObjectID of the Serializer configuration to use

roid1 - The ObjectID of the first Revision

roid2 - The ObjectID of the second Revision

mcid - The ObjectID of the Model Compare plugin configuration

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

sync - Whether to call this method synchronously

Returns:

A topicId, which you can use for the NotificationRegistryInterface.getProgress method, ServiceInterface.getDownloadData and the download servlet (/download)

Throws:

ServerException, - UserException

ServerException

UserException

addUser
```
SUser addUser(String username,
              String name,
              SUserType type,
              Boolean selfRegistration,
              String resetUrl)
       throws ServerException,
              UserException
```
Add a new user

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:

ServerException, - UserException

ServerException

UserException

addUserWithPassword

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

Add a new user with a given password

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:: ServerException, - UserException; ServerException; UserException

changeUserType

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

Change the type of a user

Parameters:: uoid - The User's ObjectID; userType - The new type
Throws:: ServerException, - UserException; ServerException; UserException

updateProject
```
void updateProject(SProject sProject)
            throws ServerException,
                   UserException
```
Update project properties, the only three properties that can be updated with this call are "name", "description" and "exportLengthMeasurePrefix"

Parameters:

sProject - A Project object containing the new properties

Throws:

ServerException, - UserException

ServerException

UserException

updateRevision
```
void updateRevision(SRevision sRevision)
             throws ServerException,
                    UserException
```
Update a revision, not much can be changed afterwards, actually only the tag

Parameters:

sRevision - The Revision object containing the new properties

Throws:

ServerException, - UserException

ServerException

UserException

addUserToProject
```
Boolean addUserToProject(Long uoid,
                         Long poid)
                  throws ServerException,
                         UserException
```
Add a user to a project (authorization wise)

Parameters:

uoid - The ObejctID of the User

poid - The ObjectID of the Project

Returns:

Whether the User has been added to the Project

Throws:

ServerException, - UserException

ServerException

UserException

removeUserFromProject
```
Boolean removeUserFromProject(Long uoid,
                              Long poid)
                       throws ServerException,
                              UserException
```
Remove a user from a project (authorization wise)

Parameters:

uoid - ObjectID of the User

poid - ObjectID of the Project

Returns:

Whether the User has been removed from the Project

Throws:

ServerException, - UserException

ServerException

UserException

deleteUser
```
Boolean deleteUser(Long uoid)
            throws ServerException,
                   UserException
```
Delete a User, Users van be undeleted with the undeleteUser method

Parameters:

uoid - ObjectID of the User

Returns:

Whether the User has been deleted

Throws:

ServerException, - UserException

ServerException

UserException

getAllReadableProjects
```
List<SProject> getAllReadableProjects()
                               throws ServerException,
                                      UserException
```
Get a list of all Projects the user is authorized for to read from

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

getAllWritableProjects
```
List<SProject> getAllWritableProjects()
                               throws ServerException,
                                      UserException
```
Get a list of all Projects the user is authorized for to write to

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

getAllUsers

List<SUser> getAllUsers()
                 throws ServerException,
                        UserException

Get a list of all users

Returns:: All users
Throws:: ServerException; UserException

getAllServicesOfProject

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

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

Parameters:: poid - Project-ID of the Project
Returns:
Throws:: ServerException; UserException

getAllNewServicesOfProject

List<SNewService> getAllNewServicesOfProject(Long poid)
                                      throws ServerException,
                                             UserException

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

Parameters:: poid - Project-ID of the Project
Returns:
Throws:: ServerException; UserException

getAllModelCheckersOfProject

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

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

Parameters:: poid - Project-ID of the Project
Returns:
Throws:: ServerException; UserException

getAllCheckoutsOfProject
```
List<SCheckout> getAllCheckoutsOfProject(Long poid)
                                  throws ServerException,
                                         UserException
```
Get all checkouts of the given project

Parameters:

poid - The ObjectID of the Project

Returns:

A list of Checkouts belonging to this Project

Throws:

ServerException, - UserException

ServerException

UserException

getAllRevisionsByUser
```
List<SRevision> getAllRevisionsByUser(Long uoid)
                               throws ServerException,
                                      UserException
```
Get a list of revisions a user has committed

Parameters:

uoid - ObjectID of the Project

Returns:

A list of Revisions belonging to this Project

Throws:

ServerException, - UserException

ServerException

UserException

getAllCheckoutsByUser
```
List<SCheckout> getAllCheckoutsByUser(Long uoid)
                               throws ServerException,
                                      UserException
```
Get a list of checkouts by the given user

Parameters:

uoid - ObjectID of the User

Returns:

A list of Checkouts belonging to the given User

Throws:

ServerException, - UserException

ServerException

UserException

getAllCheckoutsOfRevision
```
List<SCheckout> getAllCheckoutsOfRevision(Long roid)
                                   throws ServerException,
                                          UserException
```
Get a list of checkouts on the given revision

Parameters:

roid - ObjectID of the Revision

Returns:

A list of Checkouts belonging to the given Revision

Throws:

ServerException, - UserException

ServerException

UserException

getAvailableClasses
```
List<String> getAvailableClasses()
                          throws ServerException,
                                 UserException
```
Returns a list of all available classes

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

getAvailableClassesInRevision
```
List<String> getAvailableClassesInRevision(Long roid)
                                    throws ServerException,
                                           UserException
```
Returns a list of all the classes that are used in the given revision

Parameters:

roid - ObjectID of the Revision

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

getAllNonAuthorizedProjectsOfUser

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

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

Parameters:: uoid -
Returns:: The list of Users
Throws:: ServerException, - UserException; ServerException; UserException

getUserByUserName
```
SUser getUserByUserName(String username)
                 throws ServerException,
                        UserException
```
Get a User by its UserNmae (e-mail address)

Parameters:

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

Returns:

The SUser Object if found, otherwise null

Throws:

ServerException, - UserException

ServerException

UserException

undeleteUser
```
Boolean undeleteUser(Long uoid)
              throws ServerException,
                     UserException
```
Undelete a previously deleted User, Users can be deleted with the deleteUser method

Parameters:

uoid -

Returns:

Whether the deletion was successfull

Throws:

ServerException, - UserException

ServerException

UserException

compare
```
SCompareResult compare(Long roid1,
                       Long roid2,
                       SCompareType sCompareType,
                       Long mcid)
                throws ServerException,
                       UserException
```
Compare two models

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)

mcid - The ObjectID of the Model Compare plugin configuration

Returns:

The result of the compare as an SCompareResult object, consisting of a List of SCompareContainer objects

Throws:

ServerException, - UserException

ServerException

UserException

getRevisionSummary

SRevisionSummary getRevisionSummary(Long roid)
                             throws ServerException,
                                    UserException

Get a revision summary

Parameters:: roid - ObjectID of the Revision
Returns:: A summary of the given Revision
Throws:: ServerException, - UserException; ServerException; UserException

userHasCheckinRights
```
Boolean userHasCheckinRights(Long uoid,
                             Long poid)
                      throws ServerException,
                             UserException
```
Check whether the given user has rights on the given project

Parameters:

poid - ObjectID of the Project

Returns:

Whether the current use has checkin rights on the given Project

Throws:

ServerException, - UserException

ServerException

UserException

getCheckoutWarnings
```
Set<String> getCheckoutWarnings(Long poid)
                         throws ServerException,
                                UserException
```
Checkout warnings are given to users when checkouts are done by other users

Parameters:

poid - ObjectID of the Project

Returns:

A set of String containing possible warnings for this Project

Throws:

ServerException, - UserException

ServerException

UserException

userHasRights
```
Boolean userHasRights(Long poid)
               throws ServerException,
                      UserException
```
Returns whether the currents user has rights on the given project

Parameters:

poid - ObjectID of the Project

Returns:

Whether the current User has rights on the given Project

Throws:

ServerException, - UserException

ServerException

UserException

getGeoTag
```
SGeoTag getGeoTag(Long goid)
           throws ServerException,
                  UserException
```
Get the GeoTag attached to the given Project

Parameters:

goid - The ObjectID of the GeoTag

Returns:

The GeoTag object

Throws:

ServerException, - UserException

ServerException

UserException

updateGeoTag
```
void updateGeoTag(SGeoTag sGeoTag)
           throws ServerException,
                  UserException
```
Update the GeoTag of a project

Parameters:

sGeoTag - A GeoTag object containing the new properties

Throws:

ServerException, - UserException

ServerException

UserException

getUserByUoid
```
SUser getUserByUoid(Long uoid)
             throws ServerException,
                    UserException
```
Get a user by its User ObjectID

Parameters:

uoid - The ObjectID of the User

Returns:

The User with the given User ObjectID

Throws:

ServerException, - UserException

ServerException

UserException

getAllNonAuthorizedUsersOfProject

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

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

Parameters:: poid - The ObjectID of the Project
Returns:: A list of Users
Throws:: ServerException, - UserException; ServerException; UserException

getAllAuthorizedUsersOfProject
```
List<SUser> getAllAuthorizedUsersOfProject(Long poid)
                                    throws ServerException,
                                           UserException
```
Get a list of users that have been authorized on the given project

Parameters:

poid -

Returns:

A list of all users authorized on the given project

Throws:

ServerException, - UserException

ServerException

UserException

getUsersProjects
```
List<SProject> getUsersProjects(Long uoid)
                         throws ServerException,
                                UserException
```
Get a list of projects a user is authorized on

Parameters:

uoid -

Returns:

A list of projects a user has been authorized for

Throws:

ServerException, - UserException

ServerException

UserException

setRevisionTag

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

Set a tag on a specific revision

Parameters:: roid - The Revision ObjectID; tag - Tag
Throws:: ServerException, - UserException; ServerException; UserException

getAllCheckoutsOfProjectAndSubProjects

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

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

Parameters:: poid - Project-ID of the given Project
Returns:
Throws:: ServerException; UserException

sendCompareEmail

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

Send an e-mail with the results of a compare

Parameters:: sCompareType - How to compare (All, Only Added, Only Modified or Only Deleted); sCompareIdentifier - How to identify equal objects (by Guid or by Name); 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:: ServerException, - UserException; ServerException; UserException

getQueryEngineExampleKeys
```
List<String> getQueryEngineExampleKeys(Long qeid)
                                throws ServerException,
                                       UserException
```
Get a list of query engine example keys (which you can then use for getQueryEngineExample)

Parameters:

onlyEnabled - Whether to only include enabled query engines

Returns:

A list of QueryEngines

Throws:

ServerException, - UserException

ServerException

UserException

getQueryEngineExample
```
String getQueryEngineExample(Long qeid,
                             String key)
                      throws ServerException,
                             UserException
```
Returns a query engine example (get the key from getQueryEngineExampleKeys)

Parameters:

onlyEnabled - Whether to only include enabled query engines

Returns:

A list of QueryEngines

Throws:

ServerException, - UserException

ServerException

UserException

addExtendedDataSchema

Long addExtendedDataSchema(SExtendedDataSchema extendedDataSchema)
                    throws ServerException,
                           UserException

Add an extended data schema.

Parameters:: extendedDataSchema - ExtendedDataSchema to add
Throws:: ServerException, - UserException; ServerException; UserException

addUserToExtendedDataSchema

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

Parameters:: uoid - ObjectID of the User; edsid - ObjectID of the ExtendedDataSchema
Throws:: UserException; ServerException, - UserException; ServerException

removeUserFromExtendedDataSchema

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

Parameters:: uoid - ObjectID of the User; edsid - ObjectID of the ExtendedDataSchema
Throws:: UserException; ServerException, - UserException; ServerException

getExtendedDataSchemaFromRepository

SExtendedDataSchema getExtendedDataSchemaFromRepository(String namespace)
                                                 throws UserException,
                                                        ServerException

Throws:: UserException; ServerException

addExtendedDataToProject

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

Parameters:: roid - ObjectID of the Revision; extendedData - ExtendedData to add
Throws:: ServerException, - UserException; ServerException; UserException

getCheckinWarnings
```
Set<String> getCheckinWarnings(Long poid)
                        throws ServerException,
                               UserException
```
Checkin warnings are given to users

Parameters:

poid - ObjectID of the Project

Returns:

A set of String containing possible warnings for this Project

Throws:

ServerException, - UserException

ServerException

UserException

getAllExtendedDataSchemas

List<SExtendedDataSchema> getAllExtendedDataSchemas()
                                             throws ServerException,
                                                    UserException

Returns:
Throws:: ServerException; UserException

getServiceDescriptor

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

Parameters:: baseUrl -; serviceIdentifier -
Returns:
Throws:: ServerException; UserException

getAllServiceDescriptors

List<SServiceDescriptor> getAllServiceDescriptors()
                                           throws ServerException,
                                                  UserException

Returns:
Throws:: ServerException; UserException

getAllRepositoryExtendedDataSchemas

List<SExtendedDataSchema> getAllRepositoryExtendedDataSchemas(Boolean usePre)
                                                       throws ServerException,
                                                              UserException

Returns:
Throws:: ServerException; UserException

getAllRepositoryModelCheckers

List<SModelCheckerInstance> getAllRepositoryModelCheckers()
                                                   throws ServerException,
                                                          UserException

Returns:
Throws:: ServerException; UserException

getAllPublicProfiles

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

Parameters:: notificationsUrl -; serviceIdentifier -
Returns:
Throws:: ServerException; UserException

addServiceToProject

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

Parameters:: poid -; sService -
Returns:
Throws:: ServerException; UserException

deleteService

void deleteService(Long oid)
            throws ServerException,
                   UserException

Parameters:: oid -
Throws:: ServerException; UserException

getService

SService getService(Long soid)
             throws ServerException,
                    UserException

Parameters:: soid -
Returns:
Throws:: ServerException; UserException

getNewService

SNewService getNewService(Long soid)
                   throws ServerException,
                          UserException

Parameters:: soid -
Returns:
Throws:: ServerException; UserException

getAllPrivateProfiles

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

Parameters:: notificationsUrl -; serviceIdentifier -; token -
Returns:
Throws:: ServerException; UserException

uploadFile

Long uploadFile(SFile file)
         throws ServerException,
                UserException

Parameters:: file -
Returns:
Throws:: ServerException; UserException

getFile

SFile getFile(Long fileId)
       throws ServerException,
              UserException

Parameters:: fileId -
Returns:
Throws:: ServerException; UserException

getFileMeta

SFile getFileMeta(Long fileId)
           throws ServerException,
                  UserException

Parameters:: fileId -
Returns:
Throws:: ServerException; UserException

triggerNewRevision

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

Parameters:: roid -; soid -
Throws:: ServerException; UserException

triggerRevisionService

void triggerRevisionService(Long roid,
                            Long soid)
                     throws ServerException,
                            UserException

Parameters:: roid -; soid -
Throws:: ServerException; UserException

triggerNewExtendedData

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

Parameters:: edid -; soid -
Throws:: ServerException; UserException

getAllLocalServiceDescriptors

List<SServiceDescriptor> getAllLocalServiceDescriptors()
                                                throws ServerException,
                                                       UserException

Returns:
Throws:: ServerException; UserException

getAllLocalProfiles

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

Parameters:: serviceIdentifier -
Returns:
Throws:: ServerException; UserException

addLocalServiceToProject

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

Add a local service to a project

Parameters:: poid -; sService -; internalServiceOid -
Throws:: ServerException; UserException

shareRevision

String shareRevision(Long roid)
              throws UserException,
                     ServerException

Share a revision

Parameters:: roid -
Returns:
Throws:: UserException; ServerException

getOidByGuid
```
Long getOidByGuid(Long roid,
                  String guid)
           throws ServerException,
                  UserException
```
Get the oid of the given GUID, will throw a UserException if the GUID was not found

Parameters:

roid - Revision in which to look

guid - GUID

Returns:

Throws:

ServerException

UserException

cleanupLongAction
```
void cleanupLongAction(Long topicId)
                throws UserException,
                       ServerException
```
Cleanup a long running action, this is important to keep memory usage of BIMserver down

Parameters:

topicId -

Throws:

UserException

ServerException

getUserSettings

SUserSettings getUserSettings()
                       throws ServerException,
                              UserException

Get the user settings of the current user

Returns:
Throws:: ServerException; UserException

getUserRelatedLogs

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

Get all log entries linked to the given user

Parameters:: uoid -
Returns:
Throws:: ServerException; UserException

getAllRelatedProjects
```
List<SProjectSmall> getAllRelatedProjects(Long poid)
                                   throws ServerException,
                                          UserException
```
Get a list of a project's related projects. Will search through all the parent/child relations, recursively

Parameters:

poid - The projectID of the project

Returns:

Throws:

ServerException

UserException

getAllModelCheckers

List<SModelCheckerInstance> getAllModelCheckers()
                                         throws UserException,
                                                ServerException

Get all model checkers

Returns:: A list of model checkers
Throws:: UserException; ServerException

addModelChecker

Long addModelChecker(SModelCheckerInstance modelCheckerInstance)
              throws UserException,
                     ServerException

Parameters:: modelCheckerInstance -
Returns:
Throws:: UserException; ServerException

updateModelChecker

void updateModelChecker(SModelCheckerInstance modelCheckerInstance)
                 throws UserException,
                        ServerException

Parameters:: modelCheckerInstance -
Throws:: UserException; ServerException

validateModelChecker

void validateModelChecker(Long oid)
                   throws UserException,
                          ServerException

Validate a model checker

Parameters:: oid -
Throws:: UserException; ServerException

addModelCheckerToProject

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

Add a model checker to a project

Parameters:: poid - Project-ID; modelCheckerOid - ModelChecker ID
Throws:: ServerException; UserException

getModelCheckerInstance

SModelCheckerInstance getModelCheckerInstance(Long mcioid)
                                       throws UserException,
                                              ServerException

Get a model checker instance by it's id

Parameters:: mcioid -
Returns:
Throws:: UserException; ServerException

removeModelCheckerFromProject

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

Remove the given model checker from the given project

Parameters:: poid - Project-ID; modelCheckerOid - Model Checker ID
Throws:: ServerException; UserException

removeServiceFromProject

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

Remove the given service from the given project

Parameters:: poid - Project-ID; serviceOid - Service-ID
Throws:: ServerException; UserException

removeNewServiceFromProject

void removeNewServiceFromProject(Long poid,
                                 Long serviceOid)
                          throws ServerException,
                                 UserException

Remove the given service from the given project

Parameters:: poid - Project-ID; serviceOid - Service-ID
Throws:: ServerException; UserException

importData
```
void importData(String address,
                String username,
                String password,
                String path)
         throws ServerException,
                UserException
```
Import data from another BIMserver, mainly used for migrations. EXPERIMENTAL CODE!

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:

ServerException

UserException

getIfcHeader

SIfcHeader getIfcHeader(Long croid)
                 throws UserException,
                        ServerException

Get the IfcHeader of the given ConcreteRevision-ID

Parameters:: croid -
Returns:
Throws:: UserException; ServerException

getArea
```
Double getArea(Long roid,
               Long oid)
        throws UserException,
               ServerException
```
Get the area of the given object

Parameters:

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

oid - Object-ID of the object

Returns:

Throws:

UserException

ServerException

getVolume
```
Double getVolume(Long roid,
                 Long oid)
          throws UserException,
                 ServerException
```
Get the volume of the given object

Parameters:

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

oid - Object-ID of the object

Returns:

Throws:

UserException

ServerException

getGeometryInfo

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

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

getNrPrimitives

Long getNrPrimitives(Long roid)
              throws ServerException,
                     UserException

Throws:: ServerException; UserException

getNrPrimitivesTotal

Long getNrPrimitivesTotal(Set<Long> roids)
                   throws ServerException,
                          UserException

Throws:: ServerException; UserException

addNewServiceToProject

Long addNewServiceToProject(Long poid,
                            SNewService sService,
                            SAction sAction)
                     throws ServerException,
                            UserException

Parameters:: poid -; sService -
Returns:
Throws:: ServerException; UserException

bcfToJson

String bcfToJson(Long extendedDataId)
          throws ServerException,
                 UserException

Throws:: ServerException; UserException

getSubProjectByName

SProject getSubProjectByName(Long parentProjectId,
                             String name)
                      throws UserException,
                             ServerException

Parameters:: name -
Returns:: A list of projects with the given name (can be multiple because subprojects are also returned)
Throws:: UserException; ServerException, - UserException; ServerException

checkInternetConnection

Boolean checkInternetConnection()
                         throws UserException,
                                ServerException

Throws:: UserException; ServerException

getTotalBounds

SBounds getTotalBounds(Set<Long> roids)
                throws ServerException,
                       UserException

Throws:: ServerException; UserException

getTotalUntransformedBounds

SBounds getTotalUntransformedBounds(Set<Long> roids)
                             throws ServerException,
                                    UserException

Throws:: ServerException; UserException

getModelMinBounds

SVector3f getModelMinBounds(Long roid)
                     throws ServerException,
                            UserException

Throws:: ServerException; UserException

getModelMaxBounds

SVector3f getModelMaxBounds(Long roid)
                     throws ServerException,
                            UserException

Throws:: ServerException; UserException

getModelBounds

SBounds getModelBounds(Long roid)
                throws ServerException,
                       UserException

Throws:: ServerException; UserException

getModelBoundsForConcreteRevision

SBounds getModelBoundsForConcreteRevision(Long croid)
                                   throws ServerException,
                                          UserException

Throws:: ServerException; UserException

regenerateGeometry

Long regenerateGeometry(Long roid,
                        Long eoid)
                 throws ServerException,
                        UserException

Throws:: ServerException; UserException

getModelBoundsUntransformed

SBounds getModelBoundsUntransformed(Long roid)
                             throws ServerException,
                                    UserException

Throws:: ServerException; UserException

getModelBoundsUntransformedForConcreteRevision

SBounds getModelBoundsUntransformedForConcreteRevision(Long croid)
                                                throws ServerException,
                                                       UserException

Throws:: ServerException; UserException

getDensityThreshold

SDensity getDensityThreshold(Long roid,
                             Long nrTriangles,
                             Set<String> excludedTypes)
                      throws ServerException,
                             UserException

Throws:: ServerException; UserException

getTileCounts

List<Integer> getTileCounts(Set<Long> roids,
                            Set<String> excludedTypes,
                            Set<Long> geometryIdsToReuse,
                            Float minimumThreshold,
                            Float maximumThreshold,
                            Integer depth)
                     throws ServerException,
                            UserException

Throws:: ServerException; UserException

getGeometryDataToReuse

Set<Long> getGeometryDataToReuse(Set<Long> roids,
                                 Set<String> excludedTypes,
                                 Integer trianglesToSave)
                          throws UserException,
                                 ServerException

Throws:: UserException; ServerException

listBoundingBoxes

List<SBounds> listBoundingBoxes(Set<Long> roids)
                         throws ServerException,
                                UserException

Throws:: ServerException; UserException

Interface ServiceInterface

Method Summary

Method Detail

initiateCheckin

terminateLongRunningAction

checkout

download

getDownloadData

getSerializerByName

getDeserializerById

getDeserializerByName

getSerializerById

getSerializerByContentType

getQueryEngineByName

getQueryEngineById

getSuggestedDeserializerForExtension

addExtendedDataToRevision

getExtendedData

getAllExtendedDataOfRevision

getAllExtendedDataOfRevisionAndSchema

getLastExtendedDataOfRevisionAndSchema

getProjectByPoid

getProjectSmallByPoid

getRevision

undeleteProject

branchToNewProject

branchToExistingProject

getProjectsByName

getTopLevelProjectByName

getSubProjects

getExtendedDataSchemaById

getAllRevisionsOfProject

getAllProjects

addProject

addProjectAsSubProject

deleteProject

getExtendedDataSchemaByName

getAllProjectsSmall

checkin

checkinInitiated

checkinFromUrl

downloadCompareResults

addUser

addUserWithPassword

changeUserType

updateProject

updateRevision

addUserToProject

removeUserFromProject

deleteUser

getAllReadableProjects

getAllWritableProjects

getAllUsers

getAllServicesOfProject

getAllNewServicesOfProject

getAllModelCheckersOfProject

getAllCheckoutsOfProject

getAllRevisionsByUser

getAllCheckoutsByUser

getAllCheckoutsOfRevision

getAvailableClasses

getAvailableClassesInRevision

getAllNonAuthorizedProjectsOfUser

getUserByUserName

undeleteUser

compare

getRevisionSummary

userHasCheckinRights

getCheckoutWarnings

userHasRights

getGeoTag

updateGeoTag

getUserByUoid

getAllNonAuthorizedUsersOfProject

getAllAuthorizedUsersOfProject

getUsersProjects

setRevisionTag

getAllCheckoutsOfProjectAndSubProjects

sendCompareEmail

getQueryEngineExampleKeys