org.asam.ods

Interface InstanceElementOperations

All Known Subinterfaces:

InstanceElement, Measurement, MeasurementOperations, ODSFile, ODSFileOperations, SubMatrix, SubMatrixOperations

All Known Implementing Classes:

_InstanceElementStub, _MeasurementStub, _ODSFileStub, _SubMatrixStub, InstanceElement, InstanceElement, InstanceElementPOA, Measurement, Measurement, MeasurementPOA, ODSFile, ODSFile, ODSFilePOA, SubMatrix, SubMatrix, SubMatrixPOA

public interface InstanceElementOperations

The ASAM ODS instance element interface. It is allowed to modify the instances outside a transaction but it is recommended to activate a transaction before the instances are modified. The modifications to instances get permanent when the transaction is committed.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInstanceAttribute(NameValueUnit instAttr) (14001) Add an instance attribute to the instance.
T_LONGLONG	compare(InstanceElement compIeObj) (14031) Compare two instance elements.
InstanceElement[]	createRelatedInstances(ApplicationRelation applRel, NameValueSeqUnit[] attributes, ApplicationRelationInstanceElementSeq[] relatedInstances) (14032) Create a list with new instances which are related to the actual instance element.
void	createRelation(ApplicationRelation relation, InstanceElement instElem) (14002) Create a relation between the current and the given instance.
InstanceElement	deepCopy(java.lang.String newName, java.lang.String newVersion) (14028) Provides an easy-to-use and effective copy mechanism for instance element hierarchies inside the server (e.g. copy a project with all tests or copy a test with all measurements).
void	destroy() (14030) Destroy the object on the server.
ApplicationElement	getApplicationElement() (14003) Get the application element of the instance element.
java.lang.String	getAsamPath() (14004) Get the ASAM-Path of the instance element.
T_LONGLONG	getId() (14005) Get the Id of the instance element.
InitialRight[]	getInitialRights() (14025) Retrieve access control list information for the initial rights of the given object.
java.lang.String	getName() (14006) Get the name of the instance element.
InstanceElementIterator	getRelatedInstances(ApplicationRelation applRel, java.lang.String iePattern) (14007) Get the related instances.
InstanceElementIterator	getRelatedInstancesByRelationship(Relationship ieRelationship, java.lang.String iePattern) (14008) Get the list of related instances.
ACL[]	getRights() (14024) Retrieve access control list information of the given object.
NameValueUnit	getValue(java.lang.String attrName) (14009) Get the name-value-unit tuple of the given attribute of the instance element.
NameValueUnit	getValueByBaseName(java.lang.String baseAttrName) (14010) Get the attribute's name-value-unit tuple of the attribute inherited from the given base attribute of the instance element.
NameValueUnit	getValueInUnit(NameUnit attr) (14021) Get the attribute value (name, value and unit) of the given attribute of the instance element.
NameValueUnit[]	getValueSeq(java.lang.String[] attrNames) (14029) Get the sequence of the values of the application or instance attributes, specified by their names.
java.lang.String[]	listAttributes(java.lang.String iaPattern, AttrType aType) (14011) Get the attribute names from the instance element.
NameIterator	listRelatedInstances(ApplicationRelation ieRelation, java.lang.String iePattern) (14012) Get the names of the related instances.
NameIterator	listRelatedInstancesByRelationship(Relationship ieRelationship, java.lang.String iePattern) (14013) Get the names of the related instances.
void	removeInstanceAttribute(java.lang.String attrName) (14014) Remove an instance attribute.
void	removeRelation(ApplicationRelation applRel, InstanceElement instElem_nm) (14015) Remove the relation between the current instance and the given instance.
void	renameInstanceAttribute(java.lang.String oldName, java.lang.String newName) (14016) Rename the instance attribute.
void	setInitialRights(InstanceElement usergroup, int rights, T_LONGLONG refAid, RightsSet set) (14026) The given user group the initial rights should be set for.
void	setName(java.lang.String iaName) (14017) Set the name of an instance element.
void	setRights(InstanceElement usergroup, int rights, RightsSet set) (14023) The given user group the rights should be set for.
void	setValue(NameValueUnit value) (14018) Set the value of an application attribute or of an existing instance attribute.
void	setValueSeq(NameValueUnit[] values) (14022) Set a sequence of values of application attributes but no instances attributes.
InstanceElement	shallowCopy(java.lang.String newName, java.lang.String newVersion) (14027) Provides an easy-to-use and effective copy mechanism for instance elements inside the server.
Measurement	upcastMeasurement() (14019) Cast an instance element to a measurement.
ODSFile	upcastODSFile() (14033) Upcast the InstanceElement object to the corresponding ODSFile interface for an instance.
SubMatrix	upcastSubMatrix() (14020) Cast an instance element to a submatrix.

Method Detail

addInstanceAttribute

void addInstanceAttribute(NameValueUnit instAttr)
                          throws AoException

(14001) Add an instance attribute to the instance. The instance attribute is built as a Name/Value/Unit tuple on the client. This method has to copy the data from the client to the server. The name of the attribute must be unique. It is allowed to add an instance attribute outside a transaction but it is recommended to activate a transaction. Note: As the current specification of the physical storage restricts the length of instance attribute names to maximum of 30 characters, clients must take care not to exceed this limt.

Parameters:

instAttr - The instance attribute to be added.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

createRelation

void createRelation(ApplicationRelation relation,
                  InstanceElement instElem)
                    throws AoException

(14002) Create a relation between the current and the given instance. Check if the application elements of the relation matches the application elements of the instances. It is allowed to modify the instance element outside a transaction but it is recommended to activate a transaction.

Parameters:

relation - The application relation.

instElem - The instance element.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATION AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getApplicationElement

ApplicationElement getApplicationElement()
                                         throws AoException

(14003) Get the application element of the instance element.

Returns:

The application element from which the instance element is derived.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getAsamPath

java.lang.String getAsamPath()
                             throws AoException

(14004) Get the ASAM-Path of the instance element.

Returns:

The ASAM path to the instance element.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getId

T_LONGLONG getId()
                 throws AoException

(14005) Get the Id of the instance element.

Returns:

The Id of the instance element.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getName

java.lang.String getName()
                         throws AoException

(14006) Get the name of the instance element.

Returns:

The name of the instance element.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getRelatedInstances

InstanceElementIterator getRelatedInstances(ApplicationRelation applRel,
                                          java.lang.String iePattern)
                                            throws AoException

(14007) Get the related instances. The application relation and the search name pattern of the related instances specify the instances to retrieve. The name pattern is case sensitive and may contain wildcard characters.

Parameters:

applRel - The application relation.

iePattern - The name or the search pattern for the related instance names.

Returns:

The related instances.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATION AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getRelatedInstancesByRelationship

InstanceElementIterator getRelatedInstancesByRelationship(Relationship ieRelationship,
                                                        java.lang.String iePattern)
                                                          throws AoException

(14008) Get the list of related instances. The relationship and the name pattern of the related instances specify the instances to retrieve. The name pattern is case sensitive and may contain wildcard characters.

Parameters:

ieRelationship - The requested relationship.

iePattern - The name or the search pattern for the related instance names.

Returns:

The related instances.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATIONSHIP AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getValue

NameValueUnit getValue(java.lang.String attrName)
                       throws AoException

(14009) Get the name-value-unit tuple of the given attribute of the instance element. This method will not return the value of relation attributes; use the method getRelatedInstances() for this case.

Parameters:

attrName - The name of the requested attribute.

Returns:

The name-value-unit tuple of the attribute.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getValueByBaseName

NameValueUnit getValueByBaseName(java.lang.String baseAttrName)
                                 throws AoException

(14010) Get the attribute's name-value-unit tuple of the attribute inherited from the given base attribute of the instance element. The base name is case insensitive and may not contain wildcard characters.

Parameters:

baseAttrName - The base name of the requested attribute.

Returns:

The attribute name-value-unit tuple.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

listAttributes

java.lang.String[] listAttributes(java.lang.String iaPattern,
                                AttrType aType)
                                  throws AoException

(14011) Get the attribute names from the instance element. The attribute name pattern is case sensitive and may contain wildcard characters. It can be distinguished between application and instance attributes. The attributes reserved for a relation are not listed.

Parameters:

iaPattern - The name or the search pattern for the attribute names.

aType - The requested attribute type.

Returns:

The names of the attributes.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_ATTRIBUTE_TYPE AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

listRelatedInstances

NameIterator listRelatedInstances(ApplicationRelation ieRelation,
                                java.lang.String iePattern)
                                  throws AoException

(14012) Get the names of the related instances. The application relation and the name of the related instances specifies the listed names. The pattern is case sensitive and may contain wildcard characters.

Parameters:

ieRelation - The application relation.

iePattern - The name or the search pattern for the related instance names.

Returns:

The names of the related instances.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

listRelatedInstancesByRelationship

NameIterator listRelatedInstancesByRelationship(Relationship ieRelationship,
                                              java.lang.String iePattern)
                                                throws AoException

(14013) Get the names of the related instances. The relationship and the name of the related instances specify the listed names. The pattern is case sensitive and may contain wildcard characters.

Parameters:

ieRelationship - The requested relationship.

iePattern - The name or the search pattern for the related instance names.

Returns:

The names of the related instances.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATIONSHIP AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

removeInstanceAttribute

void removeInstanceAttribute(java.lang.String attrName)
                             throws AoException

(14014) Remove an instance attribute. It is allowed to remove the instance attribute outside a transaction but it is recommended to activate a transaction. The application attributes can't be removed.

Parameters:

attrName - The name of the attribute to be removed.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_FOUND AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

removeRelation

void removeRelation(ApplicationRelation applRel,
                  InstanceElement instElem_nm)
                    throws AoException

(14015) Remove the relation between the current instance and the given instance. It is necessary to specify the instance element in case of n:m relations if not all relations shall be deleted. It is allowed to modify the instance element outside a transaction but it is recommended to activate a transaction.

Parameters:

applRel - The relation to be removed.

instElem_nm - The instance element for specific delete from n:m relations.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATION AO_NOT_FOUND AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

renameInstanceAttribute

void renameInstanceAttribute(java.lang.String oldName,
                           java.lang.String newName)
                             throws AoException

(14016) Rename the instance attribute. The application attributes can't be renamed. It is allowed to rename the instance attribute outside a transaction but it is recommended to activate a transaction.

Parameters:

oldName - The old instance attribute name.

newName - The new instance attribute name.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_DUPLICATE_NAME AO_IMPLEMENTATION_PROBLEM AO_NOT_FOUND AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setName

void setName(java.lang.String iaName)
             throws AoException

(14017) Set the name of an instance element. It is allowed to modify the name of the instance element outside a transaction but it is recommended to activate a transaction.

Parameters:

iaName - The instance attribute name.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setValue

void setValue(NameValueUnit value)
              throws AoException

(14018) Set the value of an application attribute or of an existing instance attribute. This method will not create a new instance attribute; for this purpose use the method addInstanceAttribute() of this interface. It is allowed to modify the attribute value outside a transaction but it is recommended to activate a transaction. The name of the attribute is specified by the name of the NameValueUnit tuple. If the application attribute flag unique is set, the uniqueness of the new value is checked. This method can not be used to set the value of a relation attribute, use the method createRelation of this interface .

Parameters:

value - The value to be set in the instance element.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_DUPLICATE_VALUE AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

upcastMeasurement

Measurement upcastMeasurement()
                              throws AoException

(14019) Cast an instance element to a measurement. There are some object-oriented languages which do not allow this cast.

Returns:

The instance of type measurement.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_INVALID_BASETYPE

upcastSubMatrix

SubMatrix upcastSubMatrix()
                          throws AoException

(14020) Cast an instance element to a submatrix. There are some object-oriented languages which do not allow this cast.

Returns:

The instance of type submatrix.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_INVALID_BASETYPE

getValueInUnit

NameValueUnit getValueInUnit(NameUnit attr)
                             throws AoException

(14021) Get the attribute value (name, value and unit) of the given attribute of the instance element.

Parameters:

attr - The name of the requested attribute and the unit of the attribute value.

Returns:

The attribute value, value converted to the requested unit.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_INCOMPATIBLE_UNITS AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setValueSeq

void setValueSeq(NameValueUnit[] values)
                 throws AoException

(14022) Set a sequence of values of application attributes but no instances attributes. It is allowed to modify the values of the attributes outside a transaction but it is recommended to activate a transaction. The name of the attribute is specified by the name of the NameValueUnit tuple. If the application attribute flag unique is set, the uniqueness of the new value is checked. Note: As the current specification of the physical storage restricts the length of names of instance attributes to a maximum of 30 characters, clients must take care to not exceed this limit if they instance attributes (those that arte not given by the application model) with this method call.

Parameters:

values - The sequence of the values to be set at the instance element.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_DUPLICATE_VALUE AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

setRights

void setRights(InstanceElement usergroup,
             int rights,
             RightsSet set)
               throws AoException

(14023) The given user group the rights should be set for. defines the rights to set or to clear. If the parameter is set to 'set', the rights in are set, all others are cleared. If the parameter is set to 'add', the rights in are added to the existing rights. If the parameter is set to 'remove', the rights in are removed from the existing rights.

Parameters:

usergroup - The user group for which the rights will be modified.

rights - The new right for the user group. The rights constants are defined in the interface SecurityRights. The interface definition language IDL does not allow to set the values of enumerations thus the constant definitions had to be done in an interface.

set - What to do with the new right.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getRights

ACL[] getRights()
                throws AoException

(14024) Retrieve access control list information of the given object.

Returns:

The access control list entries of the given instance element.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getInitialRights

InitialRight[] getInitialRights()
                                throws AoException

(14025) Retrieve access control list information for the initial rights of the given object.

Returns:

The access control list entries with the initial rights of the given instance element.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setInitialRights

void setInitialRights(InstanceElement usergroup,
                    int rights,
                    T_LONGLONG refAid,
                    RightsSet set)
                      throws AoException

(14026) The given user group the initial rights should be set for. defines the rights to set or to clear. If the parameter is set to 'set', the rights in are set all others are cleared. If the parameter is set to 'add', the rights in are added to the existing rights. If the parameter is set to 'remove', the rights in are removed from the existing rights.

Parameters:

usergroup - The user group for which the initial rights will be modified.

rights - The new initial rights for the user group. The rights constants are defined in the interface SecurityRights. The interface definition language IDL does not allow to set the values of enumerations thus the constant definitions have to be done in the interface.

refAid - The Id of referencing application element for which the initial rights will be used. If no refAid is set the initial rights will be used for each new instance element independent of the application element.

set - What to do with the new initial rights.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

shallowCopy

InstanceElement shallowCopy(java.lang.String newName,
                          java.lang.String newVersion)
                            throws AoException

(14027) Provides an easy-to-use and effective copy mechanism for instance elements inside the server. The new instance elements gets a copy of all attribute values and informational relations that are available in the original instance element. The new instance element has the same parent as the original instance element but it does not have references to any children of the original instance element.

Parameters:

newName - The name of the new instance element. If a new version shall be created this parameter may be NULL to use the same name for the copy. In this case a new version must be provided.

newVersion - The version of the new instance element. This parameter may be NULL if a new name is provided.

Returns:

The reference to the copied instance element.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

deepCopy

InstanceElement deepCopy(java.lang.String newName,
                       java.lang.String newVersion)
                         throws AoException

(14028) Provides an easy-to-use and effective copy mechanism for instance element hierarchies inside the server (e.g. copy a project with all tests or copy a test with all measurements). The deep copy follows only the child references but not the informational references. Example: Copying elements of type AoMeasurement does not include copying the referenced elements of type AoMeasurementQuantity. The copied instance elements of type AoMeasurement will reference the same measurement quantities as the original. An application that wants to copy the measurement quantity also must do this (including setting the proper references) by itself e.g. with another call to shallowCopy; deepCopy is not necessary in this case because AoMeasurementQuantity has no children.

Parameters:

newName - The name of the new instance element. If a new version shall be created this parameter may be NULL to use the same name for the copy. In this case a new version must be provided.

newVersion - The version of the new instance element. This parameter may be NULL if a new name is provided.

Returns:

The reference to the copied instance element hierarchy.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getValueSeq

NameValueUnit[] getValueSeq(java.lang.String[] attrNames)
                            throws AoException

(14029) Get the sequence of the values of the application or instance attributes, specified by their names. The name sequence can use a pattern (*) for all attributes of the instance element. This means that application as well as instance attributes will be delivered.

Parameters:

attrNames - The names of the attributes to be reported.

Returns:

The sequence of the attribute values.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

destroy

void destroy()
             throws AoException

(14030) Destroy the object on the server. This method is used to tell the server that this object is not used anymore by the client. Access to this object after the destroy method will lead to an exception.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

compare

T_LONGLONG compare(InstanceElement compIeObj)
                   throws AoException

(14031) Compare two instance elements. The Id's of the application elements and the Id's of the instance elements are compared. The Id's of the application elements will be compare first.

Parameters:

compIeObj - The instance element to compare with.

Returns:

The difference of the Id's. Meaning: diff < 0 ElemId of instance is smaller then instance to compare with. diff == 0 ElemId is identical. diff > 0 ElemId of instance is greater then instance to compare with.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

createRelatedInstances

InstanceElement[] createRelatedInstances(ApplicationRelation applRel,
                                       NameValueSeqUnit[] attributes,
                                       ApplicationRelationInstanceElementSeq[] relatedInstances)
                                         throws AoException

(14032) Create a list with new instances which are related to the actual instance element. The attributes are given with the name of the sequence. The values of the attributes are given in the value sequence. The index in the different value sequences match for one instance element. The index in the instance element sequence of the related instances match for the instance with the same index in the value sequence.

Parameters:

applRel - The application relation for witch the related instances will be created.

attributes - The attributes of the new created instances.

relatedInstances - The list with related instances for different application relations.

Returns:

The list with the new created instances.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

upcastODSFile

ODSFile upcastODSFile()
                      throws AoException

(14033) Upcast the InstanceElement object to the corresponding ODSFile interface for an instance. This method may only be invoked for instances of an application element derived from the base element AoFile and returns an ODSFile interface. An exception with the error code AO_INVALID_BASETYPE is thrown when the instance is not an instance of an application element derived from the base element AoFile.

Returns:

The ODSFile interface to access the desired file.

Throws:

AoException - with the following possible error codes: AO_INVALID_BASETYPE AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE