org.asam.ods

Interface BaseStructureOperations

All Known Subinterfaces:

BaseStructure

All Known Implementing Classes:

_BaseStructureStub, BaseStructure, BaseStructure, BaseStructurePOA

public interface BaseStructureOperations

The ASAM ODS base structure interface.

Method Summary

Methods

Modifier and Type	Method and Description
BaseElement	getElementByType(java.lang.String beType) (11001) Get the base element that matches the requested type.
BaseElement[]	getElements(java.lang.String bePattern) (11002) Get the base elements that match the pattern.
BaseRelation	getRelation(BaseElement elem1, BaseElement elem2) (11003) Get the base relation between two base elements.
BaseRelation[]	getRelations(BaseElement elem1, BaseElement elem2) (11008) Get the base relations between two base elements.
BaseElement[]	getTopLevelElements(java.lang.String bePattern) (11004) Get the top level base elements that match the pattern.
java.lang.String	getVersion() (11005) Get the version of the base model as string.
java.lang.String[]	listElements(java.lang.String bePattern) (11006) Get the base element names that match the pattern.
java.lang.String[]	listTopLevelElements(java.lang.String bePattern) (11007) Get the top level base element names that match the pattern.

Method Detail

getElementByType

BaseElement getElementByType(java.lang.String beType)
                             throws AoException

(11001) Get the base element that matches the requested type. The type of a base element is identical with the base element name.

Parameters:

beType - The name of the requested base element.

Returns:

The requested base element.

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

getElements

BaseElement[] getElements(java.lang.String bePattern)
                          throws AoException

(11002) Get the base elements that match the pattern. The pattern is case sensitive and may contain wildcard characters.

Parameters:

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

Returns:

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

getRelation

BaseRelation getRelation(BaseElement elem1,
                       BaseElement elem2)
                         throws AoException

(11003) Get the base relation between two base elements. The base relation is given from the first element (parameter elem1) to the second element (parameter elem2), the inverse relation is not returned.

Parameters:

elem1 - The base element from which the relation starts.

elem2 - The base element to which the relation points.

Returns:

The base relation between the two base 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 AO_NOT_FOUND

getTopLevelElements

BaseElement[] getTopLevelElements(java.lang.String bePattern)
                                  throws AoException

(11004) Get the top level base elements that match the pattern. The pattern is case sensitive and may contain wildcard characters. A top level base element is a base element without a father.

Parameters:

bePattern - The name or the search pattern for the requested top level base elements.

Returns:

The requested top level base 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

getVersion

java.lang.String getVersion()
                            throws AoException

(11005) Get the version of the base model as string. The version of the base model is the version of the ASAM ODS base model.

Returns:

The version of the ASAM ODS base model.

Throws:

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

listElements

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

(11006) Get the base element names that match the pattern. The pattern is case sensitive and may contain wildcard characters.

Parameters:

bePattern - The name or the search pattern for the requested base element names.

Returns:

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

listTopLevelElements

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

(11007) Get the top level base element names that match the pattern. The pattern is case sensitive and may contain wildcard characters. A top level base element is a base element without a father.

Parameters:

bePattern - The name or the search pattern for the requested top level base element names.

Returns:

The requested top level base element 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

getRelations

BaseRelation[] getRelations(BaseElement elem1,
                          BaseElement elem2)
                            throws AoException

(11008) Get the base relations between two base elements. The base relations are given from the first element (parameter elem1) to the second element (parameter elem2), the inverse relation is not returned. In case there are no base relations between the two elements the server will throw the exception AO_NOT_FOUND

Parameters:

elem1 - The base element from which the relation starts.

elem2 - The base element to which the relation points.

Returns:

The list with base relations between the two 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 AO_NOT_FOUND