org.bimserver.shared.interfaces

Interface LowLevelInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

LowLevelInterfaceAdaptor

public interface LowLevelInterface
extends PublicInterface

Method Summary

Modifier and Type	Method and Description
void	abortTransaction(Long tid) Abort a transaction, changes will not be saved
void	addBooleanAttribute(Long tid, Long oid, String attributeName, Boolean value) Add a boolean attribute.
void	addDoubleAttribute(Long tid, Long oid, String attributeName, Double value) Add a double attribute.
void	addIntegerAttribute(Long tid, Long oid, String attributeName, Integer value) Add an integer attribute.
void	addReference(Long tid, Long oid, String referenceName, Long referenceOid) Add a reference to a list.
void	addStringAttribute(Long tid, Long oid, String attributeName, String value) Add a String attribute.
Long	commitTransaction(Long tid, String comment) Commit a transaction, changes will be saved, a transaction must be started by startTransaction first
Integer	count(Long roid, String className) Count the amount of object a certain revision has of the given type
Long	createObject(Long tid, String className, Boolean generateGuid) Create a new Object
Boolean	getBooleanAttribute(Long tid, Long oid, String attributeName) Get a boolean value of an attribute
Boolean	getBooleanAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index) Retrieve a boolean attribute at the given index
List<Boolean>	getBooleanAttributes(Long tid, Long oid, String attributeName) Retrieve a list of boolean attributes
byte[]	getByteArrayAttribute(Long tid, Long oid, String attributeName) Get a byte[] attribute
List<byte[]>	getByteArrayAttributes(Long tid, Long oid, String attributeName) Get a list of byte[] values
SDataObject	getDataObjectByGuid(Long roid, String guid) Deprecated.
SDataObject	getDataObjectByOid(Long roid, Long oid) Deprecated.
List<SDataObject>	getDataObjects(Long roid) Deprecated.
List<SDataObject>	getDataObjectsByType(Long roid, String packageName, String className, Boolean flat) Deprecated.
Double	getDoubleAttribute(Long tid, Long oid, String attributeName) Get a list of double values (for example Coordinates of IfcCartesianPoint)
Double	getDoubleAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index) Get a double value of an attribute at a given index
List<Double>	getDoubleAttributes(Long tid, Long oid, String attributeName) Get a list of double values
String	getEnumAttribute(Long tid, Long oid, String attributeName) Get an enum attribute
Integer	getIntegerAttribute(Long tid, Long oid, String attributeName) Get an integer attribute
Integer	getIntegerAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index) Get an integer attribute at the given index
List<Integer>	getIntegerAttributes(Long tid, Long oid, String attributeName) Get a list of integer attributes
Long	getLongAttribute(Long tid, Long oid, String attributeName) Get a long value of an attribute
Long	getLongAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index) Get a long attribute at a given index
Long	getReference(Long tid, Long oid, String referenceName) Get a reference
List<Long>	getReferences(Long tid, Long oid, String referenceName) Get a list of references
String	getStringAttribute(Long tid, Long oid, String attributeName) Get the String value of an attribute
List<String>	getStringAttributes(Long tid, Long oid, String attributeName) Get a list of attributes of type String
void	removeAllReferences(Long tid, Long oid, String referenceName) Remove all references (clear the list of references) of the given object + reference
void	removeAttribute(Long tid, Long oid, String attributeName, Integer index) Remove an attribute from a list at a certain index
void	removeObject(Long tid, Long oid) Remove an object
void	removeReference(Long tid, Long oid, String referenceName, Integer index) Remove a single reference by it's index in the list
void	removeReferenceByOid(Long tid, Long oid, String referenceName, Long referencedOid) Remove a single reference by it's oid
void	setBooleanAttribute(Long tid, Long oid, String attributeName, Boolean value) Set a boolean attribute
void	setBooleanAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index, Boolean value) Set a boolean attribute at the given index
void	setBooleanAttributes(Long tid, Long oid, String attributeName, List<Boolean> values) Set a list of boolean attributes
void	setByteArrayAttribute(Long tid, Long oid, String attributeName, Byte[] value) Set a byte[] attribute
void	setDoubleAttribute(Long tid, Long oid, String attributeName, Double value) Set a double attribute
void	setDoubleAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index, Double value) Set a double attribute at a specific index
void	setDoubleAttributes(Long tid, Long oid, String attributeName, List<Double> values) Set a list of double values (for example Coordinates of IfcCartesianPoint)
void	setEnumAttribute(Long tid, Long oid, String attributeName, String value) Set an enum attribute
void	setIntegerAttribute(Long tid, Long oid, String attributeName, Integer value) Set an integer attribute
void	setIntegerAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index, Integer value) Set an integer attribute at a given index
void	setIntegerAttributes(Long tid, Long oid, String attributeName, List<Integer> values) Set a list of integer attributes
void	setLongAttribute(Long tid, Long oid, String attributeName, Long value) Set a long attribute
void	setLongAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index, Long value) Set a long attribute at a given index
void	setLongAttributes(Long tid, Long oid, String attributeName, List<Long> values) Set a list of long attributes
void	setReference(Long tid, Long oid, String referenceName, Long referenceOid) Set a reference
void	setStringAttribute(Long tid, Long oid, String attributeName, String value) Set the String value of an attribute
void	setStringAttributeAtIndex(Long tid, Long oid, String attributeName, Integer index, String value) Set the String value at a certain index in a list of an attribute
void	setWrappedBooleanAttribute(Long tid, Long oid, String attributeName, String type, Boolean value) Set a wrapped boolean attribute
void	setWrappedDoubleAttribute(Long tid, Long oid, String attributeName, String type, Double value) Set a wrapped attribute's double value
void	setWrappedIntegerAttribute(Long tid, Long oid, String attributeName, String type, Integer value) Set a warpped integer attribute
void	setWrappedLongAttribute(Long tid, Long oid, String attributeName, String type, Long value) Set a wrapped long value
void	setWrappedStringAttribute(Long tid, Long oid, String attributeName, String type, String value) Set the wrapped value of a String attribute
Long	startTransaction(Long poid) Start a new transaction.
void	unsetAttribute(Long tid, Long oid, String attributeName) Unset an attribute
void	unsetReference(Long tid, Long oid, String referenceName) Unset a reference

Method Detail

startTransaction

Long startTransaction(Long poid)
               throws ServerException,
                      UserException

Start a new transaction. You can commit the transaction with commitTransaction

Parameters:

poid - ObjectID of the Project to start a transaction on

Returns:

A TransactionID (tid) that should be used for subsequent calls

Throws:

ServerException, - UserException

ServerException

UserException

commitTransaction

Long commitTransaction(Long tid,
                       String comment)
                throws ServerException,
                       UserException

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

Parameters:

tid - The TransactionID

comment - Comment describing what has changed

Returns:

ObjectID of the newly created Revision

Throws:

ServerException, - UserException

ServerException

UserException

abortTransaction

void abortTransaction(Long tid)
               throws ServerException,
                      UserException

Abort a transaction, changes will not be saved

Parameters:

tid - The TransactionID

Throws:

ServerException, - UserException

ServerException

UserException

createObject

Long createObject(Long tid,
                  String className,
                  Boolean generateGuid)
           throws ServerException,
                  UserException

Create a new Object

Parameters:

tid - The TransactionID

className - The type of the new object

Returns:

The ObjectID of the newly created object

Throws:

ServerException, - UserException

ServerException

UserException

removeObject

void removeObject(Long tid,
                  Long oid)
           throws ServerException,
                  UserException

Remove an object

Parameters:

tid - The TransactionID

oid - ObjectID of the object to remove

Throws:

ServerException, - UserException

ServerException

UserException

setStringAttribute

void setStringAttribute(Long tid,
                        Long oid,
                        String attributeName,
                        String value)
                 throws ServerException,
                        UserException

Set the String value of an attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New String value

Throws:

ServerException, - UserException

ServerException

UserException

setStringAttributeAtIndex

void setStringAttributeAtIndex(Long tid,
                               Long oid,
                               String attributeName,
                               Integer index,
                               String value)
                        throws ServerException,
                               UserException

Set the String value at a certain index in a list of an attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New String value

Throws:

ServerException, - UserException

ServerException

UserException

setWrappedStringAttribute

void setWrappedStringAttribute(Long tid,
                               Long oid,
                               String attributeName,
                               String type,
                               String value)
                        throws ServerException,
                               UserException

Set the wrapped value of a String attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New String value

Throws:

ServerException, - UserException

ServerException

UserException

getStringAttribute

String getStringAttribute(Long tid,
                          Long oid,
                          String attributeName)
                   throws ServerException,
                          UserException

Get the String value of an attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New String value

Returns:

The String value

Throws:

ServerException, - UserException

ServerException

UserException

getStringAttributes

List<String> getStringAttributes(Long tid,
                                 Long oid,
                                 String attributeName)
                          throws ServerException,
                                 UserException

Get a list of attributes of type String

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New String value

Returns:

A list of Strings

Throws:

ServerException, - UserException

ServerException

UserException

setDoubleAttribute

void setDoubleAttribute(Long tid,
                        Long oid,
                        String attributeName,
                        Double value)
                 throws ServerException,
                        UserException

Set a double attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New Double value

Throws:

ServerException, - UserException

ServerException

UserException

setDoubleAttributeAtIndex

void setDoubleAttributeAtIndex(Long tid,
                               Long oid,
                               String attributeName,
                               Integer index,
                               Double value)
                        throws ServerException,
                               UserException

Set a double attribute at a specific index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New Double value

Throws:

ServerException, - UserException

ServerException

UserException

setWrappedDoubleAttribute

void setWrappedDoubleAttribute(Long tid,
                               Long oid,
                               String attributeName,
                               String type,
                               Double value)
                        throws ServerException,
                               UserException

Set a wrapped attribute's double value

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

type - Type of the wrapped value

value - New Double value

Throws:

ServerException, - UserException

ServerException

UserException

setDoubleAttributes

void setDoubleAttributes(Long tid,
                         Long oid,
                         String attributeName,
                         List<Double> values)
                  throws ServerException,
                         UserException

Set a list of double values (for example Coordinates of IfcCartesianPoint)

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

values - List of double values

Throws:

ServerException, - UserException

ServerException

UserException

getDoubleAttribute

Double getDoubleAttribute(Long tid,
                          Long oid,
                          String attributeName)
                   throws ServerException,
                          UserException

Get a list of double values (for example Coordinates of IfcCartesianPoint)

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

List of double values

Throws:

ServerException, - UserException

ServerException

UserException

getDoubleAttributeAtIndex

Double getDoubleAttributeAtIndex(Long tid,
                                 Long oid,
                                 String attributeName,
                                 Integer index)
                          throws ServerException,
                                 UserException

Get a double value of an attribute at a given index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

index - Index within the list

Returns:

Double value of this attribute

Throws:

ServerException, - UserException

ServerException

UserException

getDoubleAttributes

List<Double> getDoubleAttributes(Long tid,
                                 Long oid,
                                 String attributeName)
                          throws ServerException,
                                 UserException

Get a list of double values

Parameters:

tid - The TransactionID

oid - ObjectID of the object

attributeName - Name of the attribute

Returns:

A list of double values

Throws:

ServerException, - UserException

ServerException

UserException

setEnumAttribute

void setEnumAttribute(Long tid,
                      Long oid,
                      String attributeName,
                      String value)
               throws ServerException,
                      UserException

Set an enum attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New Enum value (name of the enum item)

Throws:

ServerException, - UserException

ServerException

UserException

getEnumAttribute

String getEnumAttribute(Long tid,
                        Long oid,
                        String attributeName)
                 throws ServerException,
                        UserException

Get an enum attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

Enum value (as String)

Throws:

ServerException, - UserException

ServerException

UserException

setIntegerAttribute

void setIntegerAttribute(Long tid,
                         Long oid,
                         String attributeName,
                         Integer value)
                  throws ServerException,
                         UserException

Set an integer attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - new Integer value

Throws:

ServerException, - UserException

ServerException

UserException

setIntegerAttributeAtIndex

void setIntegerAttributeAtIndex(Long tid,
                                Long oid,
                                String attributeName,
                                Integer index,
                                Integer value)
                         throws ServerException,
                                UserException

Set an integer attribute at a given index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

index - Index within the list

value - new Integer value

Throws:

ServerException, - UserException

ServerException

UserException

setWrappedIntegerAttribute

void setWrappedIntegerAttribute(Long tid,
                                Long oid,
                                String attributeName,
                                String type,
                                Integer value)
                         throws ServerException,
                                UserException

Set a warpped integer attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

type - Type of the wrapped object

value - new Integer value

Throws:

ServerException, - UserException

ServerException

UserException

setByteArrayAttribute

void setByteArrayAttribute(Long tid,
                           Long oid,
                           String attributeName,
                           Byte[] value)
                    throws UserException,
                           ServerException

Set a byte[] attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - new ByteArray value

Throws:

ServerException, - UserException

UserException

ServerException

setIntegerAttributes

void setIntegerAttributes(Long tid,
                          Long oid,
                          String attributeName,
                          List<Integer> values)
                   throws ServerException,
                          UserException

Set a list of integer attributes

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

values - A list of integer values

Throws:

ServerException, - UserException

ServerException

UserException

setLongAttribute

void setLongAttribute(Long tid,
                      Long oid,
                      String attributeName,
                      Long value)
               throws ServerException,
                      UserException

Set a long attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - new Integer value

Throws:

ServerException, - UserException

ServerException

UserException

setLongAttributeAtIndex

void setLongAttributeAtIndex(Long tid,
                             Long oid,
                             String attributeName,
                             Integer index,
                             Long value)
                      throws ServerException,
                             UserException

Set a long attribute at a given index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

index - Index within the list

value - new Integer value

Throws:

ServerException, - UserException

ServerException

UserException

setWrappedLongAttribute

void setWrappedLongAttribute(Long tid,
                             Long oid,
                             String attributeName,
                             String type,
                             Long value)
                      throws ServerException,
                             UserException

Set a wrapped long value

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

type - Type of the wrapped object

value - new Integer value

Throws:

ServerException, - UserException

ServerException

UserException

setLongAttributes

void setLongAttributes(Long tid,
                       Long oid,
                       String attributeName,
                       List<Long> values)
                throws ServerException,
                       UserException

Set a list of long attributes

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

values - List of long values

Throws:

ServerException, - UserException

ServerException

UserException

getIntegerAttribute

Integer getIntegerAttribute(Long tid,
                            Long oid,
                            String attributeName)
                     throws ServerException,
                            UserException

Get an integer attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

Integer value of attribute

Throws:

ServerException, - UserException

ServerException

UserException

getIntegerAttributeAtIndex

Integer getIntegerAttributeAtIndex(Long tid,
                                   Long oid,
                                   String attributeName,
                                   Integer index)
                            throws ServerException,
                                   UserException

Get an integer attribute at the given index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - new Integer value

Throws:

ServerException, - UserException

ServerException

UserException

getByteArrayAttribute

byte[] getByteArrayAttribute(Long tid,
                             Long oid,
                             String attributeName)
                      throws ServerException,
                             UserException

Get a byte[] attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

byte[] value

Throws:

ServerException, - UserException

ServerException

UserException

getByteArrayAttributes

List<byte[]> getByteArrayAttributes(Long tid,
                                    Long oid,
                                    String attributeName)
                             throws ServerException,
                                    UserException

Get a list of byte[] values

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

List of byte[] values

Throws:

ServerException, - UserException

ServerException

UserException

getIntegerAttributes

List<Integer> getIntegerAttributes(Long tid,
                                   Long oid,
                                   String attributeName)
                            throws ServerException,
                                   UserException

Get a list of integer attributes

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

List of integer attributes

Throws:

ServerException, - UserException

ServerException

UserException

getLongAttribute

Long getLongAttribute(Long tid,
                      Long oid,
                      String attributeName)
               throws ServerException,
                      UserException

Get a long value of an attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

Long value of attribute

Throws:

ServerException, - UserException

ServerException

UserException

getLongAttributeAtIndex

Long getLongAttributeAtIndex(Long tid,
                             Long oid,
                             String attributeName,
                             Integer index)
                      throws ServerException,
                             UserException

Get a long attribute at a given index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

Long value at index

Throws:

ServerException, - UserException

ServerException

UserException

setBooleanAttribute

void setBooleanAttribute(Long tid,
                         Long oid,
                         String attributeName,
                         Boolean value)
                  throws ServerException,
                         UserException

Set a boolean attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

value - New Boolean value

Throws:

ServerException, - UserException

ServerException

UserException

setBooleanAttributeAtIndex

void setBooleanAttributeAtIndex(Long tid,
                                Long oid,
                                String attributeName,
                                Integer index,
                                Boolean value)
                         throws ServerException,
                                UserException

Set a boolean attribute at the given index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

index - Index within the list

value - New Boolean value

Throws:

ServerException, - UserException

ServerException

UserException

setWrappedBooleanAttribute

void setWrappedBooleanAttribute(Long tid,
                                Long oid,
                                String attributeName,
                                String type,
                                Boolean value)
                         throws ServerException,
                                UserException

Set a wrapped boolean attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

type - Type of the wrapped object

value - New Boolean value

Throws:

ServerException, - UserException

ServerException

UserException

setBooleanAttributes

void setBooleanAttributes(Long tid,
                          Long oid,
                          String attributeName,
                          List<Boolean> values)
                   throws ServerException,
                          UserException

Set a list of boolean attributes

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

values - A list of boolean values

Throws:

ServerException, - UserException

ServerException

UserException

getBooleanAttribute

Boolean getBooleanAttribute(Long tid,
                            Long oid,
                            String attributeName)
                     throws ServerException,
                            UserException

Get a boolean value of an attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object

attributeName - Name of the attribute

Returns:

Boolean value of attribute

Throws:

ServerException, - UserException

ServerException

UserException

getBooleanAttributeAtIndex

Boolean getBooleanAttributeAtIndex(Long tid,
                                   Long oid,
                                   String attributeName,
                                   Integer index)
                            throws ServerException,
                                   UserException

Retrieve a boolean attribute at the given index

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

index - Index of the attribute

Returns:

A Boolean value of the given index

Throws:

ServerException, - UserException

ServerException

UserException

getBooleanAttributes

List<Boolean> getBooleanAttributes(Long tid,
                                   Long oid,
                                   String attributeName)
                            throws ServerException,
                                   UserException

Retrieve a list of boolean attributes

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

A list of boolean values

Throws:

ServerException, - UserException

ServerException

UserException

setReference

void setReference(Long tid,
                  Long oid,
                  String referenceName,
                  Long referenceOid)
           throws ServerException,
                  UserException

Set a reference

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

referenceName - Name of the reference

referenceOid - ObjectID of the newly referred object

Throws:

ServerException, - UserException

ServerException

UserException

getReference

Long getReference(Long tid,
                  Long oid,
                  String referenceName)
           throws ServerException,
                  UserException

Get a reference

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

referenceName - Name of the reference

Returns:

ObjectID of the referred object

Throws:

ServerException, - UserException

ServerException

UserException

getReferences

List<Long> getReferences(Long tid,
                         Long oid,
                         String referenceName)
                  throws ServerException,
                         UserException

Get a list of references

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

referenceName - Name of the reference

Returns:

A list of ObjectID's

Throws:

ServerException, - UserException

ServerException

UserException

unsetAttribute

void unsetAttribute(Long tid,
                    Long oid,
                    String attributeName)
             throws ServerException,
                    UserException

Unset an attribute

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute to unset

Throws:

ServerException, - UserException

ServerException

UserException

unsetReference

void unsetReference(Long tid,
                    Long oid,
                    String referenceName)
             throws ServerException,
                    UserException

Unset a reference

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

referenceName - Name of the reference to unset (null)

Throws:

ServerException, - UserException

ServerException

UserException

addStringAttribute

void addStringAttribute(Long tid,
                        Long oid,
                        String attributeName,
                        String value)
                 throws ServerException,
                        UserException

Add a String attribute. Will be added at the end of the list

Parameters:

tid - The TransactionID

oid - ObjectID 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(Long tid,
                        Long oid,
                        String attributeName,
                        Double value)
                 throws ServerException,
                        UserException

Add a double attribute. Will be added at the end of the list

Parameters:

tid - The TransactionID

oid - ObjectID 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(Long tid,
                         Long oid,
                         String attributeName,
                         Integer value)
                  throws ServerException,
                         UserException

Add an integer attribute. Will be added at the end of the list

Parameters:

tid - The TransactionID

oid - ObjectID 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(Long tid,
                         Long oid,
                         String attributeName,
                         Boolean value)
                  throws ServerException,
                         UserException

Add a boolean attribute. Will be added at the end of the list

Parameters:

tid - The TransactionID

oid - ObjectID 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(Long tid,
                  Long oid,
                  String referenceName,
                  Long referenceOid)
           throws ServerException,
                  UserException

Add a reference to a list. Will be added at the end of the list

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

referenceName - Name of the reference to add a reference to

referenceOid - ObjectID of the referenced Object

Throws:

ServerException, - UserException

ServerException

UserException

removeAttribute

void removeAttribute(Long tid,
                     Long oid,
                     String attributeName,
                     Integer index)
              throws ServerException,
                     UserException

Remove an attribute from a list at a certain index

Parameters:

tid - The TransactionID

oid - ObjectID 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(Long tid,
                     Long oid,
                     String referenceName,
                     Integer index)
              throws ServerException,
                     UserException

Remove a single reference by it's index in the list

Parameters:

tid - The TransactionID

oid - ObjectID 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

removeReferenceByOid

void removeReferenceByOid(Long tid,
                          Long oid,
                          String referenceName,
                          Long referencedOid)
                   throws ServerException,
                          UserException

Remove a single reference by it's oid

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

referenceName - Name of the reference from which to remove an item

referencedOid - Index of the item to remove

Throws:

ServerException, - UserException

ServerException

UserException

removeAllReferences

void removeAllReferences(Long tid,
                         Long oid,
                         String referenceName)
                  throws ServerException,
                         UserException

Remove all references (clear the list of references) of the given object + reference

Parameters:

tid - The TransactionID

oid - ObjectID of the object

referenceName - Name of the reference from which to remove all references

Throws:

ServerException, - UserException

ServerException

UserException

getDataObjectByOid

@Deprecated
SDataObject getDataObjectByOid(Long roid,
                                           Long oid)
                                    throws ServerException,
                                           UserException

Deprecated.

Get an object from the given revision as a Data Object

Parameters:

roid - ObjectID of the Revision

oid - ObjectID of the object to get

Returns:

An SDataObject

Throws:

ServerException, - UserException

ServerException

UserException

getDataObjectByGuid

@Deprecated
SDataObject getDataObjectByGuid(Long roid,
                                            String guid)
                                     throws ServerException,
                                            UserException

Deprecated.

Get all the objects matching the given GUIDs as Data Objects

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

@Deprecated
List<SDataObject> getDataObjectsByType(Long roid,
                                                   String packageName,
                                                   String className,
                                                   Boolean flat)
                                            throws ServerException,
                                                   UserException

Deprecated.

Get all the objects of a certain type in Data Objects

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

@Deprecated
List<SDataObject> getDataObjects(Long roid)
                                      throws ServerException,
                                             UserException

Deprecated.

Get all the objects of a certain revision in Data Objects

Parameters:

roid - ObjectID of the Revision

Returns:

A list of DataObjects from the given Revision

Throws:

ServerException, - UserException

ServerException

UserException

count

Integer count(Long roid,
              String className)
       throws UserException,
              ServerException

Count the amount of object a certain revision has of the given type

Parameters:

roid - ObjectID of the Revision

className - Name of the type to query

Returns:

The amount of objects found

Throws:

UserException, - ServerException

UserException

ServerException