api.methods.instanceelement

Class InstanceElementExampleAbstract

java.lang.Object

api.methods.aosession.AoSessionExampleAbstract

api.methods.instanceelement.InstanceElementExampleAbstract

Direct Known Subclasses:

AddInstanceAttribute, Compare, CreateRelatedInstances, CreateRelation, DeepCopy, Destroy, GetApplicationElement, GetAsamPath, GetId, GetInitialRight, GetName, GetRelatedInstances, GetRelatedInstancesByRelationship, GetRights, GetValue, GetValueByBaseName, GetValueInUnt, GetValueSeq, ListAttributes, ListRelatedInstances, ListRelatedInstancesByRelationship, MeasurementExampleAbstract, NameValueUnitIteratorExampleAbstract, ODSFileExampleAbstract, SetName, SetValue, SetValueInUnt, ShallowCopy, SubMatrixExampleAbstract, UpcastMeasurement, UpcastODSFile, UpcastSubMatrix, ValueMatrixExampleAbstract

public class InstanceElementExampleAbstract
extends AoSessionExampleAbstract

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ApplicationElement	ae
protected static AoSession	aoSess
protected static InstanceElement	ie

Fields inherited from class api.methods.aosession.AoSessionExampleAbstract

ODS_DATE_FORMAT, options, plumCorba, serviceName, userAuthentication

Constructor Summary

Constructors

Constructor and Description
InstanceElementExampleAbstract()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	close() Close the connection to the ODS Server, destroy the iterator for the client.
protected static ApplicationElement	getApplicationElement() Get the application element derived from AoTest
protected static ApplicationElement	getApplicationElementByBaseType(java.lang.String beType) Get the application element defined by the base type.
protected static ApplicationElement	getApplicationElementByName(java.lang.String aeName) Get the application element defined by the name.
protected static InstanceElement	getInstanceElement() Get an instance, the instance is one of the instances from the element derived from AoTest.
protected static InstanceElement	getInstanceElement(ApplicationElement ae) Get an instance, the instance is one of the instances from the given element.
protected static InstanceElement	getInstanceElement(java.lang.String beType) Get an instance, the instance is one of the instances from the element derived from given base element.
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

ie

protected static InstanceElement ie

ae

protected static ApplicationElement ae

Constructor Detail

InstanceElementExampleAbstract

public InstanceElementExampleAbstract()

Method Detail

getApplicationElementByName

protected static ApplicationElement getApplicationElementByName(java.lang.String aeName)
                                                         throws AoException

Get the application element defined by the name.

Parameters:

aeName - the name of the element

Returns:

the application element.

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationElementByBaseType

protected static ApplicationElement getApplicationElementByBaseType(java.lang.String beType)
                                                             throws AoException

Get the application element defined by the base type.

Parameters:

beType - the base type.

Returns:

the application element.

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationElement

protected static ApplicationElement getApplicationElement()
                                                   throws AoException

Get the application element derived from AoTest

Returns:

the application element.

Throws:

AoException - any occurring ASAM ODS exception.

getInstanceElement

protected static InstanceElement getInstanceElement(java.lang.String beType)
                                             throws AoException

Get an instance, the instance is one of the instances from the element derived from given base element.

Parameters:

beType - the base type.

Returns:

the instance

Throws:

AoException - any occurring ASAM ODS exception.

getInstanceElement

protected static InstanceElement getInstanceElement(ApplicationElement ae)
                                             throws AoException

Get an instance, the instance is one of the instances from the given element.

Parameters:

ae - the application element to load an instance from.

Returns:

the instance

Throws:

AoException - any occurring ASAM ODS exception.

getInstanceElement

protected static InstanceElement getInstanceElement()
                                             throws AoException

Get an instance, the instance is one of the instances from the element derived from AoTest.

Returns:

the instance

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.

close

protected static void close()
                     throws AoException

Close the connection to the ODS Server, destroy the iterator for the client.

Throws:

AoException - any occurring ASAM ODS exception.