Objectivity for Java Reference

com.objy.db.iapp
Interface PooContObj

All Superinterfaces:
PHasSession, PooObj, PRoot

public interface PooContObj
extends PooObj

Reserved for internal use.


Method Summary
 void addIndex(String indexName, String className, String fieldList)
           
 void addUniqueIndex(String indexName, String className, String fieldList)
           
 Iterator contains()
           
 void convertObjects()
           
 void delete()
          Deletes this persistor's object from the database and propagates the deletion operation to related objects.
 void deleteNoProp()
          Deletes this persistor's object from the database.
 void dropIndex(String indexName)
           
 void flush()
           
 ooAPObj getControlledBy()
           
 ooDBObj getDB()
           
 long getGrowthFactor()
           
 int getHash()
           
 String getName()
           
 ooId getOid()
          Gets the object identifier of this persistor's object.
 long getPageCount()
           
 boolean hasIndex(String indexName)
           
 boolean isUpdated()
           
 void lockNoProp(int lockMode)
          Explicitly locks this persistor's object for the specified access.
 void refresh(int lockMode)
           
 void releaseReadLock()
           
 void returnControl()
           
 Iterator scan(String className)
           
 Iterator scan(String className, String predicate)
           
 Iterator scan(String className, String predicate, int access)
           
 void transferControl(PooAPObj ap)
           
 
Methods inherited from interface com.objy.db.iapp.PooObj
clearModified, cluster, compareOoId, copy, deleteReference, dropCachedReference, fetch, fetch, getContainer, getSession, getTarget, hashOoId, isDead, isFetchRequired, isModified, isPersistent, isValid, lock, lookupObj, lookupObj, lookupObjName, markFetchRequired, markModified, move, nameObj, scopedBy, scopedObjects, unnameObj, updateIndexes, write
 
Methods inherited from interface com.objy.db.iapp.PHasSession
connectionId
 
Methods inherited from interface com.objy.db.iapp.PRoot
clusterReason
 

Method Detail

getDB

public ooDBObj getDB()

getName

public String getName()

getPageCount

public long getPageCount()

getGrowthFactor

public long getGrowthFactor()

getHash

public int getHash()

getOid

public ooId getOid()
Description copied from interface: PooObj
Gets the object identifier of this persistor's object.

Specified by:
getOid in interface PooObj
Following copied from interface: com.objy.db.iapp.PooObj
Returns:
The object identifier of this persistor's object.

delete

public void delete()
Description copied from interface: PooObj
Deletes this persistor's object from the database and propagates the deletion operation to related objects.

This method propagates the deletion operation to any objects associated to the object through relationships for which deletion propagation is enabled.

Until the current transaction is committed, the deleted objects continue to exist in your application's memory, but their persistors are marked Once a persistor is dead, you should not call its methods that perform persistence operations.

Each deleted object is removed from any bidirectional relationships in which it is involved. However, if another persistent object references the deleted object in a unidirectional relationship or directly in one of its persistent fields, you are responsible for removing that reference. An exception is thrown if you attempt to write a persistent object that references a dead object.

Specified by:
delete in interface PooObj
Following copied from interface: com.objy.db.iapp.PooObj
See Also:
PooObj.deleteNoProp(), PooObj.isDead()

deleteNoProp

public void deleteNoProp()
Description copied from interface: PooObj
Deletes this persistor's object from the database.

Until the current transaction is committed, the deleted object continues to exist in your application's memory, but its persistor is marked dead. Once a persistor is dead, you should not call its methods that perform persistence operations.

The deleted object is removed from any bidirectional relationships in which it is involved. However, if another persistent object references the deleted object in a unidirectional relationship or directly in one of its persistent fields, you are responsible for removing that reference. An exception is thrown if you attempt to write a persistent object that references a dead object.

Unlike the delete method, this method does not propagate the deletion operation to related objects.

Specified by:
deleteNoProp in interface PooObj
Following copied from interface: com.objy.db.iapp.PooObj
See Also:
PooObj.isDead(), PooObj.delete()

returnControl

public void returnControl()

isUpdated

public boolean isUpdated()

refresh

public void refresh(int lockMode)

flush

public void flush()

releaseReadLock

public void releaseReadLock()

lockNoProp

public void lockNoProp(int lockMode)
Description copied from interface: PooObj
Explicitly locks this persistor's object for the specified access.

Unlike the lock method, this method does not propagate the lock to related objects.

Locking a basic object implicitly locks the object's container. Locking a container implicitly locks all basic objects in the container.

Specified by:
lockNoProp in interface PooObj
Following copied from interface: com.objy.db.iapp.PooObj
Parameters:
lockMode - The type of lock to obtain for the object; one of the following constants defined in the oo interface:
READ
Obtain a read lock.
WRITE
Obtain a write lock.

The lock mode is limited by the open mode of the object's session. If you try to set the lock mode to WRITE when the session's open mode is openReadOnly, you should throw a runtime exception in the implementation.


contains

public Iterator contains()

scan

public Iterator scan(String className)

scan

public Iterator scan(String className,
                     String predicate)

scan

public Iterator scan(String className,
                     String predicate,
                     int access)

addIndex

public void addIndex(String indexName,
                     String className,
                     String fieldList)

addUniqueIndex

public void addUniqueIndex(String indexName,
                           String className,
                           String fieldList)

dropIndex

public void dropIndex(String indexName)

hasIndex

public boolean hasIndex(String indexName)

convertObjects

public void convertObjects()

transferControl

public void transferControl(PooAPObj ap)

getControlledBy

public ooAPObj getControlledBy()

Objectivity for Java Reference

Copyright © 2000 Objectivity, Inc. All rights reserved.