oracle.ifs.common
Class ConnectOptions

java.lang.Object
  |
  +--oracle.ifs.common.ConnectOptions

public class ConnectOptions

extends java.lang.Object

ConnectOptions is a bucket of parameters that govern the behavior of LibraryService.connect.

Constructor Summary

ConnectOptions()
Constructs a ConnectOptions.

Method Summary

java.lang.String	getApplicationName() Gets the name of the application creating the session.
java.util.Locale	getLocale() Gets the Locale of the new session.
void	setApplicationName(java.lang.String name) Sets the name of the application creating the session.
void	setLocale(java.util.Locale locale) Sets the Locale of the new session.

Constructor Detail

ConnectOptions

public ConnectOptions()
               throws IfsException

Constructs a ConnectOptions.

Throws:

IfsException - if the operation fails

Method Detail

setApplicationName

public void setApplicationName(java.lang.String name)
                        throws IfsException

Sets the name of the application creating the session.

The value is not used internally; it is purely informational.

Parameters:

name - the application name

Throws:

IfsException - if the operation fails

getApplicationName

public java.lang.String getApplicationName()
                                    throws IfsException

Gets the name of the application creating the session.

The value is not used internally; it is purely informational.

Returns:

the application name

Throws:

IfsException - if the operation fails

setLocale

public void setLocale(java.util.Locale locale)
               throws IfsException

Sets the Locale of the new session.

Parameters:

locale - the Locale

Throws:

IfsException - if the operation fails

getLocale

public java.util.Locale getLocale()
                           throws IfsException

Gets the Locale of the new session.

Returns:

the Locale

Throws:

IfsException - if the operation fails