api.methods.odsfile

Class ODSFileExampleAbstract

java.lang.Object

api.methods.aosession.AoSessionExampleAbstract

api.methods.instanceelement.InstanceElementExampleAbstract

api.methods.odsfile.ODSFileExampleAbstract

Direct Known Subclasses:

Append, CanRead, CanWrite, Create, Exists, GetDate, GetSize, Read, Remove, RemoveFromControl, TakeUnderControl

public class ODSFileExampleAbstract
extends InstanceElementExampleAbstract

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ODSFile	of

Fields inherited from class api.methods.instanceelement.InstanceElementExampleAbstract

ae, aoSess, ie

Fields inherited from class api.methods.aosession.AoSessionExampleAbstract

ODS_DATE_FORMAT, options, plumCorba, serviceName, userAuthentication

Constructor Summary

Constructors

Constructor and Description
ODSFileExampleAbstract()

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 ODSFile	getODSFile() Get an instance of AoFile, the instance is one of the instances from the element derived from AoFile.
protected static AoSession	getSession() Get the session.

Methods inherited from class api.methods.instanceelement.InstanceElementExampleAbstract

getApplicationElement, getApplicationElementByBaseType, getApplicationElementByName, getInstanceElement, getInstanceElement, getInstanceElement

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

of

protected static ODSFile of

Constructor Detail

ODSFileExampleAbstract

public ODSFileExampleAbstract()

Method Detail

getODSFile

protected static ODSFile getODSFile()
                             throws AoException

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

Returns:

the instance of ODSFile.

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.