ServiceInterface (PluginBase 1.5.6 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`	`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

Method Detail

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

initiateCheckin
```
Long initiateCheckin(Long poid,
                     Long deserializerOid)
              throws ServerException,
                     UserException
```
Start uploading a new model, the main reason for this call is to get a TopicID, which you can use to get progress updates

Parameters:

poid - ProjectID of the project you want to upload to

comment - Comment of this checkin

deserializerOid - Deserializer OID

Returns:

Throws:

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:: roid1 -; roid2 -; identifier -; type -; sync -
Returns:: An id, which you can use for the getDownloadState and getDownloadData methods
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

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)

sCompareIdentifier - How to identify equal objects (by Guid or by Name)

Returns:

The result of the compare

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()
                                                       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

getAllPrivateProfiles

List<SProfileDescriptor> getAllPrivateProfiles(String notificationsUrl,
                                               String serviceIdentifier,
                                               String token)
                                        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

triggerNewRevision

void triggerNewRevision(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

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

Interface ServiceInterface

Method Summary

Method Detail

checkin

initiateCheckin

checkinInitiated

checkinFromUrl

downloadCompareResults

addUser

addUserWithPassword

changeUserType

updateProject

updateRevision

addUserToProject

removeUserFromProject

deleteUser

getAllReadableProjects

getAllWritableProjects

getAllUsers

getAllServicesOfProject

getAllModelCheckersOfProject

getAllCheckoutsOfProject

getAllRevisionsByUser

getAllCheckoutsByUser

getAllCheckoutsOfRevision

getAvailableClasses

getAvailableClassesInRevision

getAllNonAuthorizedProjectsOfUser

getUserByUserName

undeleteUser

compare