Objectivity for Java Reference

com.objy.db.app
Interface oo


public interface oo

Defines constants used as parameters and return values by many methods.

You need not implement this interface in any of your classes; however, doing so allows you to refer to the constants with their unqualified names, such as READ. If your class does not implement this interface, it must use the fully-qualified constant names, such as oo.READ.

API Summary

Constant Types
Thread policies
    Specify how Java threads may interact with sessions and transactions.
THREAD_POLICY_RESTRICTED
THREAD_POLICY_UNRESTRICTED
MROW modes
    Specify whether Multiple Readers, One Writer (MROW) is enabled for a transaction.
MROW
NO_MROW
Wait options
    Specify whether to wait for locks when starting a transaction.
WAIT
NO_WAIT
Index modes
    Control when indexes are updated after indexed objects' key fields are modified.
SENSITIVE
INSENSITIVE
EXPLICIT_UPDATE
Downgrade modes
    Specify whether write locks should be downgraded to read locks after a checkpoint operation.
DOWNGRADE_ALL
NO_DOWNGRADE
Open modes
    Specify how a connection to the federated database was opened.
openReadOnly
openReadWrite
notOpen
Lock modes
    Control how Objectivity/DB objects are locked.
READ
WRITE
NONE
Field access levels
    Specify the access level of persistent fields that can be tested by predicate queries.
PUBLIC
ALL
Error levels
    Specify the severity of a runtime error that caused an exception to be thrown.
NO_ERROR
WARNING
USER_ERROR
SYSTEM_ERROR
FATAL_ERROR
Container filer modes
    Control what containers can be retrieved by the iterator returned the contains method of a database (DRO).
ALL_CONTAINERS
TRANSFERRED
NOT_TRANSFERRED
Offline modes
    Control whether the offline status of autonomous partitions is being enforced (FTO/DRO).
ENFORCE
IGNORE
AMS usage modes
    Control when to use the Advanced Multithreaded Server (AMS).
AMS_PREFERRED
AMS_ONLY
NO_AMS


Field Summary
static int ALL
          Field access level: The predicate query can test all fields.
static int ALL_CONTAINERS
          (DRO) Container filter mode: Retrieve all containers from the database.
static int AMS_ONLY
          AMS usage mode: Use AMS exclusively.
static int AMS_PREFERRED
          AMS usage mode: Use AMS for remote data access if it is available.
static int DOWNGRADE_ALL
          Downgrade mode: After the transaction checkpoint, all write locks obtained during the transaction are downgraded to read locks.
static int ENFORCE
          (FTO/DRO) Offline mode: Enforce the offline status of autonomous partitions.
static int EXPLICIT_UPDATE
          Index mode: Indexes are updated by explicit calls to the updateIndexes method of each new object or modified object.
static int FATAL_ERROR
          Error level: Objectivity/DB detected an unrecoverable internal inconsistency that might already have caused data corruption.
static int IGNORE
          (FTO/DRO) Offline mode: Ignore the offline status of autonomous partitions.
static int INSENSITIVE
          Index mode: Indexes are updated automatically when the transaction is committed.
static int MROW
          MROW mode: Multiple Readers, One Writer (MROW) is enabled for the transaction.
static int NO_AMS
          AMS usage mode: Never use AMS.
static int NO_DOWNGRADE
          Downgrade mode: After the transaction checkpoint, all write locks obtained during the transaction are preserved.
static int NO_ERROR
          Error level: No exception occurred.
static int NO_MROW
          MROW mode: Multiple Readers, One Writer (MROW) is not enabled for the transaction.
static int NO_WAIT
          Wait option: Transactions do not wait for locks when starting.
static int NONE
          Lock mode: The persistent object is not locked.
static int NOT_TRANSFERRED
          (DRO) Container filter mode: Retrieve only those containers that have the same controlling Autonomous Partition as the database.
static int notOpen
          Connection access mode: The connection is not open; sessions may not be created.
static int openExclusive
          Connection access mode: Not supported.
static int openReadOnly
          Connection access mode: The connection is open for read-only access.
static int openReadWrite
          Connection access mode: The connection is open for read/write access.
static int PUBLIC
          Field access level: The predicate query can test only public fields.
static int READ
          Lock mode: The persistent object is locked for read.
static int SENSITIVE
          Index mode: Indexes are updated automatically immediately after an indexed object is deleted or an object of the indexed class is made persistent.
static int SYSTEM_ERROR
          Error level: Objectivity/DB detected a system error.
static int THREAD_POLICY_RESTRICTED
          Thread policy: A thread's interaction is restricted; it must be joined to a session to perform any persistent operation with that session or objects belonging to that session.
static int THREAD_POLICY_UNRESTRICTED
          Thread policy: A thread's interaction is unrestricted; any given thread can interact with any session or objects belonging to any session.
static int TRANS_NO_WAIT
          Reserved for future use.
static int TRANSFERRED
          (DRO) Container filter mode: Retrieve only those containers that have a different controlling Autonomous Partition from the database.
static int UPGRADE
          Lock mode: Not supported.
static int USER_ERROR
          Error level: The programming interface to Objectivity/DB detected a programmer error that is directly attributable to the application programmer.
static int WAIT
          Wait option: Transactions wait indefinitely for locks when starting.
static int WARNING
          Error level: An abnormal event occurred.
static int WRITE
          Lock mode: The persistent object is locked for write.
 

Field Detail

notOpen

public static final int notOpen
Connection access mode: The connection is not open; sessions may not be created.

openReadOnly

public static final int openReadOnly
Connection access mode: The connection is open for read-only access.

openReadWrite

public static final int openReadWrite
Connection access mode: The connection is open for read/write access.

openExclusive

public static final int openExclusive
Connection access mode: Not supported. Do not use this constant.

NONE

public static final int NONE
Lock mode: The persistent object is not locked.

READ

public static final int READ
Lock mode: The persistent object is locked for read.

WRITE

public static final int WRITE
Lock mode: The persistent object is locked for write.

UPGRADE

public static final int UPGRADE
Lock mode: Not supported. Do not use this constant.

NO_MROW

public static final int NO_MROW
MROW mode: Multiple Readers, One Writer (MROW) is not enabled for the transaction.

MROW

public static final int MROW
MROW mode: Multiple Readers, One Writer (MROW) is enabled for the transaction.

ENFORCE

public static final int ENFORCE
(FTO/DRO) Offline mode: Enforce the offline status of autonomous partitions.

IGNORE

public static final int IGNORE
(FTO/DRO) Offline mode: Ignore the offline status of autonomous partitions.

ALL_CONTAINERS

public static final int ALL_CONTAINERS
(DRO) Container filter mode: Retrieve all containers from the database.

NOT_TRANSFERRED

public static final int NOT_TRANSFERRED
(DRO) Container filter mode: Retrieve only those containers that have the same controlling Autonomous Partition as the database.

TRANSFERRED

public static final int TRANSFERRED
(DRO) Container filter mode: Retrieve only those containers that have a different controlling Autonomous Partition from the database.

PUBLIC

public static final int PUBLIC
Field access level: The predicate query can test only public fields. This field-access mode preserves encapsulation.

ALL

public static final int ALL
Field access level: The predicate query can test all fields. To preserve encapsulation, you should use this field-access mode only within methods of the class you are querying.

AMS_PREFERRED

public static final int AMS_PREFERRED
AMS usage mode: Use AMS for remote data access if it is available.

AMS_ONLY

public static final int AMS_ONLY
AMS usage mode: Use AMS exclusively.

NO_AMS

public static final int NO_AMS
AMS usage mode: Never use AMS.

INSENSITIVE

public static final int INSENSITIVE
Index mode: Indexes are updated automatically when the transaction is committed.

SENSITIVE

public static final int SENSITIVE
Index mode: Indexes are updated automatically immediately after an indexed object is deleted or an object of the indexed class is made persistent. You should use this index mode for a session in which you perform predicate scans.

EXPLICIT_UPDATE

public static final int EXPLICIT_UPDATE
Index mode: Indexes are updated by explicit calls to the updateIndexes method of each new object or modified object.

NO_WAIT

public static final int NO_WAIT
Wait option: Transactions do not wait for locks when starting.

WAIT

public static final int WAIT
Wait option: Transactions wait indefinitely for locks when starting.

TRANS_NO_WAIT

public static final int TRANS_NO_WAIT
Reserved for future use.

NO_DOWNGRADE

public static final int NO_DOWNGRADE
Downgrade mode: After the transaction checkpoint, all write locks obtained during the transaction are preserved.

DOWNGRADE_ALL

public static final int DOWNGRADE_ALL
Downgrade mode: After the transaction checkpoint, all write locks obtained during the transaction are downgraded to read locks.

NO_ERROR

public static final int NO_ERROR
Error level: No exception occurred.

WARNING

public static final int WARNING
Error level: An abnormal event occurred.

USER_ERROR

public static final int USER_ERROR
Error level: The programming interface to Objectivity/DB detected a programmer error that is directly attributable to the application programmer. For example, passing an invalid parameter to a public method of the interface usually causes a programmer error.

SYSTEM_ERROR

public static final int SYSTEM_ERROR
Error level: Objectivity/DB detected a system error. The error might actually have been caused by a programmer error that was not detected by the programming interface.

FATAL_ERROR

public static final int FATAL_ERROR
Error level: Objectivity/DB detected an unrecoverable internal inconsistency that might already have caused data corruption.

THREAD_POLICY_RESTRICTED

public static final int THREAD_POLICY_RESTRICTED
Thread policy: A thread's interaction is restricted; it must be joined to a session to perform any persistent operation with that session or objects belonging to that session.

THREAD_POLICY_UNRESTRICTED

public static final int THREAD_POLICY_UNRESTRICTED
Thread policy: A thread's interaction is unrestricted; any given thread can interact with any session or objects belonging to any session.

Objectivity for Java Reference

Copyright © 2000 Objectivity, Inc. All rights reserved.