com.oracle.e1.aisclient

Class AISClientCapability

java.lang.Object

com.oracle.e1.aisclient.AISClientCapability

public abstract class AISClientCapability
extends java.lang.Object

Provides methods to determine if the AIS server provides the capabilities used by your application. Capabilities available depend on the AIS sever version. The AIS server will publish it's capabilities via the defaultconfig response.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALIAS_NAMING
static java.lang.String	APPLICATION_STACK
static java.lang.String	DATA_SERVICE
static java.lang.String	EDITABLE
static java.lang.String	GRID
static java.lang.String	GRID_CELL_CLICK
static java.lang.String	IGNORE_FDA_FIND_ON_ENTRY
static java.lang.String	JARGON
static java.lang.String	LOG
static java.lang.String	PROCESSING_OPTION
static java.lang.String	QUERY
static java.lang.String	SELECT_ALL_GRID_ROWS
static java.lang.String	TASK_AUTHORIZATION

Constructor Summary

Constructors

Constructor and Description
AISClientCapability()

Method Summary

Methods

Modifier and Type	Method and Description
static void	capabilityDetectCheck(LoginEnvironment loginEnv, DefaultConfig defaultConfig) Provided the defaultConfig response from the AIS server, and that required capabilities are listed in the ApplicationGlobals, this will check if the server provides all of the required capabilities.
static boolean	capabilityExists(LoginEnvironment loginEnv, java.lang.String capability) Looks through the list of capabilities within the login environment for the matching one, returns true if it is found You are still restricted to using only the capabilities listed in the required or used capabilities lists, even if the capability is in this list.
static boolean	isCapabilityAvailable(LoginEnvironment loginEnv, java.lang.String capability) Provided the capability name, determine if that capability is available on the currently configured AIS server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EDITABLE

public static final java.lang.String EDITABLE

See Also:

Constant Field Values

GRID

public static final java.lang.String GRID

See Also:

Constant Field Values

LOG

public static final java.lang.String LOG

See Also:

Constant Field Values

PROCESSING_OPTION

public static final java.lang.String PROCESSING_OPTION

See Also:

Constant Field Values

IGNORE_FDA_FIND_ON_ENTRY

public static final java.lang.String IGNORE_FDA_FIND_ON_ENTRY

See Also:

Constant Field Values

SELECT_ALL_GRID_ROWS

public static final java.lang.String SELECT_ALL_GRID_ROWS

See Also:

Constant Field Values

APPLICATION_STACK

public static final java.lang.String APPLICATION_STACK

See Also:

Constant Field Values

GRID_CELL_CLICK

public static final java.lang.String GRID_CELL_CLICK

See Also:

Constant Field Values

QUERY

public static final java.lang.String QUERY

See Also:

Constant Field Values

TASK_AUTHORIZATION

public static final java.lang.String TASK_AUTHORIZATION

See Also:

Constant Field Values

JARGON

public static final java.lang.String JARGON

See Also:

Constant Field Values

ALIAS_NAMING

public static final java.lang.String ALIAS_NAMING

See Also:

Constant Field Values

DATA_SERVICE

public static final java.lang.String DATA_SERVICE

See Also:

Constant Field Values

Constructor Detail

AISClientCapability

public AISClientCapability()

Method Detail

capabilityExists

public static boolean capabilityExists(LoginEnvironment loginEnv,
                       java.lang.String capability)

Looks through the list of capabilities within the login environment for the matching one, returns true if it is found You are still restricted to using only the capabilities listed in the required or used capabilities lists, even if the capability is in this list.

Parameters:

capability -

Returns:

boolean true if the capability exists

isCapabilityAvailable

public static boolean isCapabilityAvailable(LoginEnvironment loginEnv,
                            java.lang.String capability)

Provided the capability name, determine if that capability is available on the currently configured AIS server. You must also put this capability in the 'usedCapabilities' list in ApplicationGloabls for it to be available

Parameters:

capability -

Returns:

boolean true if the capability is available

capabilityDetectCheck

public static void capabilityDetectCheck(LoginEnvironment loginEnv,
                         DefaultConfig defaultConfig)
                                  throws CapabilityException

Provided the defaultConfig response from the AIS server, and that required capabilities are listed in the ApplicationGlobals, this will check if the server provides all of the required capabilities. If not a capability exception is thrown. You do not need to call this method if you use the AISClientUtiliites.getDefaultConfiguration() method, it will be called for you when the default configuration is fetched.

Parameters:

defaultConfig -

Throws:

com.oracle.e1.aisclient.model.aisclient.CapabilityException

CapabilityException