public class Bimsie1ServiceInterfaceAdaptor extends Object implements Bimsie1ServiceInterface
| Constructor and Description |
|---|
Bimsie1ServiceInterfaceAdaptor() |
| 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
|
public void addExtendedDataToRevision(Long roid, SExtendedData extendedData) throws UserException, ServerException
addExtendedDataToRevision in interface Bimsie1ServiceInterfaceroid - ObjectID of the RevisionextendedData - ExtendedData to addUserExceptionServerExceptionpublic SProject addProject(String projectName, String schema) throws UserException, ServerException
Bimsie1ServiceInterfaceaddProject in interface Bimsie1ServiceInterfaceprojectName - Name of the project, must be a unique name within all root-projectsschema - Schema of the project, you can only checkin models of this schema (available options are: "ifc2x3tc1" and "ifc4")UserExceptionServerExceptionpublic SProject addProjectAsSubProject(String projectName, Long parentPoid, String schema) throws UserException, ServerException
Bimsie1ServiceInterfaceaddProjectAsSubProject in interface Bimsie1ServiceInterfaceprojectName - Name of the project, must be a unique name within the parent projectparentPoid - The ObjectID of the parent projectUserExceptionServerExceptionpublic Long branchToExistingProject(Long roid, Long destPoid, String comment, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacebranchToExistingProject in interface Bimsie1ServiceInterfaceroid - ObjectID of the Revision to branchdestPoid - ObjectID of the Project to which a branch should be madecomment - A comment describing the new RevisionUserExceptionServerExceptionpublic Long branchToNewProject(Long roid, String projectName, String comment, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacebranchToNewProject in interface Bimsie1ServiceInterfaceroid - ObjectID of the Revision to branchprojectName - Name of the to be created Projectcomment - A comment describing the new RevisionUserExceptionServerExceptionpublic Long checkin(Long poid, String comment, Long deserializerOid, Long fileSize, String fileName, DataHandler data, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacecheckin in interface Bimsie1ServiceInterfacepoid - The Project's ObjectIDcomment - A commentdeserializerOid - ObjectId of the deserializer to use, use getAllDeserializers to get a list of available deserializersfileSize - The size of the file in bytessync - Whether the call should return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long checkinFromUrl(Long poid, String comment, Long deserializerOid, String fileName, String url, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacecheckinFromUrl in interface Bimsie1ServiceInterfacepoid - The Project's ObjectIDcomment - A commentdeserializerOid - ObjectId of the deserializer to use, use getAllDeserializers to get a list of available deserializersurl - A URL to the filesync - Whether the call should return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long checkout(Long roid, Long serializerOid, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacecheckout in interface Bimsie1ServiceInterfaceroid - Revision ObjectIDserializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeressync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Boolean deleteProject(Long poid) throws UserException, ServerException
Bimsie1ServiceInterfacedeleteProject in interface Bimsie1ServiceInterfacepoid - ObjectID of the Project to deleteUserExceptionServerExceptionpublic Long download(Long roid, Long serializerOid, Boolean showOwn, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacedownload in interface Bimsie1ServiceInterfaceroid - Revision ObjectIDserializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeresshowOwn - Whether to return revisions created by the current usersync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long downloadByGuids(Set<Long> roids, Set<String> guids, Long serializerOid, Boolean deep, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacedownloadByGuids in interface Bimsie1ServiceInterfaceroids - A set of Revision ObjectIDsguids - A set of IFC guidsserializerOid - OID of the serializer to usesync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long downloadByJsonQuery(Set<Long> roids, String jsonQuery, Long serializerOid, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacedownloadByJsonQuery in interface Bimsie1ServiceInterfaceroids - A set of Revision ObjectIDsserializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeressync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long downloadByNames(Set<Long> roids, Set<String> names, Long serializerOid, Boolean deep, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacedownloadByNames in interface Bimsie1ServiceInterfaceroids - A set of Revision ObjectIDsnames - A set of names, the names should be exact matches for nowserializerOid - OID of the serializer to usesync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long downloadByNewJsonQuery(Set<Long> roids, String query, Long serializerOid, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacedownloadByNewJsonQuery in interface Bimsie1ServiceInterfaceroids - A set of Revision ObjectIDsserializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeressync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long downloadByOids(Set<Long> roids, Set<Long> oids, Long serializerOid, Boolean sync, Boolean deep) throws UserException, ServerException
Bimsie1ServiceInterfacedownloadByOids in interface Bimsie1ServiceInterfaceroids - A set of Revision ObjectIDsoids - A set of ObjectIDsserializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeressync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long downloadByTypes(Set<Long> roids, String schema, Set<String> classNames, Long serializerOid, Boolean includeAllSubtypes, Boolean useObjectIDM, Boolean deep, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacedownloadByTypes in interface Bimsie1ServiceInterfaceroids - A set of Revision ObjectIDsclassNames - A set of class names to filter on (e.g. "IfcWindow")serializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeresincludeAllSubtypes - Whether to query all (recursive) subtypes of each gives classsync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic Long downloadQuery(Long roid, Long qeid, String code, Boolean sync, Long serializerOid) throws UserException, ServerException
downloadQuery in interface Bimsie1ServiceInterfaceroid - ObjectID of the Revision to perform this query oncode - The Java code, should be an implementation of the QueryInterface interfaceUserExceptionServerExceptionpublic Long downloadRevisions(Set<Long> roids, Long serializerOid, Boolean sync) throws UserException, ServerException
Bimsie1ServiceInterfacedownloadRevisions in interface Bimsie1ServiceInterfaceroids - A set of Revision ObjectIDsserializerOid - ObjectId of the serializer to use, use getAllSerializers to find availble serializeressync - Whether to return immediately (async) or wait for completion (sync)UserExceptionServerExceptionpublic List<SExtendedData> getAllExtendedDataOfRevision(Long roid) throws UserException, ServerException
getAllExtendedDataOfRevision in interface Bimsie1ServiceInterfaceroid - ObjectID of the RevisionUserExceptionServerExceptionpublic List<SProject> getAllProjects(Boolean onlyTopLevel, Boolean onlyActive) throws UserException, ServerException
Bimsie1ServiceInterfacegetAllProjects in interface Bimsie1ServiceInterfaceUserExceptionServerExceptionpublic List<SProjectSmall> getAllProjectsSmall() throws UserException, ServerException
getAllProjectsSmall in interface Bimsie1ServiceInterfaceUserExceptionServerExceptionpublic List<SRevision> getAllRevisionsOfProject(Long poid) throws UserException, ServerException
Bimsie1ServiceInterfacegetAllRevisionsOfProject in interface Bimsie1ServiceInterfacepoid - ObjectID of the ProjectUserExceptionServerExceptionpublic SDeserializerPluginConfiguration getDeserializerById(Long oid) throws UserException, ServerException
getDeserializerById in interface Bimsie1ServiceInterfaceoid - ObjectID of the DeserializerUserExceptionServerExceptionpublic SDeserializerPluginConfiguration getDeserializerByName(String deserializerName) throws UserException, ServerException
getDeserializerByName in interface Bimsie1ServiceInterfacedeserializerName - Name of the DeserializerUserExceptionServerExceptionpublic SDownloadResult getDownloadData(Long topicId) throws UserException, ServerException
Bimsie1ServiceInterfacegetDownloadData in interface Bimsie1ServiceInterfacetopicId - The topicId returned by one of the download or checkout methodsUserExceptionServerExceptionpublic SExtendedData getExtendedData(Long oid) throws UserException, ServerException
getExtendedData in interface Bimsie1ServiceInterfaceoid - ObjectID of the ExtendedDataUserExceptionServerExceptionpublic SExtendedDataSchema getExtendedDataSchemaById(Long oid) throws UserException, ServerException
getExtendedDataSchemaById in interface Bimsie1ServiceInterfaceoid - ObjectID of the ExtendedDataSchemaUserExceptionServerExceptionpublic SExtendedDataSchema getExtendedDataSchemaByNamespace(String namespace) throws UserException, ServerException
getExtendedDataSchemaByNamespace in interface Bimsie1ServiceInterfaceUserExceptionServerExceptionpublic SProject getProjectByPoid(Long poid) throws UserException, ServerException
getProjectByPoid in interface Bimsie1ServiceInterfacepoid - ObjectID of the ProjectUserExceptionServerExceptionpublic SProjectSmall getProjectSmallByPoid(Long poid) throws UserException, ServerException
getProjectSmallByPoid in interface Bimsie1ServiceInterfacepoid - ObjectID of the ProjectUserExceptionServerExceptionpublic List<SProject> getProjectsByName(String name) throws UserException, ServerException
getProjectsByName in interface Bimsie1ServiceInterfaceUserExceptionServerExceptionpublic SQueryEnginePluginConfiguration getQueryEngineById(Long oid) throws UserException, ServerException
getQueryEngineById in interface Bimsie1ServiceInterfaceoid - ObjectID of the QueryEngineUserExceptionServerExceptionpublic SQueryEnginePluginConfiguration getQueryEngineByName(String name) throws UserException, ServerException
getQueryEngineByName in interface Bimsie1ServiceInterfacename - Name of the QueryEngineUserExceptionServerExceptionpublic SRevision getRevision(Long roid) throws UserException, ServerException
getRevision in interface Bimsie1ServiceInterfaceroid - ObjectID of the RevisionUserExceptionServerExceptionpublic SSerializerPluginConfiguration getSerializerByContentType(String contentType) throws UserException, ServerException
getSerializerByContentType in interface Bimsie1ServiceInterfacecontentType - The ContentTypeUserExceptionServerExceptionpublic SSerializerPluginConfiguration getSerializerById(Long oid) throws UserException, ServerException
getSerializerById in interface Bimsie1ServiceInterfaceoid - ObjectID of the SerializerUserExceptionServerExceptionpublic SSerializerPluginConfiguration getSerializerByName(String serializerName) throws UserException, ServerException
getSerializerByName in interface Bimsie1ServiceInterfaceserializerName - Name of the SerializerUserExceptionServerExceptionpublic List<SProject> getSubProjects(Long poid) throws UserException, ServerException
getSubProjects in interface Bimsie1ServiceInterfaceUserExceptionServerExceptionpublic SDeserializerPluginConfiguration getSuggestedDeserializerForExtension(String extension, Long poid) throws UserException, ServerException
Bimsie1ServiceInterfacegetSuggestedDeserializerForExtension in interface Bimsie1ServiceInterfaceextension - 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 schemaServerExceptionUserExceptionpublic Long initiateCheckin(Long poid, Long deserializerOid) throws UserException, ServerException
initiateCheckin in interface Bimsie1ServiceInterfaceUserExceptionServerExceptionpublic void terminateLongRunningAction(Long topicId) throws UserException, ServerException
Bimsie1ServiceInterfaceterminateLongRunningAction in interface Bimsie1ServiceInterfacetopicId - The actionId returned by one of the download or checkout methodsUserExceptionServerExceptionpublic Boolean undeleteProject(Long poid) throws UserException, ServerException
Bimsie1ServiceInterfaceundeleteProject in interface Bimsie1ServiceInterfacepoid - The ObjectID of the Project to undeleteUserExceptionServerExceptionCopyright © 2016 OpenSource BIM. All rights reserved.