com.essbase.api.session

Class IEssbase.Home

java.lang.Object

com.essbase.api.session.IEssbase.Home

Enclosing interface:

IEssbase

public static final class IEssbase.Home
extends java.lang.Object

The Home is a factory for creating JAPI instances.

Constructor Summary

Constructors

Constructor and Description
Home()

Method Summary

Modifier and Type	Method and Description
static IEssbase	create(java.lang.String japiVerUsed) Creates an instance of JAPI.

Methods inherited from class java.lang.Object

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

Constructor Detail

Home

public Home()

Method Detail

create

public static IEssbase create(java.lang.String japiVerUsed)
                       throws com.essbase.api.base.EssException

Creates an instance of JAPI.

Parameters:

japiVerUsed - The JAPI version used when compiling the client. Make sure to pass only IEssbase.JAPI_VERSION, and do not pass any hard coded string. Example usage is: create(IEssbase.JAPI_VERSION). This is useful for future compatibility - i.e in case you compile with one version of JAPI and attempt to run with a totally non compatible version of JAPI, this method will throw an exception.

Returns:

The JAPI instance.

Throws:

com.essbase.api.base.EssException - if an error occurs.