org.asam.ods

Interface ApplicationStructureOperations

All Known Subinterfaces:

ApplicationStructure

All Known Implementing Classes:

_ApplicationStructureStub, ApplicationStructure, ApplicationStructure, ApplicationStructurePOA

public interface ApplicationStructureOperations

The ASAM ODS application structure interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	check() (7001) Check the application model for ASAM ODS conformity.
ApplicationElement	createElement(BaseElement baseElem) (7002) Create a new application element in the application model.
EnumerationDefinition	createEnumerationDefinition(java.lang.String enumName) (7018) Create a new enumeration definition.
void	createInstanceRelations(ApplicationRelation applRel, InstanceElement[] elemList1, InstanceElement[] elemList2) (7022) Create the relation between a list of instances.
ApplicationRelation	createRelation() (7003) Create a new relation.
ApplicationElement	getElementById(T_LONGLONG aeId) (7004) Get the application element with the requested Id.
ApplicationElement	getElementByName(java.lang.String aeName) (7005) Get the application element with the requested name.
ApplicationElement[]	getElements(java.lang.String aePattern) (7006) Get the application elements whose names match with the pattern.
ApplicationElement[]	getElementsByBaseType(java.lang.String aeType) (7007) Get the names of application elements that are derived from the specified base element.
EnumerationDefinition	getEnumerationDefinition(java.lang.String enumName) (7021) Get the specified enumeration definition.
InstanceElement	getInstanceByAsamPath(java.lang.String asamPath) (7008) Get the instance element specified by the ASAM path.
InstanceElement[]	getInstancesById(ElemId[] ieIds) (7016) Get the instance elements specified by the sequence of element ids.
ApplicationRelation[]	getRelations(ApplicationElement applElem1, ApplicationElement applElem2) (7009) Returns the relations between two application elements.
AoSession	getSession() (7017) Get the current client session in which the application model is created.
ApplicationElement[]	getTopLevelElements(java.lang.String aeType) (7010) Get the top level application elements which are inherited from the base element that matches the base type.
java.lang.String[]	listElements(java.lang.String aePattern) (7011) Get the names of the application elements that match with the pattern.
java.lang.String[]	listElementsByBaseType(java.lang.String aeType) (7012) Get the names of application elements that are derived from the given base type.
java.lang.String[]	listEnumerations() (7020) Get the list of all enumeration names.
java.lang.String[]	listTopLevelElements(java.lang.String aeType) (7013) Get the names of the top level application elements that are derived from the given base type.
void	removeElement(ApplicationElement applElem) (7014) Remove an application element from the application model.
void	removeEnumerationDefinition(java.lang.String enumName) (7019) Remove the enumeration definition.
void	removeRelation(ApplicationRelation applRel) (7015) This method removes an application relation from the model.

Method Detail

check

void check()
           throws AoException

(7001) Check the application model for ASAM ODS conformity. The first error found is reported by an exception. The following checks are performed: - Each application element must be derived from a valid base element. - An application attribute is derived from one base attribute. It is not allowed to derive more the one application attribute from the same base attribute. It is allowed that application attributes are not derived from any base attribute. - All application elements must have at least the mandatory attributes. - All application elements must be identifyable by a unique Asam path. No "floating" application elements are allowed. - All relations required by the base model must be present.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_DUPLICATE_BASE_ATTRIBUTE AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATION AO_MISSING_ATTRIBUTE AO_MISSING_RELATION AO_MISSING_APPLICATION_ELEMENT AO_NOT_IMPLEMENTED AO_NO_PATH_TO_ELEMENT AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

createElement

ApplicationElement createElement(BaseElement baseElem)
                                 throws AoException

(7002) Create a new application element in the application model. It is allowed to modify the application model outside a transaction but it is recommended to activate a transaction. The information whether or not the new application element is a top level element is taken from the specified base element. The Id of the application element is set automatically. The mandatory base attributes are created automatically. Optional attributes have to be created by the calling program. The application attribute interface methods may be used to modify the attributes.

Parameters:

baseElem - The base element from which the application element is derived.

Returns:

The new 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 AO_TRANSACTION_NOT_ACTIVE

createRelation

ApplicationRelation createRelation()
                                   throws AoException

(7003) Create a new relation. It is allowed to modify the application model outside a transaction but it is recommended to activate a transaction. The relation is part of the application model. The application relation interface methods may be used to modify the relation. The default properties of a new application relation are: BaseRelation NULL Element1 NULL Element2 NULL Range -2, -2 Name NULL Type INFO When element 1 or element 2 is set before the name of the relation is specified, the name of the application relation is set to "AUTOGEN".

Returns:

The new application relation.

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_TRANSACTION_NOT_ACTIVE

getElementById

ApplicationElement getElementById(T_LONGLONG aeId)
                                  throws AoException

(7004) Get the application element with the requested Id.

Parameters:

aeId - The Id of the requested application element.

Returns:

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

getElementByName

ApplicationElement getElementByName(java.lang.String aeName)
                                    throws AoException

(7005) Get the application element with the requested name.

Parameters:

aeName - The name of the requested application element.

Returns:

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

getElements

ApplicationElement[] getElements(java.lang.String aePattern)
                                 throws AoException

(7006) Get the application elements whose names match with the pattern. The pattern is case sensitive and may contain wildcard characters.

Parameters:

aePattern - The name or the search pattern for the requested application elements.

Returns:

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

getElementsByBaseType

ApplicationElement[] getElementsByBaseType(java.lang.String aeType)
                                           throws AoException

(7007) Get the names of application elements that are derived from the specified base element.

Parameters:

aeType - The requested base element type. The base element type can be a pattern.

Returns:

The requested application element names.

Throws:

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

getInstanceByAsamPath

InstanceElement getInstanceByAsamPath(java.lang.String asamPath)
                                      throws AoException

(7008) Get the instance element specified by the ASAM path.

Parameters:

asamPath - The ASAM path of the requested instance element.

Returns:

The requested instance element.

Throws:

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

getRelations

ApplicationRelation[] getRelations(ApplicationElement applElem1,
                                 ApplicationElement applElem2)
                                   throws AoException

(7009) Returns the relations between two application elements.

Parameters:

applElem1 - The first application element.

applElem2 - The second application element.

Returns:

The relations between the specified application 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

getTopLevelElements

ApplicationElement[] getTopLevelElements(java.lang.String aeType)
                                         throws AoException

(7010) Get the top level application elements which are inherited from the base element that matches the base type. If the given base type is no top level base element an exception is thrown. A top level application element is an application element without a father.

Parameters:

aeType - The requested base type. The base element type can be a pattern.

Returns:

The top level application elements.

Throws:

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

listElements

java.lang.String[] listElements(java.lang.String aePattern)
                                throws AoException

(7011) Get the names of the application elements that match with the pattern. The pattern is case sensitive and may contain wildcard characters.

Parameters:

aePattern - The name or the search pattern for the requested base elements.

Returns:

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

listElementsByBaseType

java.lang.String[] listElementsByBaseType(java.lang.String aeType)
                                          throws AoException

(7012) Get the names of application elements that are derived from the given base type.

Parameters:

aeType - The requested base type. The base element type can be a pattern.

Returns:

The names of the application elements.

Throws:

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

listTopLevelElements

java.lang.String[] listTopLevelElements(java.lang.String aeType)
                                        throws AoException

(7013) Get the names of the top level application elements that are derived from the given base type. If the given base type is not a top level base element an exception is thrown. A top level application element is an application element without a father.

Parameters:

aeType - The requested base type.

Returns:

The names of the application elements.

Throws:

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

removeElement

void removeElement(ApplicationElement applElem)
                   throws AoException

(7014) Remove an application element from the application model. It is allowed to modify the application model outside a transaction but it is recommended to activate a transaction. - Only allowed if the application element: - has no instances. - has no relations with other application elements.

Parameters:

applElem - The application element to be removed.

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_FOUND AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

removeRelation

void removeRelation(ApplicationRelation applRel)
                    throws AoException

(7015) This method removes an application relation from the model. It is allowed to modify the application model outside a transaction but it is recommended to activate a transaction. The elements of the relation are still part of the application model. If there are instances of the relation they are also removed.

Parameters:

applRel - The application relation to be removed.

Throws:

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

getInstancesById

InstanceElement[] getInstancesById(ElemId[] ieIds)
                                   throws AoException

(7016) Get the instance elements specified by the sequence of element ids.

Parameters:

ieIds - The sequence with the element ids.

Returns:

The sequence with the requested instance elements.

Throws:

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

getSession

AoSession getSession()
                     throws AoException

(7017) Get the current client session in which the application model is created.

Returns:

The current client session.

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

createEnumerationDefinition

EnumerationDefinition createEnumerationDefinition(java.lang.String enumName)
                                                  throws AoException

(7018) Create a new enumeration definition. This method modifies the application model and is only allowed for the super user.

Parameters:

enumName - Name of the enumeration

Returns:

The new created enumeration

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 AO_ACCESS_DENIED

removeEnumerationDefinition

void removeEnumerationDefinition(java.lang.String enumName)
                                 throws AoException

(7019) Remove the enumeration definition. The server checks if the enumeration is still in use by one of the attributes. This method modifies the application model and is only allowed for the super user.

Parameters:

enumName - Name of the enumeration to remove.

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 AO_ACCESS_DENIED

listEnumerations

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

(7020) Get the list of all enumeration names.

Returns:

List with all enumeration names.

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

getEnumerationDefinition

EnumerationDefinition getEnumerationDefinition(java.lang.String enumName)
                                               throws AoException

(7021) Get the specified enumeration definition.

Parameters:

enumName - Name of the requested enumeration.

Returns:

The enumeration definition.

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

createInstanceRelations

void createInstanceRelations(ApplicationRelation applRel,
                           InstanceElement[] elemList1,
                           InstanceElement[] elemList2)
                             throws AoException

(7022) Create the relation between a list of instances. The number of instances in both list must be identical. The application element of the instances in each list must be identical. The application elements must match the application elements of the application relation. The index in the list of the instances defines related instances.

Parameters:

applRel - The application relation.

elemList1 - The list with the instances of one application element for which the relation will be created.

elemList2 - The list with 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 AO_TRANSACTION_NOT_ACTIVE