LowLevelInterfaceAdaptor (PluginBase 1.5.107 API)

java.lang.Object
- org.bimserver.shared.interfaces.LowLevelInterfaceAdaptor

All Implemented Interfaces:: LowLevelInterface, PublicInterface

public class LowLevelInterfaceAdaptor
extends Object
implements LowLevelInterface

Constructor Summary

Constructors
Constructor and Description

LowLevelInterfaceAdaptor()

Constructors
Constructor and Description
`LowLevelInterfaceAdaptor()`

Method Summary

All Methods Instance Methods Concrete Methods
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)` Get all the objects matching the given GUIDs as Data Objects
`SDataObject`	`getDataObjectByOid(Long roid, Long oid)` Get an object from the given revision as a Data Object
`List<SDataObject>`	`getDataObjects(Long roid)` Get all the objects of a certain revision in Data Objects
`List<SDataObject>`	`getDataObjectsByType(Long roid, String packageName, String className, Boolean flat)` Get all the objects of a certain type in Data Objects
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- LowLevelInterfaceAdaptor
```
public LowLevelInterfaceAdaptor()
```

Method Detail

abortTransaction
```
public void abortTransaction(Long tid)
                      throws UserException,
                             ServerException
```
Description copied from interface: LowLevelInterface

Abort a transaction, changes will not be saved

Specified by:

abortTransaction in interface LowLevelInterface

Parameters:

tid - The TransactionID

Throws:

UserException

ServerException

addBooleanAttribute

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

Description copied from interface: LowLevelInterface

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

Specified by:: addBooleanAttribute in interface LowLevelInterface
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:: UserException; ServerException

addDoubleAttribute

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

Description copied from interface: LowLevelInterface

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

Specified by:: addDoubleAttribute in interface LowLevelInterface
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:: UserException; ServerException

addIntegerAttribute

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

Description copied from interface: LowLevelInterface

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

Specified by:: addIntegerAttribute in interface LowLevelInterface
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:: UserException; ServerException

addReference
```
public void addReference(Long tid,
                         Long oid,
                         String referenceName,
                         Long referenceOid)
                  throws UserException,
                         ServerException
```
Description copied from interface: LowLevelInterface

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

Specified by:

addReference in interface LowLevelInterface

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:

UserException

ServerException

addStringAttribute

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

Description copied from interface: LowLevelInterface

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

Specified by:: addStringAttribute in interface LowLevelInterface
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:: UserException; ServerException

commitTransaction
```
public Long commitTransaction(Long tid,
                              String comment)
                       throws UserException,
                              ServerException
```
Description copied from interface: LowLevelInterface

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

Specified by:

commitTransaction in interface LowLevelInterface

Parameters:

tid - The TransactionID

comment - Comment describing what has changed

Returns:

ObjectID of the newly created Revision

Throws:

UserException

ServerException

count
```
public Integer count(Long roid,
                     String className)
              throws UserException,
                     ServerException
```
Description copied from interface: LowLevelInterface

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

Specified by:

count in interface LowLevelInterface

Parameters:

roid - ObjectID of the Revision

className - Name of the type to query

Returns:

The amount of objects found

Throws:

UserException

ServerException

createObject

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

Description copied from interface: LowLevelInterface

Create a new Object

Specified by:: createObject in interface LowLevelInterface
Parameters:: tid - The TransactionID; className - The type of the new object
Returns:: The ObjectID of the newly created object
Throws:: UserException; ServerException

getBooleanAttribute

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

Description copied from interface: LowLevelInterface

Get a boolean value of an attribute

Specified by:: getBooleanAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object; attributeName - Name of the attribute
Returns:: Boolean value of attribute
Throws:: UserException; ServerException

getBooleanAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Retrieve a boolean attribute at the given index

Specified by:: getBooleanAttributeAtIndex in interface LowLevelInterface
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:: UserException; ServerException

getBooleanAttributes

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

Description copied from interface: LowLevelInterface

Retrieve a list of boolean attributes

Specified by:: getBooleanAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: A list of boolean values
Throws:: UserException; ServerException

getByteArrayAttribute

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

Description copied from interface: LowLevelInterface

Get a byte[] attribute

Specified by:: getByteArrayAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: byte[] value
Throws:: UserException; ServerException

getByteArrayAttributes

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

Description copied from interface: LowLevelInterface

Get a list of byte[] values

Specified by:: getByteArrayAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: List of byte[] values
Throws:: UserException; ServerException

getDataObjectByGuid
```
public SDataObject getDataObjectByGuid(Long roid,
                                       String guid)
                                throws UserException,
                                       ServerException
```
Description copied from interface: LowLevelInterface

Get all the objects matching the given GUIDs as Data Objects

Specified by:

getDataObjectByGuid in interface LowLevelInterface

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:

UserException

ServerException

getDataObjectByOid
```
public SDataObject getDataObjectByOid(Long roid,
                                      Long oid)
                               throws UserException,
                                      ServerException
```
Description copied from interface: LowLevelInterface

Get an object from the given revision as a Data Object

Specified by:

getDataObjectByOid in interface LowLevelInterface

Parameters:

roid - ObjectID of the Revision

oid - ObjectID of the object to get

Returns:

An SDataObject

Throws:

UserException

ServerException

getDataObjects
```
public List<SDataObject> getDataObjects(Long roid)
                                 throws UserException,
                                        ServerException
```
Description copied from interface: LowLevelInterface

Get all the objects of a certain revision in Data Objects

Specified by:

getDataObjects in interface LowLevelInterface

Parameters:

roid - ObjectID of the Revision

Returns:

A list of DataObjects from the given Revision

Throws:

UserException

ServerException

getDataObjectsByType

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

Description copied from interface: LowLevelInterface

Get all the objects of a certain type in Data Objects

Specified by:: getDataObjectsByType in interface LowLevelInterface
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:: UserException; ServerException

getDoubleAttribute
```
public Double getDoubleAttribute(Long tid,
                                 Long oid,
                                 String attributeName)
                          throws UserException,
                                 ServerException
```
Description copied from interface: LowLevelInterface

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

Specified by:

getDoubleAttribute in interface LowLevelInterface

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

List of double values

Throws:

UserException

ServerException

getDoubleAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Get a double value of an attribute at a given index

Specified by:: getDoubleAttributeAtIndex in interface LowLevelInterface
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:: UserException; ServerException

getDoubleAttributes

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

Description copied from interface: LowLevelInterface

Get a list of double values

Specified by:: getDoubleAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object; attributeName - Name of the attribute
Returns:: A list of double values
Throws:: UserException; ServerException

getEnumAttribute

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

Description copied from interface: LowLevelInterface

Get an enum attribute

Specified by:: getEnumAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: Enum value (as String)
Throws:: UserException; ServerException

getIntegerAttribute

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

Description copied from interface: LowLevelInterface

Get an integer attribute

Specified by:: getIntegerAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: Integer value of attribute
Throws:: UserException; ServerException

getIntegerAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Get an integer attribute at the given index

Specified by:: getIntegerAttributeAtIndex in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Throws:: UserException; ServerException

getIntegerAttributes

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

Description copied from interface: LowLevelInterface

Get a list of integer attributes

Specified by:: getIntegerAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: List of integer attributes
Throws:: UserException; ServerException

getLongAttribute
```
public Long getLongAttribute(Long tid,
                             Long oid,
                             String attributeName)
                      throws UserException,
                             ServerException
```
Description copied from interface: LowLevelInterface

Get a long value of an attribute

Specified by:

getLongAttribute in interface LowLevelInterface

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

attributeName - Name of the attribute

Returns:

Long value of attribute

Throws:

UserException

ServerException

getLongAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Get a long attribute at a given index

Specified by:: getLongAttributeAtIndex in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: Long value at index
Throws:: UserException; ServerException

getReference
```
public Long getReference(Long tid,
                         Long oid,
                         String referenceName)
                  throws UserException,
                         ServerException
```
Description copied from interface: LowLevelInterface

Get a reference

Specified by:

getReference in interface LowLevelInterface

Parameters:

tid - The TransactionID

oid - ObjectID of the object to change

referenceName - Name of the reference

Returns:

ObjectID of the referred object

Throws:

UserException

ServerException

getReferences

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

Description copied from interface: LowLevelInterface

Get a list of references

Specified by:: getReferences in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; referenceName - Name of the reference
Returns:: A list of ObjectID's
Throws:: UserException; ServerException

getStringAttribute

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

Description copied from interface: LowLevelInterface

Get the String value of an attribute

Specified by:: getStringAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: The String value
Throws:: UserException; ServerException

getStringAttributes

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

Description copied from interface: LowLevelInterface

Get a list of attributes of type String

Specified by:: getStringAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute
Returns:: A list of Strings
Throws:: UserException; ServerException

removeAllReferences
```
public void removeAllReferences(Long tid,
                                Long oid,
                                String referenceName)
                         throws UserException,
                                ServerException
```
Description copied from interface: LowLevelInterface

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

Specified by:

removeAllReferences in interface LowLevelInterface

Parameters:

tid - The TransactionID

oid - ObjectID of the object

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

Throws:

UserException

ServerException

removeAttribute

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

Description copied from interface: LowLevelInterface

Remove an attribute from a list at a certain index

Specified by:: removeAttribute in interface LowLevelInterface
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:: UserException; ServerException

removeObject
```
public void removeObject(Long tid,
                         Long oid)
                  throws UserException,
                         ServerException
```
Description copied from interface: LowLevelInterface

Remove an object

Specified by:

removeObject in interface LowLevelInterface

Parameters:

tid - The TransactionID

oid - ObjectID of the object to remove

Throws:

UserException

ServerException

removeReference

public void removeReference(Long tid,
                            Long oid,
                            String referenceName,
                            Integer index)
                     throws UserException,
                            ServerException

Description copied from interface: LowLevelInterface

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

Specified by:: removeReference in interface LowLevelInterface
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:: UserException; ServerException

removeReferenceByOid

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

Description copied from interface: LowLevelInterface

Remove a single reference by it's oid

Specified by:: removeReferenceByOid in interface LowLevelInterface
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:: UserException; ServerException

setBooleanAttribute

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

Description copied from interface: LowLevelInterface

Set a boolean attribute

Specified by:: setBooleanAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - New Boolean value
Throws:: UserException; ServerException

setBooleanAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Set a boolean attribute at the given index

Specified by:: setBooleanAttributeAtIndex in interface LowLevelInterface
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:: UserException; ServerException

setBooleanAttributes

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

Description copied from interface: LowLevelInterface

Set a list of boolean attributes

Specified by:: setBooleanAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; values - A list of boolean values
Throws:: UserException; ServerException

setByteArrayAttribute

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

Description copied from interface: LowLevelInterface

Set a byte[] attribute

Specified by:: setByteArrayAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - new ByteArray value
Throws:: UserException; ServerException

setDoubleAttribute

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

Description copied from interface: LowLevelInterface

Set a double attribute

Specified by:: setDoubleAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - New Double value
Throws:: UserException; ServerException

setDoubleAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Set a double attribute at a specific index

Specified by:: setDoubleAttributeAtIndex in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - New Double value
Throws:: UserException; ServerException

setDoubleAttributes

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

Description copied from interface: LowLevelInterface

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

Specified by:: setDoubleAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; values - List of double values
Throws:: UserException; ServerException

setEnumAttribute

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

Description copied from interface: LowLevelInterface

Set an enum attribute

Specified by:: setEnumAttribute in interface LowLevelInterface
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:: UserException; ServerException

setIntegerAttribute

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

Description copied from interface: LowLevelInterface

Set an integer attribute

Specified by:: setIntegerAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - new Integer value
Throws:: UserException; ServerException

setIntegerAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Set an integer attribute at a given index

Specified by:: setIntegerAttributeAtIndex in interface LowLevelInterface
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:: UserException; ServerException

setIntegerAttributes

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

Description copied from interface: LowLevelInterface

Set a list of integer attributes

Specified by:: setIntegerAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; values - A list of integer values
Throws:: UserException; ServerException

setLongAttribute

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

Description copied from interface: LowLevelInterface

Set a long attribute

Specified by:: setLongAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - new Integer value
Throws:: UserException; ServerException

setLongAttributeAtIndex

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

Description copied from interface: LowLevelInterface

Set a long attribute at a given index

Specified by:: setLongAttributeAtIndex in interface LowLevelInterface
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:: UserException; ServerException

setLongAttributes

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

Description copied from interface: LowLevelInterface

Set a list of long attributes

Specified by:: setLongAttributes in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; values - List of long values
Throws:: UserException; ServerException

setReference

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

Description copied from interface: LowLevelInterface

Set a reference

Specified by:: setReference in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; referenceName - Name of the reference; referenceOid - ObjectID of the newly referred object
Throws:: UserException; ServerException

setStringAttribute

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

Description copied from interface: LowLevelInterface

Set the String value of an attribute

Specified by:: setStringAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - New String value
Throws:: UserException; ServerException

setStringAttributeAtIndex

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

Description copied from interface: LowLevelInterface

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

Specified by:: setStringAttributeAtIndex in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - New String value
Throws:: UserException; ServerException

setWrappedBooleanAttribute

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

Description copied from interface: LowLevelInterface

Set a wrapped boolean attribute

Specified by:: setWrappedBooleanAttribute in interface LowLevelInterface
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:: UserException; ServerException

setWrappedDoubleAttribute

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

Description copied from interface: LowLevelInterface

Set a wrapped attribute's double value

Specified by:: setWrappedDoubleAttribute in interface LowLevelInterface
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:: UserException; ServerException

setWrappedIntegerAttribute

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

Description copied from interface: LowLevelInterface

Set a warpped integer attribute

Specified by:: setWrappedIntegerAttribute in interface LowLevelInterface
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:: UserException; ServerException

setWrappedLongAttribute

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

Description copied from interface: LowLevelInterface

Set a wrapped long value

Specified by:: setWrappedLongAttribute in interface LowLevelInterface
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:: UserException; ServerException

setWrappedStringAttribute

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

Description copied from interface: LowLevelInterface

Set the wrapped value of a String attribute

Specified by:: setWrappedStringAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute; value - New String value
Throws:: UserException; ServerException

startTransaction
```
public Long startTransaction(Long poid)
                      throws UserException,
                             ServerException
```
Description copied from interface: LowLevelInterface

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

Specified by:

startTransaction in interface LowLevelInterface

Parameters:

poid - ObjectID of the Project to start a transaction on

Returns:

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

Throws:

UserException

ServerException

unsetAttribute

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

Description copied from interface: LowLevelInterface

Unset an attribute

Specified by:: unsetAttribute in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; attributeName - Name of the attribute to unset
Throws:: UserException; ServerException

unsetReference

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

Description copied from interface: LowLevelInterface

Unset a reference

Specified by:: unsetReference in interface LowLevelInterface
Parameters:: tid - The TransactionID; oid - ObjectID of the object to change; referenceName - Name of the reference to unset (null)
Throws:: UserException; ServerException

Class LowLevelInterfaceAdaptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LowLevelInterfaceAdaptor

Method Detail

abortTransaction

addBooleanAttribute

addDoubleAttribute

addIntegerAttribute

addReference

addStringAttribute

commitTransaction

count

createObject

getBooleanAttribute

getBooleanAttributeAtIndex

getBooleanAttributes

getByteArrayAttribute

getByteArrayAttributes

getDataObjectByGuid

getDataObjectByOid

getDataObjects

getDataObjectsByType

getDoubleAttribute

getDoubleAttributeAtIndex

getDoubleAttributes

getEnumAttribute

getIntegerAttribute

getIntegerAttributeAtIndex

getIntegerAttributes

getLongAttribute

getLongAttributeAtIndex

getReference

getReferences

getStringAttribute

getStringAttributes

removeAllReferences

removeAttribute

removeObject

removeReference

removeReferenceByOid

setBooleanAttribute

setBooleanAttributeAtIndex

setBooleanAttributes

setByteArrayAttribute

setDoubleAttribute

setDoubleAttributeAtIndex

setDoubleAttributes

setEnumAttribute

setIntegerAttribute

setIntegerAttributeAtIndex

setIntegerAttributes

setLongAttribute

setLongAttributeAtIndex

setLongAttributes

setReference

setStringAttribute

setStringAttributeAtIndex

setWrappedBooleanAttribute

setWrappedDoubleAttribute

setWrappedIntegerAttribute

setWrappedLongAttribute

setWrappedStringAttribute

startTransaction

unsetAttribute

unsetReference