com.highqsoft.interfaces.odsx

Interface OdsxSessionInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInterface, FwkTransferableInterface, javax.infobus.ImmediateAccess, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

OdsxSession

public interface OdsxSessionInterface
extends FwkCompareInterface, javax.infobus.DataItem, javax.infobus.ImmediateAccess, javax.infobus.DataItemChangeManager, java.awt.datatransfer.Transferable, FwkControllerInterface

The OdsxSessionInterface is the interface for ASAM-ODS sessions.

Since:

$Date: 2017/04/28 08:47:45 $

Version:

$Revision: 1.16 $

Author:

HighQSoft GmbH

See Also:

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecuteStateListener(FwkExecuteStateListenerInterface l) Add an execution state listener.
void	close() Close the sessoin to an ODS server.
void	fireExecuteStateEvent(FwkExecuteStateEventInterface event) Fire an execute state event.
java.lang.String	getAuthentication() This method returns the authentication information of the session.
AoSession	getCheckedSession() This method returns the ASAM-ODS session.
java.lang.String	getName() This method returns the name of the session.
java.lang.String	getOptions() This method returns all options to get the session.
java.lang.String	getPlumName() This method returns the name of the plugable Asam component.
AoService	getService() This method returns the service of the session.
java.lang.String	getServiceName() This method returns the service name of the session.
java.lang.String	getServiceOptions() This method returns the options of the service.
AoSession	getSession() This method returns the session.
java.lang.String	getSessionName() This method returns the unique name of the session.
java.lang.String	getSessionOptions() This method returns the options of the session.
boolean	hasPermissions() Test the permissions.
boolean	isTheSame(AoSession aoSession) Return a boolean whether the given AoSession is equal to this one.
boolean	isValid() Test the ASAM-ODS session.
void	removeExecuteStateListener(FwkExecuteStateListenerInterface l) Remove an execution state listener.
void	setAuthentication(java.lang.String authentication) This method sets the authentication information of the session.
void	setName(java.lang.String name) This method sets the name of the session.
void	setPlumName(java.lang.String plumName) This method sets the plugable component name of the session.
void	setServiceName(java.lang.String serviceName) This method sets the name of the service to which the session belongs.
void	setServiceOptions(java.lang.String options) This method sets the options of the service.
void	setSessionName(java.lang.String sessionName) This method sets the unique name of the session.
void	setSessionOptions(java.lang.String options) This method sets the options of the session.
void	setSessionOptions(java.lang.String options, java.lang.String authentication) This method sets the options of the session.
boolean	wasCancelled() Test the ASAM-ODS session whether it was canceled by the user.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface javax.infobus.DataItem

getProperty, getSource, release

Methods inherited from interface javax.infobus.ImmediateAccess

getPresentationString, getValueAsObject, getValueAsString, setValue

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSupportEMail, setTitleName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Method Detail

close

void close()
           throws java.lang.RuntimeException

Close the sessoin to an ODS server.

Throws:

java.lang.RuntimeException

getAuthentication

java.lang.String getAuthentication()

This method returns the authentication information of the session.

Returns:

The authentication information of the session.

getName

java.lang.String getName()

This method returns the name of the session.

Specified by:

getName in interface FwkDescriptionInterface

Returns:

The name of the session.

getOptions

java.lang.String getOptions()

This method returns all options to get the session.

Returns:

The options of the session.

getSessionOptions

java.lang.String getSessionOptions()

This method returns the options of the session.

Returns:

The options of the session.

getServiceOptions

java.lang.String getServiceOptions()

This method returns the options of the service.

Returns:

The options of the service.

getPlumName

java.lang.String getPlumName()

This method returns the name of the plugable Asam component.

Returns:

The plugable component name of the session.

getService

AoService getService()
                     throws java.lang.RuntimeException

This method returns the service of the session.

Returns:

The service of the session.

Throws:

java.lang.RuntimeException

getServiceName

java.lang.String getServiceName()

This method returns the service name of the session.

Returns:

The service name of the session brick.

getSession

AoSession getSession()
                     throws java.lang.RuntimeException

This method returns the session.

Returns:

The session.

Throws:

java.lang.RuntimeException

getCheckedSession

AoSession getCheckedSession()
                            throws java.lang.RuntimeException

This method returns the ASAM-ODS session.

Returns:

The ASAM-ODS session.

Throws:

java.lang.RuntimeException

See Also:

AoFactory#getCheckedSession

getSessionName

java.lang.String getSessionName()

This method returns the unique name of the session.

Returns:

The name of the session.

setAuthentication

void setAuthentication(java.lang.String authentication)

This method sets the authentication information of the session.

Parameters:

authentication - The authentication information.

isValid

boolean isValid()

Test the ASAM-ODS session.

Returns:

true if the OdsxSession defines a valid ASAM-ODS session.

hasPermissions

boolean hasPermissions()

Test the permissions.

Returns:

true if the user has permissions to read the application structure from session.

setName

void setName(java.lang.String name)

This method sets the name of the session.

Specified by:

setName in interface FwkDescriptionInterface

Parameters:

name - The name of the session.

See Also:

FwkDescriptionInterface.getName()

setSessionOptions

void setSessionOptions(java.lang.String options)

This method sets the options of the session.

Parameters:

options - The options.

setSessionOptions

void setSessionOptions(java.lang.String options,
                     java.lang.String authentication)

This method sets the options of the session.

Parameters:

options - The options.

authentication - The authentication string.

setServiceOptions

void setServiceOptions(java.lang.String options)

This method sets the options of the service.

Parameters:

options - The options.

setPlumName

void setPlumName(java.lang.String plumName)

This method sets the plugable component name of the session.

Parameters:

plumName - The plugable component name.

setServiceName

void setServiceName(java.lang.String serviceName)

This method sets the name of the service to which the session belongs.

Parameters:

serviceName - The service name.

setSessionName

void setSessionName(java.lang.String sessionName)

This method sets the unique name of the session.

Parameters:

sessionName - The unique name of the session.

addExecuteStateListener

void addExecuteStateListener(FwkExecuteStateListenerInterface l)

Add an execution state listener.

Parameters:

l - The listener.

removeExecuteStateListener

void removeExecuteStateListener(FwkExecuteStateListenerInterface l)

Remove an execution state listener.

Parameters:

l - The listener.

fireExecuteStateEvent

void fireExecuteStateEvent(FwkExecuteStateEventInterface event)

Fire an execute state event.

Parameters:

event - The event to be fired.

isTheSame

boolean isTheSame(AoSession aoSession)

Return a boolean whether the given AoSession is equal to this one.

Parameters:

aoSession - theAoSession

Returns:

true if the given AoSession is equal to the inner one.

wasCancelled

boolean wasCancelled()

Test the ASAM-ODS session whether it was canceled by the user. The reason for that action is not meaningful here.

Returns:

true if the OdsxSession was canceled by the user.