ServiceInterface

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.bimserver.shared
Interface ServiceInterface

public interface ServiceInterface

This interface defines all functions that are made available via SOAP and Protocol Buffers, but also used by the JSP web interface

Method Summary
`void`	`abortTransaction()` Abort the current transaction, changes will not be saved
`void`	`addBooleanAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.Boolean value)`
`void`	`addDeserializer(org.bimserver.interfaces.objects.SDeserializer deserializer)`
`void`	`addDoubleAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.Double value)`
`void`	`addIfcEngine(org.bimserver.interfaces.objects.SIfcEngine ifcEngine)`
`void`	`addIntegerAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.Integer value)`
`void`	`addObjectIDM(org.bimserver.interfaces.objects.SObjectIDM objectIDM)`
`org.bimserver.interfaces.objects.SProject`	`addProject(java.lang.String projectName)` Add a new project
`org.bimserver.interfaces.objects.SProject`	`addProjectAsSubProject(java.lang.String projectName, java.lang.Long parentPoid)` Add a new project as a subproject of another project
`void`	`addReference(java.lang.Long oid, java.lang.String className, java.lang.String referenceName, java.lang.Long referenceOid, java.lang.String referenceClassName)`
`void`	`addSerializer(org.bimserver.interfaces.objects.SSerializer serializer)`
`void`	`addStringAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.String value)`
`org.bimserver.interfaces.objects.SUser`	`addUser(java.lang.String username, java.lang.String name, org.bimserver.interfaces.objects.SUserType type, java.lang.Boolean selfRegistration)` Add a new user
`java.lang.Boolean`	`addUserToProject(java.lang.Long uoid, java.lang.Long poid)` Add a user to a project (authorization wise)
`java.lang.Boolean`	`autologin(java.lang.String username, java.lang.String hash)` Login with an autologin hash (useful for the "remember-me" functionality in web-interfaces)
`org.bimserver.interfaces.objects.SCheckinResult`	`branchToExistingProject(java.lang.Long roid, java.lang.Long destPoid, java.lang.String comment)` Branch a given Revision as a new Revision in the given Project, branching is always synchronous
`org.bimserver.interfaces.objects.SCheckinResult`	`branchToNewProject(java.lang.Long roid, java.lang.String projectName, java.lang.String comment)` Branch a given Revision as a new Revision on a new Project, branching is always synchronous
`java.lang.Boolean`	`changePassword(java.lang.Long uoid, java.lang.String oldPassword, java.lang.String newPassword)` Change a User's password, not the preferred way, use requestPasswordChange for a safer version
`void`	`changeUserType(java.lang.Long uoid, org.bimserver.interfaces.objects.SUserType userType)` Change the type of a user
`java.lang.Integer`	`checkin(java.lang.Long poid, java.lang.String comment, java.lang.String deserializerName, java.lang.Long fileSize, javax.activation.DataHandler ifcFile, java.lang.Boolean merge, java.lang.Boolean sync)` Checkin a new model by sending a serialized form Available as REST call
`java.lang.Integer`	`checkout(java.lang.Long roid, java.lang.String serializerName, java.lang.Boolean sync)` Checkout an existing model, cehckout is the same as download, except a "checkout" will tell the server and other users you are working on it Available as REST call
`java.lang.Integer`	`checkoutLastRevision(java.lang.Long poid, java.lang.String serializerName, java.lang.Boolean sync)` Same as checkout, only this will automatically select the last revision to checkout Available as REST call
`void`	`close()` Close this ServiceInterface instance (it is important to close ServiceInterfaces for obvious reasons)
`java.lang.Long`	`commitTransaction(java.lang.String comment)` Commit the current transaction, changes will be saved, a transaction must be started by startTransaction first
`org.bimserver.interfaces.objects.SCompareResult`	`compare(java.lang.Long roid1, java.lang.Long roid2, org.bimserver.interfaces.objects.SCompareType sCompareType, org.bimserver.interfaces.objects.SCompareIdentifier sCompareIdentifier)` Compare two models
`org.bimserver.interfaces.objects.SCompileResult`	`compile(java.lang.String code)`
`java.lang.Integer`	`compileAndDownload(java.lang.Long roid, java.lang.String code)`
`org.bimserver.interfaces.objects.SRunResult`	`compileAndRun(java.lang.Long roid, java.lang.String code)`
`java.lang.Long`	`createObject(java.lang.String className)` Create a new Object
`void`	`deleteDeserializer(java.lang.Long sid)`
`void`	`deleteIfcEngine(java.lang.Long iid)`
`void`	`deleteObjectIDM(java.lang.Long oid)`
`java.lang.Boolean`	`deleteProject(java.lang.Long poid)` Delete a Project, Projects can be undeleted with the undeleteProject method
`void`	`deleteSerializer(java.lang.Long sid)`
`java.lang.Boolean`	`deleteUser(java.lang.Long uoid)` Delete a User, Users van be undeleted with the undeleteUser method
`void`	`disablePlugin(java.lang.String name)`
`java.lang.Integer`	`download(java.lang.Long roid, java.lang.String serializerName, java.lang.Boolean showOwn, java.lang.Boolean sync)` Download a single revision of a model in a serialized format Available as REST call
`java.lang.Integer`	`downloadByGuids(java.util.Set<java.lang.Long> roids, java.util.Set<java.lang.String> guids, java.lang.String serializerName, java.lang.Boolean sync)` Download a model in a serialized format by giving a set of revisins and a set of guids to filter on
`java.lang.Integer`	`downloadByOids(java.util.Set<java.lang.Long> roids, java.util.Set<java.lang.Long> oids, java.lang.String serializerName, java.lang.Boolean sync)` Download a model in a serialized format by giving a set of revisions and a set of Object IDs
`java.lang.Integer`	`downloadByTypes(java.util.Set<java.lang.Long> roids, java.util.Set<java.lang.String> classNames, java.lang.String serializerName, java.lang.Boolean includeAllSubtypes, java.lang.Boolean sync)` Download a model in serialized format by giving a set of revisions and a set of class names to filter on
`java.lang.Integer`	`downloadCompareResults(java.lang.String serializerName, java.lang.Long roid1, java.lang.Long roid2, org.bimserver.interfaces.objects.SCompareIdentifier identifier, org.bimserver.interfaces.objects.SCompareType type, java.lang.Boolean sync)` Download a compare of a model
`java.lang.Integer`	`downloadRevisions(java.util.Set<java.lang.Long> roids, java.lang.String serializerName, java.lang.Boolean sync)` Download a model in a serialized format by giving a set of revisions
`void`	`enablePlugin(java.lang.String name)`
`java.util.List<org.bimserver.interfaces.objects.SEidClash>`	`findClashesByEid(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings)`
`java.util.List<org.bimserver.interfaces.objects.SGuidClash>`	`findClashesByGuid(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings)` Perform clashdetection
`org.bimserver.interfaces.objects.SAccessMethod`	`getAccessMethod()`
`java.util.List<org.bimserver.interfaces.objects.SLongAction>`	`getActiveLongActions()`
`java.util.Date`	`getActiveSince()`
`java.util.List<org.bimserver.interfaces.objects.SUserSession>`	`getActiveUserSessions()`
`java.util.List<org.bimserver.interfaces.objects.SUser>`	`getAllAuthorizedUsersOfProject(java.lang.Long poid)`
`java.util.List<org.bimserver.interfaces.objects.SCheckout>`	`getAllCheckoutsByUser(java.lang.Long uoid)`
`java.util.List<org.bimserver.interfaces.objects.SCheckout>`	`getAllCheckoutsOfProject(java.lang.Long poid)`
`java.util.List<org.bimserver.interfaces.objects.SCheckout>`	`getAllCheckoutsOfProjectAndSubProjects(java.lang.Long poid)`
`java.util.List<org.bimserver.interfaces.objects.SCheckout>`	`getAllCheckoutsOfRevision(java.lang.Long roid)`
`java.util.List<org.bimserver.interfaces.objects.SDeserializerPluginDescriptor>`	`getAllDeserializerPluginDescriptors()`
`java.util.List<org.bimserver.interfaces.objects.SDeserializer>`	`getAllDeserializers(java.lang.Boolean onlyEnabled)`
`java.util.List<org.bimserver.interfaces.objects.SIfcEnginePluginDescriptor>`	`getAllIfcEnginePluginDescriptors()`
`java.util.List<org.bimserver.interfaces.objects.SIfcEngine>`	`getAllIfcEngines(java.lang.Boolean onlyEnabled)`
`java.util.List<org.bimserver.interfaces.objects.SProject>`	`getAllNonAuthorizedProjectsOfUser(java.lang.Long uoid)` Get a list of all Projects the given User does not have authorization for
`java.util.List<org.bimserver.interfaces.objects.SUser>`	`getAllNonAuthorizedUsersOfProject(java.lang.Long poid)` Get a list of all Users not authoriazed on the given Project
`java.util.List<org.bimserver.interfaces.objects.SObjectIDMPluginDescriptor>`	`getAllObjectIDMPluginDescriptors()`
`java.util.List<org.bimserver.interfaces.objects.SObjectIDM>`	`getAllObjectIDMs(java.lang.Boolean onlyEnabled)`
`java.util.List<org.bimserver.interfaces.objects.SPluginDescriptor>`	`getAllPlugins()`
`java.util.List<org.bimserver.interfaces.objects.SProject>`	`getAllProjects()` Get a list of all Projects the user is authorized for Available as REST call
`java.util.List<org.bimserver.interfaces.objects.SProject>`	`getAllReadableProjects()` Available as REST call Get a list of all Projects the user is authorized for to read from
`java.util.List<org.bimserver.interfaces.objects.SRevision>`	`getAllRevisionsByUser(java.lang.Long uoid)`
`java.util.List<org.bimserver.interfaces.objects.SRevision>`	`getAllRevisionsOfProject(java.lang.Long poid)` Get a list of all Revisions of a Project Available as REST call
`java.util.List<org.bimserver.interfaces.objects.SSerializerPluginDescriptor>`	`getAllSerializerPluginDescriptors()`
`java.util.List<org.bimserver.interfaces.objects.SSerializer>`	`getAllSerializers(java.lang.Boolean onlyEnabled)`
`java.util.List<org.bimserver.interfaces.objects.SUser>`	`getAllUsers()`
`java.util.List<java.lang.String>`	`getAvailableClasses()`
`java.util.List<java.lang.String>`	`getAvailableClassesInRevision(java.lang.Long roid)`
`org.bimserver.interfaces.objects.SCheckinResult`	`getCheckinState(java.lang.Integer actionId)` Get the current state of a running checkin
`java.util.Set<java.lang.String>`	`getCheckinWarnings(java.lang.Long poid)` Checkin warnings are given to users
`java.util.Set<java.lang.String>`	`getCheckoutWarnings(java.lang.Long poid)` Checkout warnings are given to users when checkouts are done by other users
`org.bimserver.interfaces.objects.SClashDetectionSettings`	`getClashDetectionSettings(java.lang.Long cdsoid)`
`Token`	`getCurrentToken()`
`org.bimserver.interfaces.objects.SUser`	`getCurrentUser()`
`org.bimserver.interfaces.objects.SDatabaseInformation`	`getDatabaseInformation()` Get information about the BIMserver database
`org.bimserver.interfaces.objects.SDataObject`	`getDataObjectByGuid(java.lang.Long roid, java.lang.String guid)` Get DataObjects based on a list of GUIDs Available as REST call
`org.bimserver.interfaces.objects.SDataObject`	`getDataObjectByOid(java.lang.Long roid, java.lang.Long oid, java.lang.String className)`
`java.util.List<org.bimserver.interfaces.objects.SDataObject>`	`getDataObjects(java.lang.Long roid)`
`java.util.List<org.bimserver.interfaces.objects.SDataObject>`	`getDataObjectsByType(java.lang.Long roid, java.lang.String className)`
`org.bimserver.interfaces.objects.SDeserializer`	`getDeserializerById(java.lang.Long oid)`
`org.bimserver.interfaces.objects.SDeserializer`	`getDeserializerByName(java.lang.String deserializerName)`
`org.bimserver.interfaces.objects.SDownloadResult`	`getDownloadData(java.lang.Integer actionId)` Get the data for a download/checkout Available as REST call
`org.bimserver.interfaces.objects.SLongActionState`	`getDownloadState(java.lang.Integer actionId)` Get the current state of a download/checkout
`org.bimserver.interfaces.objects.SGeoTag`	`getGeoTag(java.lang.Long goid)`
`org.bimserver.interfaces.objects.SIfcEngine`	`getIfcEngineById(java.lang.Long oid)`
`org.bimserver.interfaces.objects.SIfcEngine`	`getIfcEngineByName(java.lang.String name)`
`java.util.Date`	`getLastActive()`
`java.util.List<org.bimserver.interfaces.objects.SClash>`	`getLastClashes(java.lang.Long roid)` Get previously calculated clashes
`java.util.Date`	`getLastDatabaseReset()`
`org.bimserver.interfaces.objects.SVersion`	`getLatestVersion()` Check which version of BIMserver is the latest available (will download an XML file from bimserver.org)
`org.bimserver.interfaces.objects.SUser`	`getLoggedInUser()`
`java.util.List<org.bimserver.interfaces.objects.SLogAction>`	`getLogs()`
`java.util.List<org.bimserver.interfaces.objects.SMigration>`	`getMigrations()`
`org.bimserver.interfaces.objects.SObjectIDM`	`getObjectIDMById(java.lang.Long oid)`
`org.bimserver.interfaces.objects.SObjectIDM`	`getObjectIDMByName(java.lang.String objectIDMName)`
`org.bimserver.interfaces.objects.SProject`	`getProjectByPoid(java.lang.Long poid)`
`java.util.List<org.bimserver.interfaces.objects.SProject>`	`getProjectsByName(java.lang.String name)`
`java.lang.String`	`getProtocolBuffersFile()` Thsi will return the content of the .proto file (equivalent for SOAP's WSDL) for the ProtocolBuffers interface
`java.lang.String`	`getRemoteAddress()` Get the remove address (which is actually the address the server thinks the client is connecting from)
`org.bimserver.interfaces.objects.SRevision`	`getRevision(java.lang.Long roid)`
`org.bimserver.interfaces.objects.SRevisionSummary`	`getRevisionSummary(java.lang.Long roid)`
`org.bimserver.interfaces.objects.SSerializer`	`getSerializerByContentType(java.lang.String contentType)`
`org.bimserver.interfaces.objects.SSerializer`	`getSerializerById(java.lang.Long oid)`
`org.bimserver.interfaces.objects.SSerializer`	`getSerializerByName(java.lang.String serializerName)`
`org.bimserver.interfaces.objects.SSerializerPluginDescriptor`	`getSerializerPluginDescriptor(java.lang.String type)`
`org.bimserver.interfaces.objects.SServerInfo`	`getServerInfo()` Get information about this BIMserver's state
`java.lang.String`	`getServerLog()`
`java.util.Date`	`getServerStartTime()`
`java.lang.String`	`getSettingCustomLogoAddress()`
`java.lang.String`	`getSettingEmailSenderAddress()`
`java.lang.String`	`getSettingFooterAddition()`
`java.lang.String`	`getSettingHeaderAddition()`
`org.bimserver.interfaces.objects.SMergeIdentifier`	`getSettingMergeIdentifier()`
`java.lang.Integer`	`getSettingProtocolBuffersPort()`
`java.lang.String`	`getSettingRegistrationAddition()`
`java.lang.String`	`getSettingSiteAddress()`
`java.lang.String`	`getSettingSmtpServer()`
`java.util.List<org.bimserver.interfaces.objects.SProject>`	`getSubProjects(java.lang.Long poid)`
`java.lang.String`	`getSuggestedDeserializerForExtension(java.lang.String extension)`
`org.bimserver.interfaces.objects.SUser`	`getUserByUoid(java.lang.Long uoid)`
`org.bimserver.interfaces.objects.SUser`	`getUserByUserName(java.lang.String username)` Get a User by its UserNmae (e-mail address)
`java.util.List<org.bimserver.interfaces.objects.SProject>`	`getUsersProjects(java.lang.Long uoid)`
`org.bimserver.interfaces.objects.SVersion`	`getVersion()` Get the actual version of this BIMserver
`java.lang.Boolean`	`hasActiveSerializer(java.lang.String contentType)`
`java.lang.Boolean`	`isLoggedIn()`
`java.lang.Boolean`	`isSettingAllowSelfRegistration()`
`java.lang.Boolean`	`isSettingAllowUsersToCreateTopLevelProjects()`
`java.lang.Boolean`	`isSettingCacheOutputFiles()`
`java.lang.Boolean`	`isSettingCheckinMergingEnabled()`
`java.lang.Boolean`	`isSettingHideUserListForNonAdmin()`
`java.lang.Boolean`	`isSettingIntelligentMerging()`
`java.lang.Boolean`	`isSettingSendConfirmationEmailAfterRegistration()`
`java.lang.Boolean`	`isSettingShowVersionUpgradeAvailable()`
`java.lang.Boolean`	`login(java.lang.String username, java.lang.String password)` Login with a username/password combination
`void`	`logout()` Logout from this ServiceInterface (beware, the ServiceInterface is not closed and is still usable)
`void`	`migrateDatabase()` This will try to upgrade the database to the latest revision, this method will do nothing if the database schema is already up-to-date
`java.lang.String`	`ping(java.lang.String in)` Method to test the connection, will return the given string Available as REST call
`void`	`removeAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.Integer index)`
`void`	`removeObject(java.lang.String className, java.lang.Long oid)` Remove an object
`void`	`removeReference(java.lang.Long oid, java.lang.String className, java.lang.String referenceName, java.lang.Integer index)`
`java.lang.Boolean`	`removeUserFromProject(java.lang.Long uoid, java.lang.Long poid)` Remove a user from a project (authorization wise)
`void`	`requestPasswordChange(java.lang.String username)` Request a password change, an e-mail will be send with a validation url
`void`	`sendClashesEmail(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings, java.lang.Long poid, java.util.Set<java.lang.String> addressesTo)` Send an e-mail to a set of Users with the results of a clashdetection
`void`	`sendCompareEmail(org.bimserver.interfaces.objects.SCompareType sCompareType, org.bimserver.interfaces.objects.SCompareIdentifier sCompareIdentifier, java.lang.Long poid, java.lang.Long roid1, java.lang.Long roid2, java.lang.String address)` Send an e-mail with the results of a compare
`void`	`setBooleanAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.Boolean value)`
`void`	`setDoubleAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.Double value)`
`void`	`setEnumAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.String value)`
`void`	`setHttpCallback(java.lang.Long uoid, java.lang.String address)`
`void`	`setIntegerAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.Integer value)`
`void`	`setReference(java.lang.Long oid, java.lang.String className, java.lang.String referenceName, java.lang.Long referenceOid, java.lang.String referenceClassName)`
`void`	`setRevisionTag(java.lang.Long roid, java.lang.String tag)`
`void`	`setSettingAllowSelfRegistration(java.lang.Boolean allowSelfRegistration)`
`void`	`setSettingAllowUsersToCreateTopLevelProjects(java.lang.Boolean allowUsersToCreateTopLevelProjects)`
`void`	`setSettingCacheOutputFiles(java.lang.Boolean cacheOutputFiles)`
`void`	`setSettingCheckinMergingEnabled(java.lang.Boolean checkinMergingEnabled)`
`void`	`setSettingCustomLogoAddress(java.lang.String customLogoAddress)`
`void`	`setSettingEmailSenderAddress(java.lang.String emailSenderAddress)`
`void`	`setSettingFooterAddition(java.lang.String footerAddition)`
`void`	`setSettingHeaderAddition(java.lang.String headerAddition)`
`void`	`setSettingHideUserListForNonAdmin(java.lang.Boolean hideUserListForNonAdmin)`
`void`	`setSettingIntelligentMerging(java.lang.Boolean intelligentMerging)`
`void`	`setSettingMergeIdentifier(org.bimserver.interfaces.objects.SMergeIdentifier mergeIdentifier)`
`void`	`setSettingProtocolBuffersPort(java.lang.Integer port)`
`void`	`setSettingRegistrationAddition(java.lang.String registrationAddition)`
`void`	`setSettingSendConfirmationEmailAfterRegistration(java.lang.Boolean sendConfirmationEmailAfterRegistration)`
`void`	`setSettingShowVersionUpgradeAvailable(java.lang.Boolean showVersionUpgradeAvailable)`
`void`	`setSettingSiteAddress(java.lang.String siteAddress)`
`void`	`setSettingSmtpServer(java.lang.String smtpServer)`
`void`	`setStringAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName, java.lang.String value)`
`void`	`setup(java.lang.String siteAddress, java.lang.String smtpServer, java.lang.String adminName, java.lang.String adminUsername, java.lang.String adminPassword)` Setup this BIMserver
`void`	`startTransaction(java.lang.Integer pid)`
`java.lang.Boolean`	`undeleteProject(java.lang.Long poid)` Undelete a previously deleted Project, Projets can be deleted with the deleteProject method
`java.lang.Boolean`	`undeleteUser(java.lang.Long uoid)` Undelete a previously deleted User, Users can be deleted with the deleteUser method
`void`	`unsetAttribute(java.lang.Long oid, java.lang.String className, java.lang.String attributeName)`
`void`	`unsetReference(java.lang.Long oid, java.lang.String className, java.lang.String referenceName)`
`void`	`updateClashDetectionSettings(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings)`
`void`	`updateDeserializer(org.bimserver.interfaces.objects.SDeserializer deserializer)`
`void`	`updateGeoTag(org.bimserver.interfaces.objects.SGeoTag sGeoTag)`
`void`	`updateIfcEngine(org.bimserver.interfaces.objects.SIfcEngine ifcEngine)`
`void`	`updateObjectIDM(org.bimserver.interfaces.objects.SObjectIDM objectIDM)`
`void`	`updateProject(org.bimserver.interfaces.objects.SProject sProject)` Update project properties
`void`	`updateRevision(org.bimserver.interfaces.objects.SRevision sRevision)` Update a revision, not much can be changed afterwards, actually only the tag
`void`	`updateSerializer(org.bimserver.interfaces.objects.SSerializer serializer)`
`java.lang.Boolean`	`upgradePossible()` Check whether an upgrade of the BIMserver is available (will download an XML file from bimserver.org)
`java.lang.Boolean`	`userHasCheckinRights(java.lang.Long poid)`
`java.lang.Boolean`	`userHasRights(java.lang.Long poid)`
`org.bimserver.interfaces.objects.SUser`	`validateAccount(java.lang.Long uoid, java.lang.String token, java.lang.String password)`

Method Detail

ping

java.lang.String ping(java.lang.String in)
                      throws ServerException,
                             UserException

Method to test the connection, will return the given string Available as REST call

Parameters:: in - A random string
Returns:: The string passed as "in"
Throws:: ServerException, - UserException; ServerException; UserException

login

java.lang.Boolean login(java.lang.String username,
                        java.lang.String password)
                        throws ServerException,
                               UserException

Parameters:: username - The username (must be a valid e-mail address); password - The password
Returns:: True when successful, false if not
Throws:: ServerException, - UserException; ServerException; UserException

autologin

java.lang.Boolean autologin(java.lang.String username,
                            java.lang.String hash)
                            throws ServerException,
                                   UserException

Parameters:: username - The username (must be a valid e-mail address); hash - The hash (which is computed as sha256(username + sha256(password))
Returns:: True when successful, false if not
Throws:: ServerException, - UserException; ServerException; UserException

checkin

java.lang.Integer checkin(java.lang.Long poid,
                          java.lang.String comment,
                          java.lang.String deserializerName,
                          java.lang.Long fileSize,
                          javax.activation.DataHandler ifcFile,
                          java.lang.Boolean merge,
                          java.lang.Boolean sync)
                          throws ServerException,
                                 UserException

Checkin a new model by sending a serialized form Available as REST call

Parameters:: poid - The Project's ObjectID; comment - A comment; deserializerName - Name of the deserializer to use, use getAllDeserializers to get a list of available deserializers; fileSize - The size of the file in bytes; ifcFile - The actual 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

getCheckinState

org.bimserver.interfaces.objects.SCheckinResult getCheckinState(java.lang.Integer actionId)
                                                                throws ServerException,
                                                                       UserException

Get the current state of a running checkin

Parameters:: actionId - The ID returned by the checkin function
Returns:: An object with information about the checkin state
Throws:: ServerException, - UserException; ServerException; UserException

checkout

java.lang.Integer checkout(java.lang.Long roid,
                           java.lang.String serializerName,
                           java.lang.Boolean sync)
                           throws ServerException,
                                  UserException

Checkout an existing model, cehckout is the same as download, except a "checkout" will tell the server and other users you are working on it Available as REST call

Parameters:: roid - Revision ObjectID; serializerName - Name of the serializer to use, use getAllSerializers to find availble serializeres; sync - Whether to return immediately (async) or wait for completion (sync)
Returns:: An id, which you can use for the getDownloadState method
Throws:: ServerException, - UserException; ServerException; UserException

checkoutLastRevision

java.lang.Integer checkoutLastRevision(java.lang.Long poid,
                                       java.lang.String serializerName,
                                       java.lang.Boolean sync)
                                       throws ServerException,
                                              UserException

Same as checkout, only this will automatically select the last revision to checkout Available as REST call

Parameters:: poid - Project ObjectID; serializerName - Name of the serializer to use, use getAllSerializers to find availble serializeres; sync - Whether to return immediately (async) or wait for completion (sync)
Returns:: An id, which you can use for the getDownloadState and getDownloadData methods
Throws:: ServerException, - UserException; ServerException; UserException

download

java.lang.Integer download(java.lang.Long roid,
                           java.lang.String serializerName,
                           java.lang.Boolean showOwn,
                           java.lang.Boolean sync)
                           throws ServerException,
                                  UserException

Download a single revision of a model in a serialized format Available as REST call

Parameters:: roid - Revision ObjectID; serializerName - Name of the serializer to use, use getAllSerializers to find availble serializeres; showOwn - Whether to return revisions created by the current user; sync - Whether to return immediately (async) or wait for completion (sync)
Returns:: An id, which you can use for the getDownloadState and getDownloadData methods
Throws:: ServerException, - UserException; ServerException; UserException

downloadCompareResults

java.lang.Integer downloadCompareResults(java.lang.String serializerName,
                                         java.lang.Long roid1,
                                         java.lang.Long roid2,
                                         org.bimserver.interfaces.objects.SCompareIdentifier identifier,
                                         org.bimserver.interfaces.objects.SCompareType type,
                                         java.lang.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

downloadByOids

java.lang.Integer downloadByOids(java.util.Set<java.lang.Long> roids,
                                 java.util.Set<java.lang.Long> oids,
                                 java.lang.String serializerName,
                                 java.lang.Boolean sync)
                                 throws ServerException,
                                        UserException

Download a model in a serialized format by giving a set of revisions and a set of Object IDs

Parameters:: roids - A set of Revision ObjectIDs; oids - A set of ObjectIDs; serializerName - Name of the serializer to use, use getAllSerializers to find availble serializeres; sync - Whether to return immediately (async) or wait for completion (sync)
Returns:: An id, which you can use for the getDownloadState and getDownloadData methods
Throws:: ServerException, - UserException; ServerException; UserException

downloadByTypes

java.lang.Integer downloadByTypes(java.util.Set<java.lang.Long> roids,
                                  java.util.Set<java.lang.String> classNames,
                                  java.lang.String serializerName,
                                  java.lang.Boolean includeAllSubtypes,
                                  java.lang.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; classNames - A set of class names to filter on (e.g. "IfcWindow"); serializerName - Name of the serializer to use, use getAllSerializers to find availble serializeres; includeAllSubtypes - Whether to query all (recursive) subtypes of each gives class; sync - Whether to return immediately (async) or wait for completion (sync)
Returns:: An id, which you can use for the getDownloadState and getDownloadData methods
Throws:: ServerException, - UserException; ServerException; UserException

downloadByGuids

java.lang.Integer downloadByGuids(java.util.Set<java.lang.Long> roids,
                                  java.util.Set<java.lang.String> guids,
                                  java.lang.String serializerName,
                                  java.lang.Boolean sync)
                                  throws ServerException,
                                         UserException

Download a model in a serialized format by giving a set of revisins and a set of guids to filter on

Parameters:: roids - A set of Revision ObjectIDs; guids - A set of IFC guids; serializerName - Name of the serializer to use, use getAllSerializers to find availble serializeres; sync - Whether to return immediately (async) or wait for completion (sync)
Returns:: An id, which you can use for the getDownloadState and getDownloadData methods
Throws:: ServerException, - UserException; ServerException; UserException

downloadRevisions

java.lang.Integer downloadRevisions(java.util.Set<java.lang.Long> roids,
                                    java.lang.String serializerName,
                                    java.lang.Boolean sync)
                                    throws ServerException,
                                           UserException

Download a model in a serialized format by giving a set of revisions

Parameters:: roids - A set of Revision ObjectIDs; serializerName - Name of the serializer to use, use getAllSerializers to find availble serializeres; sync - Whether to return immediately (async) or wait for completion (sync)
Returns:: An id, which you can use for the getDownloadState and getDownloadData methods
Throws:: ServerException, - UserException; ServerException; UserException

getDownloadData

org.bimserver.interfaces.objects.SDownloadResult getDownloadData(java.lang.Integer actionId)
                                                                 throws ServerException,
                                                                        UserException

Get the data for a download/checkout Available as REST call

Parameters:: actionId - The actionId returned by one of the download or checkout methods
Returns:: An SDownloadResult containing the serialized data
Throws:: ServerException, - UserException; ServerException; UserException

getDownloadState

org.bimserver.interfaces.objects.SLongActionState getDownloadState(java.lang.Integer actionId)
                                                                   throws ServerException,
                                                                          UserException

Get the current state of a download/checkout

Parameters:: actionId - The ID returned by a download or checkout method
Returns:: A SLongActionState object containing details about the download/checkout
Throws:: ServerException, - UserException; ServerException; UserException

addUser

org.bimserver.interfaces.objects.SUser addUser(java.lang.String username,
                                               java.lang.String name,
                                               org.bimserver.interfaces.objects.SUserType type,
                                               java.lang.Boolean selfRegistration)
                                               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)
Returns:: The ObjectID of the created User object
Throws:: ServerException, - UserException; ServerException; UserException

changeUserType

void changeUserType(java.lang.Long uoid,
                    org.bimserver.interfaces.objects.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

addProject

org.bimserver.interfaces.objects.SProject addProject(java.lang.String projectName)
                                                     throws ServerException,
                                                            UserException

Add a new project

Parameters:: projectName - Name of the project, must be a unique name within all root-projects
Returns:: The created Project
Throws:: ServerException, - UserException; ServerException; UserException

addProjectAsSubProject

org.bimserver.interfaces.objects.SProject addProjectAsSubProject(java.lang.String projectName,
                                                                 java.lang.Long parentPoid)
                                                                 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

updateProject

void updateProject(org.bimserver.interfaces.objects.SProject sProject)
                   throws ServerException,
                          UserException

Update project properties

Parameters:: sProject - A Project object containing the new properties
Throws:: ServerException, - UserException; ServerException; UserException

updateRevision

void updateRevision(org.bimserver.interfaces.objects.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

java.lang.Boolean addUserToProject(java.lang.Long uoid,
                                   java.lang.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

java.lang.Boolean removeUserFromProject(java.lang.Long uoid,
                                        java.lang.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

deleteProject

java.lang.Boolean deleteProject(java.lang.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

deleteUser

java.lang.Boolean deleteUser(java.lang.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

getAllProjects

java.util.List<org.bimserver.interfaces.objects.SProject> getAllProjects()
                                                                         throws ServerException,
                                                                                UserException

Get a list of all Projects the user is authorized for Available as REST call

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

getAllReadableProjects

java.util.List<org.bimserver.interfaces.objects.SProject> getAllReadableProjects()
                                                                                 throws ServerException,
                                                                                        UserException

Available as REST call 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

getAllUsers

java.util.List<org.bimserver.interfaces.objects.SUser> getAllUsers()
                                                                   throws ServerException,
                                                                          UserException

Throws:: ServerException; UserException

getAllRevisionsOfProject

java.util.List<org.bimserver.interfaces.objects.SRevision> getAllRevisionsOfProject(java.lang.Long poid)
                                                                                    throws ServerException,
                                                                                           UserException

Get a list of all Revisions of a Project Available as REST call

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

getAllCheckoutsOfProject

java.util.List<org.bimserver.interfaces.objects.SCheckout> getAllCheckoutsOfProject(java.lang.Long poid)
                                                                                    throws ServerException,
                                                                                           UserException

Parameters:: poid - The ObjectID of the Project
Returns:: A list of Checkouts belonging to this Project
Throws:: ServerException, - UserException; ServerException; UserException

getAllRevisionsByUser

java.util.List<org.bimserver.interfaces.objects.SRevision> getAllRevisionsByUser(java.lang.Long uoid)
                                                                                 throws ServerException,
                                                                                        UserException

Parameters:: uoid - ObjectID of the Project
Returns:: A list of Revisions belonging to this Project
Throws:: ServerException, - UserException; ServerException; UserException

getAllCheckoutsByUser

java.util.List<org.bimserver.interfaces.objects.SCheckout> getAllCheckoutsByUser(java.lang.Long uoid)
                                                                                 throws ServerException,
                                                                                        UserException

Parameters:: uoid - ObjectID of the User
Returns:: A list of Checkouts belonging to the given User
Throws:: ServerException, - UserException; ServerException; UserException

getAllCheckoutsOfRevision

java.util.List<org.bimserver.interfaces.objects.SCheckout> getAllCheckoutsOfRevision(java.lang.Long roid)
                                                                                     throws ServerException,
                                                                                            UserException

Parameters:: roid - ObjectID of the Revision
Returns:: A list of Checkouts belonging to the given Revision
Throws:: ServerException, - UserException; ServerException; UserException

getProjectByPoid

org.bimserver.interfaces.objects.SProject getProjectByPoid(java.lang.Long poid)
                                                           throws ServerException,
                                                                  UserException

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

getRevision

org.bimserver.interfaces.objects.SRevision getRevision(java.lang.Long roid)
                                                       throws ServerException,
                                                              UserException

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

getAvailableClasses

java.util.List<java.lang.String> getAvailableClasses()
                                                     throws ServerException,
                                                            UserException

Returns:: A list of available classes in the BIMserver, only classes from the IFC model will be returned
Throws:: ServerException, - UserException; ServerException; UserException

getAvailableClassesInRevision

java.util.List<java.lang.String> getAvailableClassesInRevision(java.lang.Long roid)
                                                               throws ServerException,
                                                                      UserException

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

getDatabaseInformation

org.bimserver.interfaces.objects.SDatabaseInformation getDatabaseInformation()
                                                                             throws ServerException,
                                                                                    UserException

Get information about the BIMserver database

Returns:: A SDatabaseInformation Object containing the information
Throws:: ServerException, - UserException; ServerException; UserException

getLastDatabaseReset

java.util.Date getLastDatabaseReset()
                                    throws ServerException,
                                           UserException

Returns:: When the last database reset occurred
Throws:: ServerException, - UserException; ServerException; UserException

getLoggedInUser

org.bimserver.interfaces.objects.SUser getLoggedInUser()
                                                       throws ServerException,
                                                              UserException

Returns:: The User that it currently loggedin on this ServiceInterface
Throws:: ServerException, - UserException; ServerException; UserException

getAllNonAuthorizedProjectsOfUser

java.util.List<org.bimserver.interfaces.objects.SProject> getAllNonAuthorizedProjectsOfUser(java.lang.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

logout

void logout()
            throws ServerException,
                   UserException

Logout from this ServiceInterface (beware, the ServiceInterface is not closed and is still usable)

Throws:: ServerException, - UserException; ServerException; UserException

close

void close()
           throws ServerException,
                  UserException

Close this ServiceInterface instance (it is important to close ServiceInterfaces for obvious reasons)

Throws:: ServerException, - UserException; ServerException; UserException

changePassword

java.lang.Boolean changePassword(java.lang.Long uoid,
                                 java.lang.String oldPassword,
                                 java.lang.String newPassword)
                                 throws ServerException,
                                        UserException

Change a User's password, not the preferred way, use requestPasswordChange for a safer version

Parameters:: uoid - The ObjectID of the User; oldPassword - The old password; newPassword - The new password
Returns:: Whether the password was successfully changed
Throws:: ServerException, - UserException; ServerException; UserException

getUserByUserName

org.bimserver.interfaces.objects.SUser getUserByUserName(java.lang.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

undeleteProject

java.lang.Boolean undeleteProject(java.lang.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

undeleteUser

java.lang.Boolean undeleteUser(java.lang.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

org.bimserver.interfaces.objects.SCompareResult compare(java.lang.Long roid1,
                                                        java.lang.Long roid2,
                                                        org.bimserver.interfaces.objects.SCompareType sCompareType,
                                                        org.bimserver.interfaces.objects.SCompareIdentifier sCompareIdentifier)
                                                        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

org.bimserver.interfaces.objects.SRevisionSummary getRevisionSummary(java.lang.Long roid)
                                                                     throws ServerException,
                                                                            UserException

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

userHasCheckinRights

java.lang.Boolean userHasCheckinRights(java.lang.Long poid)
                                       throws ServerException,
                                              UserException

Parameters:: poid - ObjectID of the Project
Returns:: Whether the current use has checkin rights on the given Project
Throws:: ServerException, - UserException; ServerException; UserException

getCheckoutWarnings

java.util.Set<java.lang.String> getCheckoutWarnings(java.lang.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

java.lang.Boolean userHasRights(java.lang.Long poid)
                                throws ServerException,
                                       UserException

Parameters:: poid - ObjectID of the Project
Returns:: Whether the current User has rights on the given Project
Throws:: ServerException, - UserException; ServerException; UserException

getDataObjectByOid

org.bimserver.interfaces.objects.SDataObject getDataObjectByOid(java.lang.Long roid,
                                                                java.lang.Long oid,
                                                                java.lang.String className)
                                                                throws ServerException,
                                                                       UserException

Throws:: ServerException; UserException

getDataObjectByGuid

org.bimserver.interfaces.objects.SDataObject getDataObjectByGuid(java.lang.Long roid,
                                                                 java.lang.String guid)
                                                                 throws ServerException,
                                                                        UserException

Get DataObjects based on a list of GUIDs Available as REST call

Parameters:: roid - ObjectID of the Revision; guid - An IFC GUID
Returns:: The object with the given GUID in the given Revision, of null if not found
Throws:: ServerException, - UserException; ServerException; UserException

getDataObjectsByType

java.util.List<org.bimserver.interfaces.objects.SDataObject> getDataObjectsByType(java.lang.Long roid,
                                                                                  java.lang.String className)
                                                                                  throws ServerException,
                                                                                         UserException

Parameters:: roid - ObjectID of the Revision; className - Name of the class to query (e.g. "IfcWindow")
Returns:: A list of DataObjects from the given Revision matching the given class
Throws:: ServerException, - UserException; ServerException; UserException

getDataObjects

java.util.List<org.bimserver.interfaces.objects.SDataObject> getDataObjects(java.lang.Long roid)
                                                                            throws ServerException,
                                                                                   UserException

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

findClashesByGuid

java.util.List<org.bimserver.interfaces.objects.SGuidClash> findClashesByGuid(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings)
                                                                              throws ServerException,
                                                                                     UserException

Perform clashdetection

Parameters:: sClashDetectionSettings - The settings for the ClashDetection, these include the Revisions to use
Returns:: A list of GuidClash objects describing the found clashes
Throws:: ServerException, - UserException; ServerException; UserException

findClashesByEid

java.util.List<org.bimserver.interfaces.objects.SEidClash> findClashesByEid(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings)
                                                                            throws ServerException,
                                                                                   UserException

Parameters:: sClashDetectionSettings - The settings for the ClashDetection, these include the Revisions to use
Returns:: A list of EidClash objects describing the found clashes
Throws:: ServerException, - UserException; ServerException; UserException

getLastClashes

java.util.List<org.bimserver.interfaces.objects.SClash> getLastClashes(java.lang.Long roid)
                                                                       throws ServerException,
                                                                              UserException

Get previously calculated clashes

Parameters:: roid - ObjectID of the Revision
Returns:: A list of Clash objects
Throws:: ServerException, - UserException; ServerException; UserException

branchToNewProject

org.bimserver.interfaces.objects.SCheckinResult branchToNewProject(java.lang.Long roid,
                                                                   java.lang.String projectName,
                                                                   java.lang.String comment)
                                                                   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

org.bimserver.interfaces.objects.SCheckinResult branchToExistingProject(java.lang.Long roid,
                                                                        java.lang.Long destPoid,
                                                                        java.lang.String comment)
                                                                        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

getGeoTag

org.bimserver.interfaces.objects.SGeoTag getGeoTag(java.lang.Long goid)
                                                   throws ServerException,
                                                          UserException

Parameters:: goid - The ObjectID of the GeoTag
Returns:: The GeoTag object
Throws:: ServerException, - UserException; ServerException; UserException

updateGeoTag

void updateGeoTag(org.bimserver.interfaces.objects.SGeoTag sGeoTag)
                  throws ServerException,
                         UserException

Parameters:: sGeoTag - A GeoTag object containing the new properties
Throws:: ServerException, - UserException; ServerException; UserException

getClashDetectionSettings

org.bimserver.interfaces.objects.SClashDetectionSettings getClashDetectionSettings(java.lang.Long cdsoid)
                                                                                   throws ServerException,
                                                                                          UserException

Parameters:: cdsoid - The ObjectID of the ClashDetectionSettings object
Returns:: The ClashDetectionSettings object
Throws:: ServerException, - UserException; ServerException; UserException

updateClashDetectionSettings

void updateClashDetectionSettings(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings)
                                  throws ServerException,
                                         UserException

Parameters:: sClashDetectionSettings - A ClashDetectionSettings object containing the new properties
Throws:: ServerException, - UserException; ServerException; UserException

getUserByUoid

org.bimserver.interfaces.objects.SUser getUserByUoid(java.lang.Long uoid)
                                                     throws ServerException,
                                                            UserException

Parameters:: uoid - The ObjectID of the User
Returns:: The User with the given User ObjectID
Throws:: ServerException, - UserException; ServerException; UserException

getAllNonAuthorizedUsersOfProject

java.util.List<org.bimserver.interfaces.objects.SUser> getAllNonAuthorizedUsersOfProject(java.lang.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

java.util.List<org.bimserver.interfaces.objects.SUser> getAllAuthorizedUsersOfProject(java.lang.Long poid)
                                                                                      throws ServerException,
                                                                                             UserException

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

getUsersProjects

java.util.List<org.bimserver.interfaces.objects.SProject> getUsersProjects(java.lang.Long uoid)
                                                                           throws ServerException,
                                                                                  UserException

Parameters:: uoid -
Returns:: A list of projects a user has been authorized for
Throws:: ServerException, - UserException; ServerException; UserException

getProjectsByName

java.util.List<org.bimserver.interfaces.objects.SProject> getProjectsByName(java.lang.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

setRevisionTag

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

Parameters:: roid -; tag -
Throws:: ServerException, - UserException; ServerException; UserException

getSubProjects

java.util.List<org.bimserver.interfaces.objects.SProject> getSubProjects(java.lang.Long poid)
                                                                         throws ServerException,
                                                                                UserException

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

getCurrentUser

org.bimserver.interfaces.objects.SUser getCurrentUser()
                                                      throws ServerException,
                                                             UserException

Returns:: The currently logged-in User
Throws:: ServerException, - UserException; ServerException; UserException

isLoggedIn

java.lang.Boolean isLoggedIn()
                             throws ServerException,
                                    UserException

Returns:: Whether this ServiceInterface is logged-in
Throws:: ServerException, - UserException; ServerException; UserException

getActiveSince

java.util.Date getActiveSince()
                              throws ServerException,
                                     UserException

Returns:: Since when this ServiceInterface session has been active
Throws:: ServerException, - UserException; ServerException; UserException

getLastActive

java.util.Date getLastActive()
                             throws ServerException,
                                    UserException

Returns:: When the session has been active for the last
Throws:: ServerException, - UserException; ServerException; UserException

getCurrentToken

Token getCurrentToken()
                      throws ServerException,
                             UserException

Returns:: The Token used for this session
Throws:: ServerException, - UserException; ServerException; UserException

getAccessMethod

org.bimserver.interfaces.objects.SAccessMethod getAccessMethod()
                                                               throws ServerException,
                                                                      UserException

Returns:: The method of access this ServiceInterface is using (SOAP, REST, PB etc...)
Throws:: ServerException, - UserException; ServerException; UserException

getAllCheckoutsOfProjectAndSubProjects

java.util.List<org.bimserver.interfaces.objects.SCheckout> getAllCheckoutsOfProjectAndSubProjects(java.lang.Long poid)
                                                                                                  throws ServerException,
                                                                                                         UserException

Throws:: ServerException; UserException

requestPasswordChange

void requestPasswordChange(java.lang.String username)
                           throws ServerException,
                                  UserException

Request a password change, an e-mail will be send with a validation url

Parameters:: username - The username of the user to change tot password for
Throws:: ServerException, - UserException; ServerException; UserException

validateAccount

org.bimserver.interfaces.objects.SUser validateAccount(java.lang.Long uoid,
                                                       java.lang.String token,
                                                       java.lang.String password)
                                                       throws ServerException,
                                                              UserException

Parameters:: uoid - The ObejctID of the User; token - The token generated by requestPasswordChange; password - The new password
Returns:: A User object if the change is successful, null otherwise
Throws:: ServerException, - UserException; ServerException; UserException

sendClashesEmail

void sendClashesEmail(org.bimserver.interfaces.objects.SClashDetectionSettings sClashDetectionSettings,
                      java.lang.Long poid,
                      java.util.Set<java.lang.String> addressesTo)
                      throws ServerException,
                             UserException

Send an e-mail to a set of Users with the results of a clashdetection

Parameters:: sClashDetectionSettings - The settings to use for the ClashDetection; poid - ObjectID of the Project; addressesTo - A set of String containing the e-mail addresses
Throws:: ServerException, - UserException; ServerException; UserException

sendCompareEmail

void sendCompareEmail(org.bimserver.interfaces.objects.SCompareType sCompareType,
                      org.bimserver.interfaces.objects.SCompareIdentifier sCompareIdentifier,
                      java.lang.Long poid,
                      java.lang.Long roid1,
                      java.lang.Long roid2,
                      java.lang.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

setup

void setup(java.lang.String siteAddress,
           java.lang.String smtpServer,
           java.lang.String adminName,
           java.lang.String adminUsername,
           java.lang.String adminPassword)
           throws ServerException,
                  UserException

Setup this BIMserver

Parameters:: siteAddress - The address the server will be reachable at (for example: http://demo.bimserver.org); smtpServer - The address of the SMTP server that wil be used for sending e-mails; adminName - Name of the admin User (e.g. "Administrator"); adminUsername - Username of the admin User (must be a valid e-mail address); adminPassword - Password of the admin User
Throws:: ServerException, - UserException; ServerException; UserException

getSettingCustomLogoAddress

java.lang.String getSettingCustomLogoAddress()
                                             throws ServerException,
                                                    UserException

Returns:: The location of a custom Logo (URL) for the BIMserver
Throws:: ServerException, - UserException; ServerException; UserException

setSettingCustomLogoAddress

void setSettingCustomLogoAddress(java.lang.String customLogoAddress)
                                 throws ServerException,
                                        UserException

Parameters:: customLogoAddress - The new location for the custom logo
Throws:: ServerException, - UserException; ServerException; UserException

getSettingHeaderAddition

java.lang.String getSettingHeaderAddition()
                                          throws ServerException,
                                                 UserException

Returns:: An addition to the JSP header
Throws:: ServerException, - UserException; ServerException; UserException

setSettingHeaderAddition

void setSettingHeaderAddition(java.lang.String headerAddition)
                              throws ServerException,
                                     UserException

Parameters:: headerAddition - The new header addition
Throws:: ServerException, - UserException; ServerException; UserException

getSettingFooterAddition

java.lang.String getSettingFooterAddition()
                                          throws ServerException,
                                                 UserException

Returns:: An addition to the JSP footer
Throws:: ServerException, - UserException; ServerException; UserException

setSettingFooterAddition

void setSettingFooterAddition(java.lang.String footerAddition)
                              throws ServerException,
                                     UserException

Parameters:: footerAddition - The new footer addition
Throws:: ServerException, - UserException; ServerException; UserException

setSettingMergeIdentifier

void setSettingMergeIdentifier(org.bimserver.interfaces.objects.SMergeIdentifier mergeIdentifier)
                               throws ServerException,
                                      UserException

Parameters:: mergeIdentifier -
Throws:: ServerException, - UserException; ServerException; UserException

getSettingEmailSenderAddress

java.lang.String getSettingEmailSenderAddress()
                                              throws ServerException,
                                                     UserException

Throws:: ServerException; UserException

setSettingEmailSenderAddress

void setSettingEmailSenderAddress(java.lang.String emailSenderAddress)
                                  throws ServerException,
                                         UserException

Parameters:: emailSenderAddress - The new e-mail address e-mail will be sent from
Throws:: ServerException, - UserException; ServerException; UserException

getSettingRegistrationAddition

java.lang.String getSettingRegistrationAddition()
                                                throws ServerException,
                                                       UserException

Returns:: The registration addition text
Throws:: ServerException, - UserException; ServerException; UserException

setSettingRegistrationAddition

void setSettingRegistrationAddition(java.lang.String registrationAddition)
                                    throws ServerException,
                                           UserException

Parameters:: registrationAddition - The new registration addition text
Throws:: ServerException, - UserException; ServerException; UserException

getSettingProtocolBuffersPort

java.lang.Integer getSettingProtocolBuffersPort()
                                                throws ServerException,
                                                       UserException

Returns:: The port on which the ProtocolBuffers server runs
Throws:: ServerException, - UserException; ServerException; UserException

setSettingProtocolBuffersPort

void setSettingProtocolBuffersPort(java.lang.Integer port)
                                   throws ServerException,
                                          UserException

Parameters:: port - Set the port the ProtocolBuffers server runs on
Throws:: ServerException, - UserException; ServerException; UserException

getSettingSiteAddress

java.lang.String getSettingSiteAddress()
                                       throws ServerException,
                                              UserException

Returns:: The address the BIMserver is running on (used for links in e-mail for example)
Throws:: ServerException, - UserException; ServerException; UserException

setSettingSiteAddress

void setSettingSiteAddress(java.lang.String siteAddress)
                           throws ServerException,
                                  UserException

Parameters:: siteAddress - The new address the BIMserver is running on (used for links in e-mail for example)
Throws:: ServerException, - UserException; ServerException; UserException

getSettingSmtpServer

java.lang.String getSettingSmtpServer()
                                      throws ServerException,
                                             UserException

Returns:: Address of the SMTP server used for sending e-mails
Throws:: ServerException, - UserException; ServerException; UserException

setSettingSmtpServer

void setSettingSmtpServer(java.lang.String smtpServer)
                          throws ServerException,
                                 UserException

Parameters:: smtpServer - New address of the SMTP server used for sending e-mails
Throws:: ServerException, - UserException; ServerException; UserException

isSettingAllowSelfRegistration

java.lang.Boolean isSettingAllowSelfRegistration()
                                                 throws ServerException,
                                                        UserException

Returns:: Whether self-registration is enabled
Throws:: ServerException, - UserException; ServerException; UserException

setSettingAllowSelfRegistration

void setSettingAllowSelfRegistration(java.lang.Boolean allowSelfRegistration)
                                     throws ServerException,
                                            UserException

Parameters:: allowSelfRegistration - Change whether self-registration is enabled
Throws:: ServerException, - UserException; ServerException; UserException

isSettingHideUserListForNonAdmin

java.lang.Boolean isSettingHideUserListForNonAdmin()
                                                   throws ServerException,
                                                          UserException

Returns:: Whether to hide user lists (pricacy)
Throws:: ServerException, - UserException; ServerException; UserException

setSettingHideUserListForNonAdmin

void setSettingHideUserListForNonAdmin(java.lang.Boolean hideUserListForNonAdmin)
                                       throws ServerException,
                                              UserException

Parameters:: hideUserListForNonAdmin - Set whether user lists should be hidden (privacy)
Throws:: ServerException, - UserException; ServerException; UserException

isSettingAllowUsersToCreateTopLevelProjects

java.lang.Boolean isSettingAllowUsersToCreateTopLevelProjects()
                                                              throws ServerException,
                                                                     UserException

Returns:: Whether a user can create top level projects
Throws:: ServerException, - UserException; ServerException; UserException

setSettingAllowUsersToCreateTopLevelProjects

void setSettingAllowUsersToCreateTopLevelProjects(java.lang.Boolean allowUsersToCreateTopLevelProjects)
                                                  throws ServerException,
                                                         UserException

Parameters:: allowUsersToCreateTopLevelProjects - Set if users can create top level projects
Throws:: ServerException, - UserException; ServerException; UserException

isSettingCheckinMergingEnabled

java.lang.Boolean isSettingCheckinMergingEnabled()
                                                 throws ServerException,
                                                        UserException

Returns:: Whether the BIMserver should do checkin merging (warning: this will alter your models)
Throws:: ServerException, - UserException; ServerException; UserException

setSettingCheckinMergingEnabled

void setSettingCheckinMergingEnabled(java.lang.Boolean checkinMergingEnabled)
                                     throws ServerException,
                                            UserException

Parameters:: checkinMergingEnabled - Set whether the BIMserver should do checkin merging (warning: this wil alter your models)
Throws:: ServerException, - UserException; ServerException; UserException

isSettingIntelligentMerging

java.lang.Boolean isSettingIntelligentMerging()
                                              throws ServerException,
                                                     UserException

Returns:: Whether intelligent merging is on
Throws:: ServerException, - UserException; ServerException; UserException

setSettingIntelligentMerging

void setSettingIntelligentMerging(java.lang.Boolean intelligentMerging)
                                  throws ServerException,
                                         UserException

Parameters:: intelligentMerging - Set intelligent merging on/off
Throws:: ServerException, - UserException; ServerException; UserException

isSettingSendConfirmationEmailAfterRegistration

java.lang.Boolean isSettingSendConfirmationEmailAfterRegistration()
                                                                  throws ServerException,
                                                                         UserException

Returns:: Whether a confirmation e-mail should be send after registration
Throws:: ServerException, - UserException; ServerException; UserException

setSettingSendConfirmationEmailAfterRegistration

void setSettingSendConfirmationEmailAfterRegistration(java.lang.Boolean sendConfirmationEmailAfterRegistration)
                                                      throws ServerException,
                                                             UserException

Parameters:: sendConfirmationEmailAfterRegistration - Set whether a confirmation e-mail should be send after registration
Throws:: ServerException, - UserException; ServerException; UserException

isSettingShowVersionUpgradeAvailable

java.lang.Boolean isSettingShowVersionUpgradeAvailable()
                                                       throws ServerException,
                                                              UserException

Returns:: Whether it should be shown to the user that a new version of the BIMserver is available
Throws:: ServerException, - UserException; ServerException; UserException

setSettingShowVersionUpgradeAvailable

void setSettingShowVersionUpgradeAvailable(java.lang.Boolean showVersionUpgradeAvailable)
                                           throws ServerException,
                                                  UserException

Parameters:: showVersionUpgradeAvailable - Set whether it should be shown to the user that a new version of the BIMserver is available
Throws:: ServerException, - UserException; ServerException; UserException

isSettingCacheOutputFiles

java.lang.Boolean isSettingCacheOutputFiles()
                                            throws ServerException,
                                                   UserException

Returns:: Whether output files (serialized version) should be cached on disk
Throws:: ServerException, - UserException; ServerException; UserException

setSettingCacheOutputFiles

void setSettingCacheOutputFiles(java.lang.Boolean cacheOutputFiles)
                                throws ServerException,
                                       UserException

Parameters:: cacheOutputFiles - Set whether output files (serialized version) should be cached on disk
Throws:: ServerException, - UserException; ServerException; UserException

getLogs

java.util.List<org.bimserver.interfaces.objects.SLogAction> getLogs()
                                                                    throws ServerException,
                                                                           UserException

Returns:: A list with all Log objects, Log objects contain information about action performed on the BIMserver like ProjectAdded, UserAdded etc...
Throws:: ServerException, - UserException; ServerException; UserException

getActiveUserSessions

java.util.List<org.bimserver.interfaces.objects.SUserSession> getActiveUserSessions()
                                                                                    throws ServerException,
                                                                                           UserException

Returns:: A list with the currently active User sessions
Throws:: ServerException, - UserException; ServerException; UserException

getActiveLongActions

java.util.List<org.bimserver.interfaces.objects.SLongAction> getActiveLongActions()
                                                                                  throws ServerException,
                                                                                         UserException

Returns:: A list with the currently running Long actions
Throws:: ServerException, - UserException; ServerException; UserException

getMigrations

java.util.List<org.bimserver.interfaces.objects.SMigration> getMigrations()
                                                                          throws ServerException,
                                                                                 UserException

Returns:: A list of all Migrations (either executed or not)
Throws:: ServerException, - UserException; ServerException; UserException

migrateDatabase

void migrateDatabase()
                     throws ServerException,
                            UserException

This will try to upgrade the database to the latest revision, this method will do nothing if the database schema is already up-to-date

Throws:: ServerException, - UserException; ServerException; UserException

getAllSerializers

java.util.List<org.bimserver.interfaces.objects.SSerializer> getAllSerializers(java.lang.Boolean onlyEnabled)
                                                                               throws ServerException,
                                                                                      UserException

Parameters:: onlyEnabled - Whether to only include enabled serializers
Returns:: A list of Serializers
Throws:: ServerException, - UserException; ServerException; UserException

getAllIfcEngines

java.util.List<org.bimserver.interfaces.objects.SIfcEngine> getAllIfcEngines(java.lang.Boolean onlyEnabled)
                                                                             throws ServerException,
                                                                                    UserException

Parameters:: onlyEnabled - Whether to only include enabled IFC engines
Returns:: A list of IfcEngines
Throws:: ServerException, - UserException; ServerException; UserException

getSerializerById

org.bimserver.interfaces.objects.SSerializer getSerializerById(java.lang.Long oid)
                                                               throws ServerException,
                                                                      UserException

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

getIfcEngineById

org.bimserver.interfaces.objects.SIfcEngine getIfcEngineById(java.lang.Long oid)
                                                             throws ServerException,
                                                                    UserException

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

getDeserializerById

org.bimserver.interfaces.objects.SDeserializer getDeserializerById(java.lang.Long oid)
                                                                   throws ServerException,
                                                                          UserException

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

addSerializer

void addSerializer(org.bimserver.interfaces.objects.SSerializer serializer)
                   throws ServerException,
                          UserException

Parameters:: serializer - Serializer to add
Throws:: ServerException, - UserException; ServerException; UserException

addIfcEngine

void addIfcEngine(org.bimserver.interfaces.objects.SIfcEngine ifcEngine)
                  throws ServerException,
                         UserException

Parameters:: ifcEngine - IfcEngine to add
Throws:: ServerException, - UserException; ServerException; UserException

addDeserializer

void addDeserializer(org.bimserver.interfaces.objects.SDeserializer deserializer)
                     throws ServerException,
                            UserException

Parameters:: deserializer - Deserializer to add
Throws:: ServerException, - UserException; ServerException; UserException

updateSerializer

void updateSerializer(org.bimserver.interfaces.objects.SSerializer serializer)
                      throws ServerException,
                             UserException

Parameters:: serializer - Serializer to update
Throws:: ServerException, - UserException; ServerException; UserException

updateIfcEngine

void updateIfcEngine(org.bimserver.interfaces.objects.SIfcEngine ifcEngine)
                     throws ServerException,
                            UserException

Parameters:: ifcEngine - IfcEngine to update
Throws:: ServerException, - UserException; ServerException; UserException

updateDeserializer

void updateDeserializer(org.bimserver.interfaces.objects.SDeserializer deserializer)
                        throws ServerException,
                               UserException

Parameters:: deserializer - Deserializer to update
Throws:: ServerException, - UserException; ServerException; UserException

getAllObjectIDMs

java.util.List<org.bimserver.interfaces.objects.SObjectIDM> getAllObjectIDMs(java.lang.Boolean onlyEnabled)
                                                                             throws ServerException,
                                                                                    UserException

Parameters:: onlyEnabled - Whether to include only enabled ObjectIDMs
Returns:: A list of ObjectIDMs
Throws:: ServerException, - UserException; ServerException; UserException

getObjectIDMById

org.bimserver.interfaces.objects.SObjectIDM getObjectIDMById(java.lang.Long oid)
                                                             throws ServerException,
                                                                    UserException

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

addObjectIDM

void addObjectIDM(org.bimserver.interfaces.objects.SObjectIDM objectIDM)
                  throws ServerException,
                         UserException

Parameters:: objectIDM - The ObjectIDM to add
Throws:: ServerException, - UserException; ServerException; UserException

updateObjectIDM

void updateObjectIDM(org.bimserver.interfaces.objects.SObjectIDM objectIDM)
                     throws ServerException,
                            UserException

Parameters:: objectIDM - The ObjectIDM to update
Throws:: ServerException, - UserException; ServerException; UserException

deleteObjectIDM

void deleteObjectIDM(java.lang.Long oid)
                     throws ServerException,
                            UserException

Parameters:: oid - ObjectID of the ObjectIDM to delete
Throws:: ServerException, - UserException; ServerException; UserException

deleteSerializer

void deleteSerializer(java.lang.Long sid)
                      throws ServerException,
                             UserException

Parameters:: sid - ObjectID of the Serializer to delete
Throws:: ServerException, - UserException; ServerException; UserException

deleteIfcEngine

void deleteIfcEngine(java.lang.Long iid)
                     throws ServerException,
                            UserException

Parameters:: iid - ObjectID of the IfcEngine to delete
Throws:: ServerException, - UserException; ServerException; UserException

deleteDeserializer

void deleteDeserializer(java.lang.Long sid)
                        throws ServerException,
                               UserException

Parameters:: sid - ObjectID of the Deserializer to delete
Throws:: ServerException, - UserException; ServerException; UserException

getAllSerializerPluginDescriptors

java.util.List<org.bimserver.interfaces.objects.SSerializerPluginDescriptor> getAllSerializerPluginDescriptors()
                                                                                                               throws ServerException,
                                                                                                                      UserException

Returns:: List of all SerializerPluginDescriptors
Throws:: ServerException, - UserException; ServerException; UserException

getAllIfcEnginePluginDescriptors

java.util.List<org.bimserver.interfaces.objects.SIfcEnginePluginDescriptor> getAllIfcEnginePluginDescriptors()
                                                                                                             throws ServerException,
                                                                                                                    UserException

Returns:: List of all SerializerPluginDescriptors
Throws:: ServerException, - UserException; ServerException; UserException

getAllDeserializerPluginDescriptors

java.util.List<org.bimserver.interfaces.objects.SDeserializerPluginDescriptor> getAllDeserializerPluginDescriptors()
                                                                                                                   throws ServerException,
                                                                                                                          UserException

Returns:: List of all DeserializerPluginDescriptors
Throws:: ServerException, - UserException; ServerException; UserException

getSettingMergeIdentifier

org.bimserver.interfaces.objects.SMergeIdentifier getSettingMergeIdentifier()
                                                                            throws ServerException,
                                                                                   UserException

Returns:: A settings that determines how to merge
Throws:: ServerException, - UserException; ServerException; UserException

getSerializerByName

org.bimserver.interfaces.objects.SSerializer getSerializerByName(java.lang.String serializerName)
                                                                 throws ServerException,
                                                                        UserException

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

getIfcEngineByName

org.bimserver.interfaces.objects.SIfcEngine getIfcEngineByName(java.lang.String name)
                                                               throws ServerException,
                                                                      UserException

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

getObjectIDMByName

org.bimserver.interfaces.objects.SObjectIDM getObjectIDMByName(java.lang.String objectIDMName)
                                                               throws ServerException,
                                                                      UserException

Parameters:: objectIDMName - Name of the ObjectIDM
Returns:: ObjectIDM
Throws:: ServerException, - UserException; ServerException; UserException

getDeserializerByName

org.bimserver.interfaces.objects.SDeserializer getDeserializerByName(java.lang.String deserializerName)
                                                                     throws ServerException,
                                                                            UserException

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

hasActiveSerializer

java.lang.Boolean hasActiveSerializer(java.lang.String contentType)
                                      throws ServerException,
                                             UserException

Parameters:: contentType - Content type
Returns:: Whether there is an active Serializer supporting the given ContentType
Throws:: ServerException, - UserException; ServerException; UserException

getAllPlugins

java.util.List<org.bimserver.interfaces.objects.SPluginDescriptor> getAllPlugins()
                                                                                 throws ServerException,
                                                                                        UserException

Returns:: A list of all plugins
Throws:: ServerException, - UserException; ServerException; UserException

enablePlugin

void enablePlugin(java.lang.String name)
                  throws ServerException,
                         UserException

Parameters:: name - Name of the plugin to enable
Throws:: ServerException, - UserException; ServerException; UserException

disablePlugin

void disablePlugin(java.lang.String name)
                   throws ServerException,
                          UserException

Parameters:: name - Name of the plugin to disable
Throws:: ServerException, - UserException; ServerException; UserException

getSerializerByContentType

org.bimserver.interfaces.objects.SSerializer getSerializerByContentType(java.lang.String contentType)
                                                                        throws ServerException,
                                                                               UserException

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

startTransaction

void startTransaction(java.lang.Integer pid)
                      throws ServerException,
                             UserException

Parameters:: pid - ObjectID of the Project to start a transaction on
Throws:: ServerException, - UserException; ServerException; UserException

commitTransaction

java.lang.Long commitTransaction(java.lang.String comment)
                                 throws ServerException,
                                        UserException

Commit the current transaction, changes will be saved, a transaction must be started by startTransaction first

Parameters:: comment - Comment describing what has changed
Returns:: ObjectID of the Revision
Throws:: ServerException, - UserException; ServerException; UserException

abortTransaction

void abortTransaction()
                      throws ServerException,
                             UserException

Abort the current transaction, changes will not be saved

Throws:: ServerException, - UserException; ServerException; UserException

createObject

java.lang.Long createObject(java.lang.String className)
                            throws ServerException,
                                   UserException

Create a new Object

Parameters:: className - The type of the new object
Returns:: The ObjectID of the newly created object
Throws:: ServerException, - UserException; ServerException; UserException

removeObject

void removeObject(java.lang.String className,
                  java.lang.Long oid)
                  throws ServerException,
                         UserException

Remove an object

Parameters:: className - ClassName of the Object, this parameter is required for performance reasons only, but is required; oid - ObjectID of the object to remove
Throws:: ServerException, - UserException; ServerException; UserException

setStringAttribute

void setStringAttribute(java.lang.Long oid,
                        java.lang.String className,
                        java.lang.String attributeName,
                        java.lang.String value)
                        throws ServerException,
                               UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute; value - New String value
Throws:: ServerException, - UserException; ServerException; UserException

setDoubleAttribute

void setDoubleAttribute(java.lang.Long oid,
                        java.lang.String className,
                        java.lang.String attributeName,
                        java.lang.Double value)
                        throws ServerException,
                               UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute; value - New Double value
Throws:: ServerException, - UserException; ServerException; UserException

setEnumAttribute

void setEnumAttribute(java.lang.Long oid,
                      java.lang.String className,
                      java.lang.String attributeName,
                      java.lang.String value)
                      throws ServerException,
                             UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute; value - New Enum value (name of the enum item)
Throws:: ServerException, - UserException; ServerException; UserException

setIntegerAttribute

void setIntegerAttribute(java.lang.Long oid,
                         java.lang.String className,
                         java.lang.String attributeName,
                         java.lang.Integer value)
                         throws ServerException,
                                UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute; value - new Integer value
Throws:: ServerException, - UserException; ServerException; UserException

setBooleanAttribute

void setBooleanAttribute(java.lang.Long oid,
                         java.lang.String className,
                         java.lang.String attributeName,
                         java.lang.Boolean value)
                         throws ServerException,
                                UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute; value - New Boolean value
Throws:: ServerException, - UserException; ServerException; UserException

setReference

void setReference(java.lang.Long oid,
                  java.lang.String className,
                  java.lang.String referenceName,
                  java.lang.Long referenceOid,
                  java.lang.String referenceClassName)
                  throws ServerException,
                         UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; referenceName - Name of the reference; referenceOid - ObjectID of the newly referred object; referenceClassName - Type of the newly referred object
Throws:: ServerException, - UserException; ServerException; UserException

unsetAttribute

void unsetAttribute(java.lang.Long oid,
                    java.lang.String className,
                    java.lang.String attributeName)
                    throws ServerException,
                           UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute to unset
Throws:: ServerException, - UserException; ServerException; UserException

unsetReference

void unsetReference(java.lang.Long oid,
                    java.lang.String className,
                    java.lang.String referenceName)
                    throws ServerException,
                           UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; referenceName - Name of the reference to unset (null)
Throws:: ServerException, - UserException; ServerException; UserException

addStringAttribute

void addStringAttribute(java.lang.Long oid,
                        java.lang.String className,
                        java.lang.String attributeName,
                        java.lang.String value)
                        throws ServerException,
                               UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute to add a value to; value - New String value
Throws:: ServerException, - UserException; ServerException; UserException

addDoubleAttribute

void addDoubleAttribute(java.lang.Long oid,
                        java.lang.String className,
                        java.lang.String attributeName,
                        java.lang.Double value)
                        throws ServerException,
                               UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute to add a value to; value - New Double value
Throws:: ServerException, - UserException; ServerException; UserException

addIntegerAttribute

void addIntegerAttribute(java.lang.Long oid,
                         java.lang.String className,
                         java.lang.String attributeName,
                         java.lang.Integer value)
                         throws ServerException,
                                UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute to add a value to; value - New Integer value
Throws:: ServerException, - UserException; ServerException; UserException

addBooleanAttribute

void addBooleanAttribute(java.lang.Long oid,
                         java.lang.String className,
                         java.lang.String attributeName,
                         java.lang.Boolean value)
                         throws ServerException,
                                UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute to add a value to; value - New Boolean value
Throws:: ServerException, - UserException; ServerException; UserException

addReference

void addReference(java.lang.Long oid,
                  java.lang.String className,
                  java.lang.String referenceName,
                  java.lang.Long referenceOid,
                  java.lang.String referenceClassName)
                  throws ServerException,
                         UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; referenceName - Name of the reference to add a reference to; referenceOid - ObjectID of the newly referenced Object; referenceClassName - Type of the newly referenced Object
Throws:: ServerException, - UserException; ServerException; UserException

removeAttribute

void removeAttribute(java.lang.Long oid,
                     java.lang.String className,
                     java.lang.String attributeName,
                     java.lang.Integer index)
                     throws ServerException,
                            UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; attributeName - Name of the attribute from which to remove an item; index - Index of the item to remove
Throws:: ServerException, - UserException; ServerException; UserException

removeReference

void removeReference(java.lang.Long oid,
                     java.lang.String className,
                     java.lang.String referenceName,
                     java.lang.Integer index)
                     throws ServerException,
                            UserException

Parameters:: oid - ObjectID of the object to change; className - Type of the object to change; referenceName - Name of the reference from which to remove an item; index - Index of the item to remove
Throws:: ServerException, - UserException; ServerException; UserException

getServerStartTime

java.util.Date getServerStartTime()
                                  throws ServerException,
                                         UserException

Returns:: The Date when the BIMserver was last started
Throws:: ServerException, - UserException; ServerException; UserException

getSerializerPluginDescriptor

org.bimserver.interfaces.objects.SSerializerPluginDescriptor getSerializerPluginDescriptor(java.lang.String type)
                                                                                           throws ServerException,
                                                                                                  UserException

Parameters:: type - The type
Returns:: SSerializerPluginDescriptor
Throws:: ServerException, - UserException; ServerException; UserException

getAllObjectIDMPluginDescriptors

java.util.List<org.bimserver.interfaces.objects.SObjectIDMPluginDescriptor> getAllObjectIDMPluginDescriptors()
                                                                                                             throws ServerException,
                                                                                                                    UserException

Returns:: A list of available IDMPlugins
Throws:: ServerException, - UserException; ServerException; UserException

getAllDeserializers

java.util.List<org.bimserver.interfaces.objects.SDeserializer> getAllDeserializers(java.lang.Boolean onlyEnabled)
                                                                                   throws ServerException,
                                                                                          UserException

Parameters:: onlyEnabled - Whether to only include enabled deserializers
Returns:: A list of all available deserializers
Throws:: ServerException, - UserException; ServerException; UserException

setHttpCallback

void setHttpCallback(java.lang.Long uoid,
                     java.lang.String address)
                     throws ServerException,
                            UserException

Parameters:: uoid - ObjectID of the User to change the callBack URL for; address - Address of the callback server (e.g. localhost:2000)
Throws:: ServerException, - UserException; ServerException; UserException

compile

org.bimserver.interfaces.objects.SCompileResult compile(java.lang.String code)
                                                        throws ServerException,
                                                               UserException

Parameters:: code - The Java code, should be an implementation of the QueryInterface interface
Returns:: SCompileResult
Throws:: ServerException, - UserException; ServerException; UserException

compileAndRun

org.bimserver.interfaces.objects.SRunResult compileAndRun(java.lang.Long roid,
                                                          java.lang.String code)
                                                          throws ServerException,
                                                                 UserException

Parameters:: roid - ObjectID of the Revision to perform this query on; code - The Java code, should be an implementation of the QueryInterface interface
Returns:: SRunResult
Throws:: ServerException, - UserException; ServerException; UserException

compileAndDownload

java.lang.Integer compileAndDownload(java.lang.Long roid,
                                     java.lang.String code)
                                     throws ServerException,
                                            UserException

Parameters:: roid - ObjectID of the Revision to perform this query on; code - The Java code, should be an implementation of the QueryInterface interface
Returns:: A download id, which can be used in getDownloadState and getDownloadData
Throws:: ServerException, - UserException; ServerException; UserException

getProtocolBuffersFile

java.lang.String getProtocolBuffersFile()
                                        throws ServerException,
                                               UserException

Thsi will return the content of the .proto file (equivalent for SOAP's WSDL) for the ProtocolBuffers interface

Returns:: Returns a serialized version of the .proto file for the ServiceInterface
Throws:: ServerException, - UserException; ServerException; UserException

getServerInfo

org.bimserver.interfaces.objects.SServerInfo getServerInfo()
                                                           throws ServerException,
                                                                  UserException

Get information about this BIMserver's state

Returns:: A SServerInfo object containing information about the current state
Throws:: ServerException, - UserException; ServerException; UserException

getVersion

org.bimserver.interfaces.objects.SVersion getVersion()
                                                     throws ServerException,
                                                            UserException

Get the actual version of this BIMserver

Returns:: A SVersion object containg the version information
Throws:: ServerException, - UserException; ServerException; UserException

getLatestVersion

org.bimserver.interfaces.objects.SVersion getLatestVersion()
                                                           throws ServerException,
                                                                  UserException

Check which version of BIMserver is the latest available (will download an XML file from bimserver.org)

Returns:: A SVersion object containing the version information
Throws:: ServerException, - UserException; ServerException; UserException

upgradePossible

java.lang.Boolean upgradePossible()
                                  throws ServerException,
                                         UserException

Check whether an upgrade of the BIMserver is available (will download an XML file from bimserver.org)

Returns:: Whether a new version is available
Throws:: ServerException, - UserException; ServerException; UserException

getRemoteAddress

java.lang.String getRemoteAddress()
                                  throws ServerException,
                                         UserException

Get the remove address (which is actually the address the server thinks the client is connecting from)

Returns:: A string with a hostname or ip address
Throws:: ServerException, - UserException; ServerException; UserException

getServerLog

java.lang.String getServerLog()
                              throws ServerException,
                                     UserException

Returns:: The BIMserver log (can be big)
Throws:: ServerException; UserException

getSuggestedDeserializerForExtension

java.lang.String getSuggestedDeserializerForExtension(java.lang.String extension)
                                                      throws ServerException,
                                                             UserException

Returns:: The name of the suggested deserializer
Throws:: ServerException; UserException

getCheckinWarnings

java.util.Set<java.lang.String> getCheckinWarnings(java.lang.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