api.methods.applelemaccess

Class ApplElemAccessExampleAbstract

java.lang.Object

api.methods.aosession.AoSessionExampleAbstract

api.methods.applelemaccess.ApplElemAccessExampleAbstract

Direct Known Subclasses:

DeleteInstances, GetAttributeRights, GetElementInitialRight, GetElementRights, GetInitialRightReference, GetInstanceInitialRight, GetInstanceRights, GetInstances, GetInstancesExt, GetODSFile, GetRelInst, GetValueMatrix, GetValueMatrixInMode, InsertInstances, SetAttributeRights, SetElementInitialRights, SetElementRights, SetInitialRightReference, SetRelInst, UpdateInstances

public class ApplElemAccessExampleAbstract
extends AoSessionExampleAbstract

The examples of the methods of ApplElemAccess are all derived from this class

Field Summary

Fields

Modifier and Type	Field and Description
protected static AoSession	aoSess
protected static ApplicationStructureValue	asv

Fields inherited from class api.methods.aosession.AoSessionExampleAbstract

ODS_DATE_FORMAT, options, plumCorba, serviceName, userAuthentication

Constructor Summary

Constructors

Constructor and Description
ApplElemAccessExampleAbstract()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	close() Close the connection to the ODS Server
protected static QueryStructureExt	createQueryStructureExt() Create an empty query structure ext.
protected static SelAIDNameUnitId	createSelAIDNameUnitId(T_LONGLONG aid, java.lang.String aaName) Create a SelAIDNameUnitId structure to request for the values of the attribute with t he given name of the element with the given Id.
protected static T_LONGLONG	getAidByBaseType(java.lang.String beType) Get application element Id of the first element with the requested base type.
protected static T_LONGLONG	getAidByName(java.lang.String aeName) Get application element Id of the element with the requested name.
protected static ApplElemAccess	getApplElemAccess() Get the appl elem access object
protected static ApplicationStructureValue	getApplicationStructureValue() Get the application structure as a value.
protected static java.lang.String	getAttributeNameByBaseName(T_LONGLONG aid, java.lang.String baName) Get application attribute name of the attribute derived from the requested base attribute of element with the requested Id.
protected static T_LONGLONG[]	getInstanceIds(T_LONGLONG aid) Get the Id's of the instances of the element with the given application element Id.
protected static java.lang.String	getRelationName(T_LONGLONG aid, T_LONGLONG aidRel) Get application relation name of the relation between the two elements, use the relation name with the max relation range of 1, which is the relation attribute.
protected static java.lang.String	getRelationNameByBaseName(T_LONGLONG aid, java.lang.String brName) Get application relation name of the relation derived from the requested base relation of element with the requested Id.
protected static AoSession	getSession() Get the session.

Methods inherited from class api.methods.aosession.AoSessionExampleAbstract

connect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

aoSess

protected static AoSession aoSess

asv

protected static ApplicationStructureValue asv

Constructor Detail

ApplElemAccessExampleAbstract

public ApplElemAccessExampleAbstract()

Method Detail

getApplElemAccess

protected static ApplElemAccess getApplElemAccess()
                                           throws AoException

Get the appl elem access object

Returns:

the appl elem access.

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationStructureValue

protected static ApplicationStructureValue getApplicationStructureValue()
                                                                 throws AoException

Get the application structure as a value.

Returns:

the application structure value.

Throws:

AoException - any occurring ASAM ODS exception.

getAidByName

protected static T_LONGLONG getAidByName(java.lang.String aeName)
                                  throws AoException

Get application element Id of the element with the requested name.

Parameters:

aeName - the requested name of the element.

Returns:

the id of the element.

Throws:

AoException - any occurring ASAM ODS exception.

getAidByBaseType

protected static T_LONGLONG getAidByBaseType(java.lang.String beType)
                                      throws AoException

Get application element Id of the first element with the requested base type.

Parameters:

beType - the requested base type of the element.

Returns:

the id of the element.

Throws:

AoException - any occurring ASAM ODS exception.

getAttributeNameByBaseName

protected static java.lang.String getAttributeNameByBaseName(T_LONGLONG aid,
                                          java.lang.String baName)
                                                      throws AoException

Get application attribute name of the attribute derived from the requested base attribute of element with the requested Id.

Parameters:

aid - the requested Id of the element.

baName - the requested base attribute name.

Returns:

the name of the attribute.

Throws:

AoException - any occurring ASAM ODS exception.

getRelationNameByBaseName

protected static java.lang.String getRelationNameByBaseName(T_LONGLONG aid,
                                         java.lang.String brName)
                                                     throws AoException

Get application relation name of the relation derived from the requested base relation of element with the requested Id.

Parameters:

aid - the requested Id of the element.

brName - the requested base relation name.

Returns:

the name of the relation.

Throws:

AoException - any occurring ASAM ODS exception.

getRelationName

protected static java.lang.String getRelationName(T_LONGLONG aid,
                               T_LONGLONG aidRel)
                                           throws AoException

Get application relation name of the relation between the two elements, use the relation name with the max relation range of 1, which is the relation attribute. The first found relation will be take.

Parameters:

aid - the requested Id of the element.

aidRel - the id of the relation element.

Returns:

the name of the relation.

Throws:

AoException - any occurring ASAM ODS exception.

createSelAIDNameUnitId

protected static SelAIDNameUnitId createSelAIDNameUnitId(T_LONGLONG aid,
                                      java.lang.String aaName)

Create a SelAIDNameUnitId structure to request for the values of the attribute with t he given name of the element with the given Id.

Parameters:

aid - the Id of the element.

aaName - the name of the attribute

Returns:

he created and initialized SelAIDNameUnitId

createQueryStructureExt

protected static QueryStructureExt createQueryStructureExt()

Create an empty query structure ext. The fields of the query structure ext are all initialized otherwise a CORBA exception will be thrown when the structure has uninitialized field.

Returns:

the created and initialized query structure ext.

close

protected static void close()
                     throws AoException

Close the connection to the ODS Server

Throws:

AoException - any occurring ASAM ODS exception.

getSession

protected static AoSession getSession()
                               throws AoException

Get the session.

Returns:

the session.

Throws:

AoException - any occurring ASAM ODS exception.

getInstanceIds

protected static T_LONGLONG[] getInstanceIds(T_LONGLONG aid)
                                      throws AoException

Get the Id's of the instances of the element with the given application element Id.

Parameters:

aid - the Id of the application element. Max 20 instances are returned.

Returns:

the list with the Id's.

Throws:

AoException - any occurring ASAM ODS exception.