com.im.ijc.core.api.cookie
Interface SchemaProviderCookie

All Superinterfaces:

DFCapability, Node.Cookie

public interface SchemaProviderCookie
extends Node.Cookie, DFCapability

Cookie providing the root DIF model interface - DFSchemaProvider

Nested Class Summary

static interface

SchemaProviderCookie.EncryptionSupport Optional interface, which makes the schema open to ask for an extra password for decrypting some properties.

Method Summary

DataObject	getDataObject() Returns the schemaDataObject.
DBImplSchemaProvider.PropsProvider	getPropsProvider() Return properties provider.
DFSchemaProvider	getSchemaProvider(boolean forceInit) Get schema provider instance.
SchemaType	getSchemaType() Determines if the schema is local, stored within the project, or in remote database, or schema is accessed through IJC application server
boolean	isAutoConnect() Should this schema be connected automatically after startup or project opening?

Method Detail

getSchemaProvider

DFSchemaProvider getSchemaProvider(boolean forceInit)

Get schema provider instance. The schema provider can return in any state (uninitialized of completely finished). This call in not blocking, initializer runs on background. If unitialized schemaprovider is returned (=state.isSchemaReady() returns false) then it's possible to register property change listener for PROP_STATE and check when schema is ready.

Parameters:

forceInit - If true, it starts async process for schema initialization

getDataObject

DataObject getDataObject()

Returns the schemaDataObject. Svata: we should avoid having SchemaDO in the APIs. SchemaDO does not provide any APIs, so it is not necessary to use specific type.

getPropsProvider

DBImplSchemaProvider.PropsProvider getPropsProvider()

Return properties provider. This object can be used for writing/reading of properties in the file under this cookie (=DataObject)

getSchemaType

SchemaType getSchemaType()

Determines if the schema is local, stored within the project, or in remote database, or schema is accessed through IJC application server

Returns:

The type of the schema

isAutoConnect

boolean isAutoConnect()

Should this schema be connected automatically after startup or project opening?

Returns:

True if schema should be connected automatically