org.bimserver.shared.interfaces.bimsie1

Interface Bimsie1ServiceInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

Bimsie1ServiceInterfaceAdaptor

public interface Bimsie1ServiceInterface
extends PublicInterface

Method Summary

Modifier and Type	Method and Description
void	addExtendedDataToRevision(Long roid, SExtendedData extendedData)
SProject	addProject(String projectName, String schema) Add a new project
SProject	addProjectAsSubProject(String projectName, Long parentPoid, String schema) Add a new project as a subproject of another project
Long	branchToExistingProject(Long roid, Long destPoid, String comment, Boolean sync) Branch a given Revision as a new Revision in the given Project, branching is always synchronous
Long	branchToNewProject(Long roid, String projectName, String comment, Boolean sync) Branch a given Revision as a new Revision on a new Project, branching is always synchronous
Long	checkin(Long poid, String comment, Long deserializerOid, Long fileSize, String fileName, DataHandler data, Boolean sync) Checkin a new model by sending a serialized form
Long	checkinFromUrl(Long poid, String comment, Long deserializerOid, String fileName, String url, Boolean sync) Checkin a new model by sending a serialized form
Long	checkout(Long roid, Long serializerOid, Boolean sync) Checkout an existing model, checkout is the same as download, except a "checkout" will tell the server and other users you are working on it
Boolean	deleteProject(Long poid) Delete a Project, Projects can be undeleted with the undeleteProject method
Long	download(Long roid, Long serializerOid, Boolean showOwn, Boolean sync) Download a single revision of a model in a serialized format
Long	downloadByGuids(Set<Long> roids, Set<String> guids, Long serializerOid, Boolean deep, Boolean sync) Download a model in a serialized format by giving a set of revisions and a set of guids to filter on
Long	downloadByJsonQuery(Set<Long> roids, String jsonQuery, Long serializerOid, Boolean sync) Download a model in serialized format by giving a set of revisions and a set of class names to filter on
Long	downloadByNames(Set<Long> roids, Set<String> names, Long serializerOid, Boolean deep, Boolean sync) Download a model in a serialized format by giving a set of revisions and a set of names to filter on
Long	downloadByNewJsonQuery(Set<Long> roids, String query, Long serializerOid, Boolean sync) Download a model in serialized format by giving a set of revisions and a set of class names to filter on
Long	downloadByOids(Set<Long> roids, Set<Long> oids, Long serializerOid, Boolean sync, Boolean deep) Download a model in a serialized format by giving a set of revisions and a set of Object IDs
Long	downloadByTypes(Set<Long> roids, String schema, Set<String> classNames, Long serializerOid, Boolean includeAllSubtypes, Boolean useObjectIDM, Boolean deep, Boolean sync) Download a model in serialized format by giving a set of revisions and a set of class names to filter on
Long	downloadQuery(Long roid, Long qeid, String code, Boolean sync, Long serializerOid)
Long	downloadRevisions(Set<Long> roids, Long serializerOid, Boolean sync) Download a model in a serialized format by giving a set of revisions
List<SExtendedData>	getAllExtendedDataOfRevision(Long roid)
List<SProject>	getAllProjects(Boolean onlyTopLevel, Boolean onlyActive) Get a list of all Projects the user is authorized for
List<SProjectSmall>	getAllProjectsSmall()
List<SRevision>	getAllRevisionsOfProject(Long poid) Get a list of all Revisions of a Project
SDeserializerPluginConfiguration	getDeserializerById(Long oid)
SDeserializerPluginConfiguration	getDeserializerByName(String deserializerName)
SDownloadResult	getDownloadData(Long topicId) Get the data for a download/checkout
SExtendedData	getExtendedData(Long oid)
SExtendedDataSchema	getExtendedDataSchemaById(Long oid)
SExtendedDataSchema	getExtendedDataSchemaByNamespace(String namespace)
SProject	getProjectByPoid(Long poid)
List<SProject>	getProjectsByName(String name)
SProjectSmall	getProjectSmallByPoid(Long poid)
SQueryEnginePluginConfiguration	getQueryEngineById(Long oid)
SQueryEnginePluginConfiguration	getQueryEngineByName(String name)
SRevision	getRevision(Long roid)
SSerializerPluginConfiguration	getSerializerByContentType(String contentType)
SSerializerPluginConfiguration	getSerializerById(Long oid)
SSerializerPluginConfiguration	getSerializerByName(String serializerName)
List<SProject>	getSubProjects(Long poid)
SDeserializerPluginConfiguration	getSuggestedDeserializerForExtension(String extension, Long poid) Get a suggested deserializer for the given file extension and project
Long	initiateCheckin(Long poid, Long deserializerOid)
void	terminateLongRunningAction(Long topicId) Terminate a long running action
Boolean	undeleteProject(Long poid) Undelete a previously deleted Project, Projets can be deleted with the deleteProject method

Method Detail

checkin

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

Checkin a new model by sending a serialized form

Parameters:

poid - The Project's ObjectID

comment - A comment

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

fileSize - The size of the file in bytes

ifcFile - The actual file

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

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

initiateCheckin

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

Throws:

ServerException

UserException

checkinFromUrl

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

Checkin a new model by sending a serialized form

Parameters:

poid - The Project's ObjectID

comment - A comment

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

url - A URL to the file

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

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

terminateLongRunningAction

void terminateLongRunningAction(Long topicId)
                         throws ServerException,
                                UserException

Terminate a long running action

Parameters:

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

Throws:

ServerException, - UserException

ServerException

UserException

checkout

Long checkout(Long roid,
              Long serializerOid,
              Boolean sync)
       throws ServerException,
              UserException

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

Parameters:

roid - Revision ObjectID

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

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

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

download

Long download(Long roid,
              Long serializerOid,
              Boolean showOwn,
              Boolean sync)
       throws ServerException,
              UserException

Download a single revision of a model in a serialized format

Parameters:

roid - Revision ObjectID

serializerOid - ObjectId 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:

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

Throws:

ServerException, - UserException

ServerException

UserException

downloadByOids

Long downloadByOids(Set<Long> roids,
                    Set<Long> oids,
                    Long serializerOid,
                    Boolean sync,
                    Boolean deep)
             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

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

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

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

downloadByTypes

Long downloadByTypes(Set<Long> roids,
                     String schema,
                     Set<String> classNames,
                     Long serializerOid,
                     Boolean includeAllSubtypes,
                     Boolean useObjectIDM,
                     Boolean deep,
                     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")

serializerOid - ObjectId 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:

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

Throws:

ServerException, - UserException

ServerException

UserException

downloadByJsonQuery

Long downloadByJsonQuery(Set<Long> roids,
                         String jsonQuery,
                         Long serializerOid,
                         Boolean sync)
                  throws ServerException,
                         UserException

Download a model in serialized format by giving a set of revisions and a set of class names to filter on

Parameters:

roids - A set of Revision ObjectIDs

classNames - A set of class names to filter on (e.g. "IfcWindow")

serializerOid - ObjectId 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:

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

Throws:

ServerException, - UserException

ServerException

UserException

downloadByNewJsonQuery

Long downloadByNewJsonQuery(Set<Long> roids,
                            String query,
                            Long serializerOid,
                            Boolean sync)
                     throws ServerException,
                            UserException

Download a model in serialized format by giving a set of revisions and a set of class names to filter on

Parameters:

roids - A set of Revision ObjectIDs

classNames - A set of class names to filter on (e.g. "IfcWindow")

serializerOid - ObjectId 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:

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

Throws:

ServerException, - UserException

ServerException

UserException

downloadByGuids

Long downloadByGuids(Set<Long> roids,
                     Set<String> guids,
                     Long serializerOid,
                     Boolean deep,
                     Boolean sync)
              throws ServerException,
                     UserException

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

Parameters:

roids - A set of Revision ObjectIDs

guids - A set of IFC guids

serializerOid - OID of the serializer to use

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

downloadByNames

Long downloadByNames(Set<Long> roids,
                     Set<String> names,
                     Long serializerOid,
                     Boolean deep,
                     Boolean sync)
              throws ServerException,
                     UserException

Download a model in a serialized format by giving a set of revisions and a set of names to filter on

Parameters:

roids - A set of Revision ObjectIDs

names - A set of names, the names should be exact matches for now

serializerOid - OID of the serializer to use

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

Long downloadRevisions(Set<Long> roids,
                       Long serializerOid,
                       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

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

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

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

downloadQuery

Long downloadQuery(Long roid,
                   Long qeid,
                   String code,
                   Boolean sync,
                   Long serializerOid)
            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

getDownloadData

SDownloadResult getDownloadData(Long topicId)
                         throws ServerException,
                                UserException

Get the data for a download/checkout

Parameters:

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

Returns:

An SDownloadResult containing the serialized data

Throws:

ServerException, - UserException

ServerException

UserException

getSerializerByName

SSerializerPluginConfiguration getSerializerByName(String serializerName)
                                            throws ServerException,
                                                   UserException

Parameters:

serializerName - Name of the Serializer

Returns:

Serializer

Throws:

ServerException, - UserException

ServerException

UserException

getDeserializerById

SDeserializerPluginConfiguration getDeserializerById(Long oid)
                                              throws ServerException,
                                                     UserException

Parameters:

oid - ObjectID of the Deserializer

Returns:

Deserializer

Throws:

ServerException, - UserException

ServerException

UserException

getDeserializerByName

SDeserializerPluginConfiguration getDeserializerByName(String deserializerName)
                                                throws ServerException,
                                                       UserException

Parameters:

deserializerName - Name of the Deserializer

Returns:

Deserializer

Throws:

ServerException, - UserException

ServerException

UserException

getSerializerById

SSerializerPluginConfiguration getSerializerById(Long oid)
                                          throws ServerException,
                                                 UserException

Parameters:

oid - ObjectID of the Serializer

Returns:

Serializer

Throws:

ServerException, - UserException

ServerException

UserException

getSerializerByContentType

SSerializerPluginConfiguration getSerializerByContentType(String contentType)
                                                   throws ServerException,
                                                          UserException

Parameters:

contentType - The ContentType

Returns:

Serializer supporting the given ContentType

Throws:

ServerException, - UserException

ServerException

UserException

getQueryEngineByName

SQueryEnginePluginConfiguration getQueryEngineByName(String name)
                                              throws ServerException,
                                                     UserException

Parameters:

name - Name of the QueryEngine

Returns:

QueryEngine

Throws:

ServerException, - UserException

ServerException

UserException

getQueryEngineById

SQueryEnginePluginConfiguration getQueryEngineById(Long oid)
                                            throws ServerException,
                                                   UserException

Parameters:

oid - ObjectID of the QueryEngine

Returns:

QueryEngine

Throws:

ServerException, - UserException

ServerException

UserException

getSuggestedDeserializerForExtension

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

Get a suggested deserializer for the given file extension and project

Parameters:

extension - File extension without the dot(.), for example "ifc"

poid - ProjectID of the project, this is relevant because a project has a specific schema, so we are looking for a deserializer that can handle this schema

Returns:

The name of the suggested deserializer

Throws:

ServerException

UserException

addExtendedDataToRevision

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

Parameters:

roid - ObjectID of the Revision

extendedData - ExtendedData to add

Throws:

ServerException, - UserException

ServerException

UserException

getExtendedData

SExtendedData getExtendedData(Long oid)
                       throws ServerException,
                              UserException

Parameters:

oid - ObjectID of the ExtendedData

Returns:

ExtendedData

Throws:

ServerException, - UserException

ServerException

UserException

getAllExtendedDataOfRevision

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

Parameters:

roid - ObjectID of the Revision

Returns:

ExtendedData

Throws:

ServerException, - UserException

ServerException

UserException

getProjectByPoid

SProject getProjectByPoid(Long poid)
                   throws ServerException,
                          UserException

Parameters:

poid - ObjectID of the Project

Returns:

The Project

Throws:

ServerException, - UserException

ServerException

UserException

getProjectSmallByPoid

SProjectSmall getProjectSmallByPoid(Long poid)
                             throws ServerException,
                                    UserException

Parameters:

poid - ObjectID of the Project

Returns:

The Project

Throws:

ServerException, - UserException

ServerException

UserException

getRevision

SRevision getRevision(Long roid)
               throws ServerException,
                      UserException

Parameters:

roid - ObjectID of the Revision

Returns:

The Revision

Throws:

ServerException, - UserException

ServerException

UserException

undeleteProject

Boolean undeleteProject(Long poid)
                 throws ServerException,
                        UserException

Undelete a previously deleted Project, Projets can be deleted with the deleteProject method

Parameters:

poid - The ObjectID of the Project to undelete

Returns:

Whether the Project was successfully undeleted

Throws:

ServerException, - UserException

ServerException

UserException

branchToNewProject

Long branchToNewProject(Long roid,
                        String projectName,
                        String comment,
                        Boolean sync)
                 throws ServerException,
                        UserException

Branch a given Revision as a new Revision on a new Project, branching is always synchronous

Parameters:

roid - ObjectID of the Revision to branch

projectName - Name of the to be created Project

comment - A comment describing the new Revision

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

branchToExistingProject

Long branchToExistingProject(Long roid,
                             Long destPoid,
                             String comment,
                             Boolean sync)
                      throws ServerException,
                             UserException

Branch a given Revision as a new Revision in the given Project, branching is always synchronous

Parameters:

roid - ObjectID of the Revision to branch

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

comment - A comment describing the new Revision

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

getProjectsByName

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

Parameters:

name -

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

getSubProjects

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

Parameters:

poid -

Returns:

A list of all subprojects of the given project

Throws:

ServerException, - UserException

ServerException

UserException

getExtendedDataSchemaById

SExtendedDataSchema getExtendedDataSchemaById(Long oid)
                                       throws ServerException,
                                              UserException

Parameters:

oid - ObjectID of the ExtendedDataSchema

Returns:

ExtendedDataSchema

Throws:

ServerException, - UserException

ServerException

UserException

getAllRevisionsOfProject

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

Get a list of all Revisions of a Project

Parameters:

poid - ObjectID of the Project

Returns:

A list of all Revisions

Throws:

ServerException, - UserException

ServerException

UserException

getAllProjects

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

Get a list of all Projects the user is authorized for

Returns:

A list of Projects

Throws:

ServerException, - UserException

ServerException

UserException

addProject

SProject addProject(String projectName,
                    String schema)
             throws ServerException,
                    UserException

Add a new project

Parameters:

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

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

Returns:

The created Project

Throws:

ServerException, - UserException

ServerException

UserException

addProjectAsSubProject

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

Add a new project as a subproject of another project

Parameters:

projectName - Name of the project, must be a unique name within the parent project

parentPoid - The ObjectID of the parent project

Returns:

The created Project

Throws:

ServerException, - UserException

ServerException

UserException

deleteProject

Boolean deleteProject(Long poid)
               throws ServerException,
                      UserException

Delete a Project, Projects can be undeleted with the undeleteProject method

Parameters:

poid - ObjectID of the Project to delete

Returns:

Whether the Project has been deleted

Throws:

ServerException, - UserException

ServerException

UserException

getExtendedDataSchemaByNamespace

SExtendedDataSchema getExtendedDataSchemaByNamespace(String namespace)
                                              throws UserException,
                                                     ServerException

Throws:

UserException

ServerException

getAllProjectsSmall

List<SProjectSmall> getAllProjectsSmall()
                                 throws ServerException,
                                        UserException

Throws:

ServerException

UserException