api.methods.applicationattribute

Class ApplicationAttributeExampleAbstract

java.lang.Object

api.methods.aosession.AoSessionExampleAbstract

api.methods.applicationattribute.ApplicationAttributeExampleAbstract

Direct Known Subclasses:

GetApplicationElement, GetBaseAttribute, GetDataType, GetEnumerationDefinition, GetLength, GetName, GetRights, GetUnit, HasUnit, IsAutogenerated, IsObligatory, IsUnique, SetBaseAttribute, SetEnumerationDefinition, SetRights, SetUnit

public class ApplicationAttributeExampleAbstract
extends AoSessionExampleAbstract

The examples of the methods of ApplicationAttribute 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 ApplicationStructure	as

Fields inherited from class api.methods.aosession.AoSessionExampleAbstract

ODS_DATE_FORMAT, options, plumCorba, serviceName, userAuthentication

Constructor Summary

Constructors

Constructor and Description
ApplicationAttributeExampleAbstract()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	close() Close the connection to the ODS Server
protected static ApplicationAttribute	getApplicationAttribute() Get the 'name' attribute with the given name of the application element.
protected static ApplicationAttribute	getApplicationAttribute(java.lang.String aaName) Get the attribute with the given name of the application element.
protected static ApplicationAttribute	getApplicationAttribute(java.lang.String aeName, java.lang.String baName) Get the attribute with the given base name of the application element with the given name.
protected static ApplicationElement	getApplicationElement() Get the application element, this examples use the element derived from AoTest.
protected static ApplicationElement	getApplicationElement(java.lang.String aeName) Get the element with a given name.
protected static ApplicationStructure	getApplicationStructure() Get the application structure
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

as

protected static ApplicationStructure as

ae

protected static ApplicationElement ae

Constructor Detail

ApplicationAttributeExampleAbstract

public ApplicationAttributeExampleAbstract()

Method Detail

getApplicationStructure

protected static ApplicationStructure getApplicationStructure()
                                                       throws AoException

Get the application structure

Returns:

the application structure

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationElement

protected static ApplicationElement getApplicationElement()
                                                   throws AoException

Get the application element, this examples use the element derived from AoTest.

Returns:

the application element.

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationElement

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

Get the element with a given name.

Parameters:

aeName - the name of the element

Returns:

the application element.

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationAttribute

protected static ApplicationAttribute getApplicationAttribute(java.lang.String aeName,
                                           java.lang.String baName)
                                                       throws AoException

Get the attribute with the given base name of the application element with the given name.

Parameters:

aeName - the name of the element

baName - the name of the base attribute

Returns:

the application attribute.

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationAttribute

protected static ApplicationAttribute getApplicationAttribute(java.lang.String aaName)
                                                       throws AoException

Get the attribute with the given name of the application element.

Parameters:

aaName - the name of the attribute

Returns:

the application attribute.

Throws:

AoException - any occurring ASAM ODS exception.

getApplicationAttribute

protected static ApplicationAttribute getApplicationAttribute()
                                                       throws AoException

Get the 'name' attribute with the given name of the application element.

Returns:

the application attribute.

Throws:

AoException - any occurring ASAM ODS exception.

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.