org.asam.ods

Interface ApplicationElementOperations

All Known Subinterfaces:

ApplicationElement

All Known Implementing Classes:

_ApplicationElementStub, ApplicationElement, ApplicationElement, ApplicationElementPOA

public interface ApplicationElementOperations

The ASAM ODS application element interface.

Method Summary

Methods

Modifier and Type	Method and Description
ApplicationAttribute	createAttribute() (5001) Create a new application attribute on the server.
InstanceElement	createInstance(java.lang.String ieName) (5002) Create an instance of the application element.
InstanceElement[]	createInstances(NameValueSeqUnit[] attributes, ApplicationRelationInstanceElementSeq[] relatedInstances) (5033) Create a list with instances.
ApplicationElement[]	getAllRelatedElements() (5003) Get a list of all related application elements connected to this application element.
ApplicationRelation[]	getAllRelations() (5004) Get a list of all application relations connected to this application element.
ApplicationStructure	getApplicationStructure() (5032) Get the application model to which the application element belongs by returning an object with the interface ApplicationStructure.
ApplicationAttribute	getAttributeByBaseName(java.lang.String baName) (5005) Get the application attribute of an application element which is inherited from the base attribute with the given name.
ApplicationAttribute	getAttributeByName(java.lang.String aaName) (5006) Get the application attribute of an application element which has the given name.
ApplicationAttribute[]	getAttributes(java.lang.String aaPattern) (5007) Get a list of the application attributes of an application element.
BaseElement	getBaseElement() (5008) Get the base element of an application element.
T_LONGLONG	getId() (5009) Get the Id of an application element.
ApplicationRelation[]	getInitialRightRelations() (5029) Get all relations which are used to retrieve the instances to create the initial rights of the new created instance element.
InitialRight[]	getInitialRights() (5026) Retrieve access control list information for the initial rights of the given object.
InstanceElement	getInstanceById(T_LONGLONG ieId) (5010) Get the instance element specified by the given Id.
InstanceElement	getInstanceByName(java.lang.String ieName) (5011) Get the instance element specified by the given name.
InstanceElementIterator	getInstances(java.lang.String iePattern) (5012) Get the instances whose names match with the pattern.
java.lang.String	getName() (5013) Get the name of an application element.
ApplicationElement[]	getRelatedElementsByRelationship(Relationship aeRelationship) (5014) Get related application elements connected via the specified relationship.
ApplicationRelation[]	getRelationsByBaseName(java.lang.String baseRelName) (5034) Return the application relations derived from the base relation with the given relation name.
ApplicationRelation[]	getRelationsByType(RelationType aeRelationType) (5015) Get application relations of the requested type connected with this application element.
ACL[]	getRights() (5025) Retrieve access control list information of the given object.
int	getSecurityLevel() (5030) Get the security level of the application element.
java.lang.String[]	listAllRelatedElements() (5016) Get the names of all related application elements.
java.lang.String[]	listAttributes(java.lang.String aaPattern) (5017) Get the application attribute names of the application element.
NameIterator	listInstances(java.lang.String aaPattern) (5018) Get the names of the instances whose names match with the pattern.
java.lang.String[]	listRelatedElementsByRelationship(Relationship aeRelationship) (5019) Get the names of related application elements connected via the specified relationship.
void	removeAttribute(ApplicationAttribute applAttr) (5020) Remove an application attribute from an application element.
void	removeInstance(T_LONGLONG ieId, boolean recursive) (5021) Remove an instance from the application element.
void	setBaseElement(BaseElement baseElem) (5022) Set or modify the base element of the application element.
void	setInitialRightRelation(ApplicationRelation applRel, boolean set) (5028) Set for the given application element, which relation will be used to determine the initial rights for the new created instances.
void	setInitialRights(InstanceElement usergroup, int rights, T_LONGLONG refAid, RightsSet set) (5027) The given user group the initial rights should be set for.
void	setName(java.lang.String aeName) (5023) Set the name of the application element.
void	setRights(InstanceElement usergroup, int rights, RightsSet set) (5024) The given user group the rights should be set for.
void	setSecurityLevel(int secLevel, RightsSet set) (5031) Set the security level for the given application element.

Method Detail

createAttribute

ApplicationAttribute createAttribute()
                                     throws AoException

(5001) Create a new application attribute on the server. It is allowed to modify the application element outside a transaction but it is recommended to activate a transaction. The properties of the new application attribute may be changed via the set-methods of the ApplicationAttribute interface. For performance reasons it is recommended to set all required properties of an application attribute before it is committed the first time. This avoids database cross-checks for each attribute. The default properties of a new application attribute are: BaseAttribute NULL DataType DT_UNKNOWN IsObligatory 0 IsUnique 0 Length 0 Name "AUTOGEN" Unit NULL If there are already instances of the application element the values of the existing instances of the new attribute are set to undefined. The exception AO_DUPLICATE_NAME is thrown if there is already another application attribute with the name "AUTOGEN".

Returns:

The new application attribute.

Throws:

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

createInstance

InstanceElement createInstance(java.lang.String ieName)
                               throws AoException

(5002) Create an instance of the application element. It is allowed to create an instance outside a transaction but it is recommended to activate a transaction. The instance gets permanent when the transaction is committed. All attributes connected to the application element are automatically created and connected to the instance. The values of the attributes can be set by the method setValue of the interface InstanceElement.

Parameters:

ieName - The instance name.

Returns:

The new instance.

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

getAllRelatedElements

ApplicationElement[] getAllRelatedElements()
                                           throws AoException

(5003) Get a list of all related application elements connected to this application element.

Returns:

The list with the related application elements.

Throws:

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

getAllRelations

ApplicationRelation[] getAllRelations()
                                      throws AoException

(5004) Get a list of all application relations connected to this application element. The inverse relation of relations connected to other application elements pointing to the given application elements are not returned.

Returns:

The list with the application relations of the application 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

getAttributeByBaseName

ApplicationAttribute getAttributeByBaseName(java.lang.String baName)
                                            throws AoException

(5005) Get the application attribute of an application element which is inherited from the base attribute with the given name. The base name of the attribute is case insensitive (the base model itself is case insensitive; ID, Id, id are treated as the same items). The calling parameter may not contain wildcard characters. Note: The base model is case blind, e.g. Id, ID and id is all the same base attribute.

Parameters:

baName - The base attribute name.

Returns:

The application 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

getAttributeByName

ApplicationAttribute getAttributeByName(java.lang.String aaName)
                                        throws AoException

(5006) Get the application attribute of an application element which has the given name. The name is case sensitive and may not contain wildcard characters. Note: The application model is (in contrary to the base model) case sensitive, e.g. ID, Id and id are three different items. Note: In the application mnodel ID and Id are different application attributes. It is best not to use such misleading attribute names.

Parameters:

aaName - The application attribute name.

Returns:

The application 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

getAttributes

ApplicationAttribute[] getAttributes(java.lang.String aaPattern)
                                     throws AoException

(5007) Get a list of the application attributes of an application element. The reference attributes are not returned.

Parameters:

aaPattern - The name or the search pattern for the application attribute name.

Returns:

The application attributes.

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

getBaseElement

BaseElement getBaseElement()
                           throws AoException

(5008) Get the base element of an application element.

Returns:

The base 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

(5009) Get the Id of an application element.

Returns:

The Id of the application 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

getInstanceById

InstanceElement getInstanceById(T_LONGLONG ieId)
                                throws AoException

(5010) Get the instance element specified by the given Id. If the Id of the instance is not unique an exception is thrown.

Parameters:

ieId - The instance element Id.

Returns:

The 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

getInstanceByName

InstanceElement getInstanceByName(java.lang.String ieName)
                                  throws AoException

(5011) Get the instance element specified by the given name. If the instance name is not unique an exception is thrown. This is a convenience method for instance elements with unique names. If there are duplicate names for instances use the method getInstances instead and specify the requested name as pattern parameter.

Parameters:

ieName - The instance element name.

Returns:

The instance element.

Throws:

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

getInstances

InstanceElementIterator getInstances(java.lang.String iePattern)
                                     throws AoException

(5012) Get the instances whose names match with the pattern. The pattern is case sensitive and may contain wildcard characters.

Parameters:

iePattern - The name or the search pattern for the instance element name.

Returns:

The instance elements.

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

getName

java.lang.String getName()
                         throws AoException

(5013) Get the name of an application element.

Returns:

The name of the application 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

getRelatedElementsByRelationship

ApplicationElement[] getRelatedElementsByRelationship(Relationship aeRelationship)
                                                      throws AoException

(5014) Get related application elements connected via the specified relationship.

Parameters:

aeRelationship - The requested relationship.

Returns:

The related application elements.

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

getRelationsByType

ApplicationRelation[] getRelationsByType(RelationType aeRelationType)
                                         throws AoException

(5015) Get application relations of the requested type connected with this application element. The inverse relations are not returned.

Parameters:

aeRelationType - The requested relation type.

Returns:

The application relations.

Throws:

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

listAllRelatedElements

java.lang.String[] listAllRelatedElements()
                                          throws AoException

(5016) Get the names of all related application elements.

Returns:

The names of the related application elements.

Throws:

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

listAttributes

java.lang.String[] listAttributes(java.lang.String aaPattern)
                                  throws AoException

(5017) Get the application attribute names of the application element. There are no attribute names returned in the result list that contain a reference to another application element.

Parameters:

aaPattern - The name or the search pattern for the application attribute name.

Returns:

The names of the application attributes.

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

listInstances

NameIterator listInstances(java.lang.String aaPattern)
                           throws AoException

(5018) Get the names of the instances whose names match with the pattern. The pattern is case sensitive and may contain wildcard characters.

Parameters:

aaPattern - The name or the search pattern for the application attribute name.

Returns:

The names of the 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

listRelatedElementsByRelationship

java.lang.String[] listRelatedElementsByRelationship(Relationship aeRelationship)
                                                     throws AoException

(5019) Get the names of related application elements connected via the specified relationship.

Parameters:

aeRelationship - The requested relationship.

Returns:

The names of the related application elements.

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

removeAttribute

void removeAttribute(ApplicationAttribute applAttr)
                     throws AoException

(5020) Remove an application attribute from an application element. If there are instances of the application element the attribute of the existing instances change from application to instance attributes. It is allowed to modify the application element outside a transaction but it is recommended to activate a transaction.

Parameters:

applAttr - The application attribute to remove.

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 AO_TRANSACTION_NOT_ACTIVE

removeInstance

void removeInstance(T_LONGLONG ieId,
                  boolean recursive)
                    throws AoException

(5021) Remove an instance from the application element. It is allowed to remove an instance outside a transaction but it is recommended to activate a transaction. The instance is removed from the server when the transaction is committed. If the recursive flag is set all children of the instance are also deleted. Removing instances is allowed only if there are no references(relations) to this instance. If the recursive flag is set a reference to one of the children is not allowed and will cause an exception.

Parameters:

ieId - The instance Id.

recursive - The recursive flag.

Throws:

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

setBaseElement

void setBaseElement(BaseElement baseElem)
                    throws AoException

(5022) Set or modify the base element of the application element. It is allowed to modify the application element outside a transaction but it is recommended to activate a transaction. The assignment to the current base element is overwritten. If there are instances of the application element or references to the application element an exception is thrown.

Parameters:

baseElem - The base element.

Throws:

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

setName

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

(5023) Set the name of the application element. It is allowed to modify the application element outside a transaction but it is recommended to activate a transaction. The name of the application element must be unique. The name of an application element must not exceed the maximum name length of the underlying physical storage. Current server implementations restrict it to 30 characters.

Parameters:

aeName - The application element name.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_DUPLICATE_NAME 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

(5024) 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

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

Returns:

The access control list entries of the given application 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

(5026) 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 application 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

(5027) 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 had to be done in an interface.

refAid - The Id of referencing application element to which the initial rights will be applied. 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

setInitialRightRelation

void setInitialRightRelation(ApplicationRelation applRel,
                           boolean set)
                             throws AoException

(5028) Set for the given application element, which relation will be used to determine the initial rights for the new created instances.

Parameters:

applRel - The application relation which will be used to determine the initial rights. The relation range of the application relation must be [1:1] otherwise the server can not find an unique instance element to retrieve the initial rights.

set - Set or remove the relation for the initial rights. If this parameter is true the relation will be set otherwise removed.

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

getInitialRightRelations

ApplicationRelation[] getInitialRightRelations()
                                               throws AoException

(5029) Get all relations which are used to retrieve the instances to create the initial rights of the new created instance element. If there is more then one application relation, the initial rights of each related instance are 'ored' to the list of the initial rights.

Returns:

The sequence with the application relations which will be used to create the initial rights of the new created 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

getSecurityLevel

int getSecurityLevel()
                     throws AoException

(5030) Get the security level of the application element. The security level tells if there is a security check for both application element and instance elements or only for the application attributes, the instance elements or none at all.

Returns:

The current security level. The security level constants are defined in the interface SecurityLevel. 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.

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

setSecurityLevel

void setSecurityLevel(int secLevel,
                    RightsSet set)
                      throws AoException

(5031) Set the security level for the given application element. If the security level is added the client is responsible for the access control list entries of the existing objects.

Parameters:

secLevel - The new security level. The security level constants are defined in the interface SecurityLevel. 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 security level.

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

getApplicationStructure

ApplicationStructure getApplicationStructure()
                                             throws AoException

(5032) Get the application model to which the application element belongs by returning an object with the interface ApplicationStructure. The application model provided is the same as that provided from the method getApplicationStructure of the Interface AoSession. This method guarantees that the client software is able to return to the session in case the session object is not available.

Returns:

The application structure to which the application element belongs.

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

createInstances

InstanceElement[] createInstances(NameValueSeqUnit[] attributes,
                                ApplicationRelationInstanceElementSeq[] relatedInstances)
                                  throws AoException

(5033) Create a list with instances. The attribute names are given with the name of the sequence. The attribute values 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:

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

getRelationsByBaseName

ApplicationRelation[] getRelationsByBaseName(java.lang.String baseRelName)
                                             throws AoException

(5034) Return the application relations derived from the base relation with the given relation name. Please note that at most elements only one application relation can be derived from a base relation. However there are some well defined exceptions where this method may return more then one application relation.

Parameters:

baseRelName - The name of the base relation.

Returns:

The application relation sequence; if no relation is found an empty sequence is returned.

Throws:

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