ApiAdapter (DataNucleus Core 4.1.17-SNAPSHOT API)

All Superinterfaces:

Serializable
```
public interface ApiAdapter
extends Serializable
```
Adapter to allow the core runtime to expose multiple APIs to clients.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`allowDeleteOfNonPersistentObject()` Whether the API allows deletion of a non-persistent object.
`boolean`	`allowPersistOfDeletedObject()` Whether the API allows (re-)persistence of a deleted object.
`boolean`	`allowReadFieldOfDeletedObject()` Whether the API allows reading a field of a deleted object.
`boolean`	`clearLoadedFlagsOnDeleteObject()` Whether the API requires clearing of the fields of an object when it is deleted.
`void`	`copyKeyFieldsFromIdToObject(Object pc, Persistable.ObjectIdFieldConsumer fm, Object id)` Method to set the pk fields of the object from the provided identity.
`RuntimeException`	`getApiExceptionForNucleusException(NucleusException ne)` Convenience method to convert the passed NucleusException into an exception for the API.
`RuntimeException`	`getDataStoreExceptionForException(String msg, Exception e)` Convenience method to return a datastore exception appropriate for this API.
`boolean`	`getDefaultCascadeDeleteForField()` Method to return the default setting for cascading delete of a field
`boolean`	`getDefaultCascadePersistForField()` Method to return the default setting for cascading persist of a field
`boolean`	`getDefaultCascadeRefreshForField()` Method to return the default setting for cascading refresh of a field
`boolean`	`getDefaultCascadeUpdateForField()` Method to return the default setting for cascading update of a field
`boolean`	`getDefaultDFGForPersistableField()` Method to return the default DFG setting for a persistable field.
`Map`	`getDefaultFactoryProperties()` Method to return a set of default properties for the factory (PMF, EMF, etc)
`ExecutionContext`	`getExecutionContext(Object pc)` Method to return the ExecutionContext (if any) associated with the passed object.
`Object`	`getIdForObject(Object obj)` Method to return the object identity for the passed persistable object.
`LifeCycleState`	`getLifeCycleState(int stateType)` Returns the LifeCycleState for the state constant.
`String`	`getName()` Accessor for the name of the API.
`String`	`getObjectState(Object obj)` Accessor for the object state.
`RuntimeException`	`getUserExceptionForException(String msg, Exception e)` Convenience method to return a user exception appropriate for this API when an unexpected exception occurs.
`Object`	`getVersionForObject(Object obj)` Method to return the object version for the passed persistable object.
`boolean`	`isDeleted(Object obj)` Accessor for whether the passed object is deleted.
`boolean`	`isDetachable(Object obj)` Method to return if the passed object is detachable using this API.
`boolean`	`isDetached(Object obj)` Accessor for whether the passed object is detached.
`boolean`	`isDirty(Object obj)` Accessor for whether the passed object is dirty.
`boolean`	`isManaged(Object pc)` Whether the provided object is currently managed (has an ExecutionContext).
`boolean`	`isMemberDefaultPersistent(Class type)` Accessor for whether this member type is default persistent.
`boolean`	`isNew(Object obj)` Accessor for whether the passed object is new.
`boolean`	`isPersistable(Class cls)` Utility method to check if the specified class is of a type that can be persisted for this API.
`boolean`	`isPersistable(Object obj)` Method to return if the passed object is persistable using this API.
`boolean`	`isPersistent(Object obj)` Accessor for whether the passed object is persistent.
`boolean`	`isTransactional(Object obj)` Accessor for whether the passed object is transactional.
`boolean`	`isValidPrimaryKeyClass(Class pkClass, AbstractClassMetaData cmd, ClassLoaderResolver clr, int noOfPkFields, MetaDataManager mmgr)` Utility to check if a primary-key class is valid.
`void`	`makeDirty(Object obj, String member)` Method to make the member of the persistable object dirty.

- Method Detail
  - getName
```
String getName()
```
    Accessor for the name of the API. JDO, JPA etc
    
    Returns:
    
    Name of the API
  - isMemberDefaultPersistent
```
boolean isMemberDefaultPersistent(Class type)
```
    Accessor for whether this member type is default persistent.
    
    Parameters:
    
    type - Member type
    
    Returns:
    
    Whether it is by default persistent
  - isManaged
```
boolean isManaged(Object pc)
```
    Whether the provided object is currently managed (has an ExecutionContext).
    
    Parameters:
    
    pc - The persistable object
    
    Returns:
    
    Whether it is managed
  - getExecutionContext
```
ExecutionContext getExecutionContext(Object pc)
```
    Method to return the ExecutionContext (if any) associated with the passed object. Supports persistable objects, and PersistenceManager.
    
    Parameters:
    
    pc - The object
    
    Returns:
    
    The ExecutionContext
  - getLifeCycleState
```
LifeCycleState getLifeCycleState(int stateType)
```
    Returns the LifeCycleState for the state constant.
    
    Parameters:
    
    stateType - the type as integer
    
    Returns:
    
    the type as LifeCycleState object
  - isPersistent
```
boolean isPersistent(Object obj)
```
    Accessor for whether the passed object is persistent.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is persistent
  - isNew
```
boolean isNew(Object obj)
```
    Accessor for whether the passed object is new.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is new
  - isDirty
```
boolean isDirty(Object obj)
```
    Accessor for whether the passed object is dirty.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is dirty
  - isDeleted
```
boolean isDeleted(Object obj)
```
    Accessor for whether the passed object is deleted.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is deleted
  - isDetached
```
boolean isDetached(Object obj)
```
    Accessor for whether the passed object is detached.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is detached
  - isTransactional
```
boolean isTransactional(Object obj)
```
    Accessor for whether the passed object is transactional.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is transactional
  - isPersistable
```
boolean isPersistable(Object obj)
```
    Method to return if the passed object is persistable using this API.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is persistable
  - isPersistable
```
boolean isPersistable(Class cls)
```
    Utility method to check if the specified class is of a type that can be persisted for this API.
    
    Parameters:
    
    cls - The class to check
    
    Returns:
    
    Whether the class is persistable using this API.
  - isDetachable
```
boolean isDetachable(Object obj)
```
    Method to return if the passed object is detachable using this API.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    Whether it is detachable
  - getObjectState
```
String getObjectState(Object obj)
```
    Accessor for the object state.
    
    Parameters:
    
    obj - Object
    
    Returns:
    
    The state ("persistent-clean", "detached-dirty" etc)
  - makeDirty
```
void makeDirty(Object obj,
               String member)
```
    Method to make the member of the persistable object dirty.
    
    Parameters:
    
    obj - The object
    
    member - Name of the member
  - getIdForObject
```
Object getIdForObject(Object obj)
```
    Method to return the object identity for the passed persistable object. Returns null if it is not persistable, or has no identity.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    The identity
  - getVersionForObject
```
Object getVersionForObject(Object obj)
```
    Method to return the object version for the passed persistable object. Returns null if it is not persistable, or not versioned.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    The version
  - isValidPrimaryKeyClass
```
boolean isValidPrimaryKeyClass(Class pkClass,
                               AbstractClassMetaData cmd,
                               ClassLoaderResolver clr,
                               int noOfPkFields,
                               MetaDataManager mmgr)
```
    Utility to check if a primary-key class is valid. Will throw a InvalidPrimaryKeyException if it is invalid, otherwise returning true.
    
    Parameters:
    
    pkClass - The Primary Key class
    
    cmd - AbstractClassMetaData for the persistable class
    
    clr - the ClassLoaderResolver
    
    noOfPkFields - Number of primary key fields
    
    mmgr - MetaData manager
    
    Returns:
    
    Whether it is valid
  - copyKeyFieldsFromIdToObject
```
void copyKeyFieldsFromIdToObject(Object pc,
                                 Persistable.ObjectIdFieldConsumer fm,
                                 Object id)
```
    Method to set the pk fields of the object from the provided identity.
    
    Parameters:
    
    pc - The persistable object
    
    fm - ObjectIdFieldConsumer
    
    id - The identity
  - allowPersistOfDeletedObject
```
boolean allowPersistOfDeletedObject()
```
    Whether the API allows (re-)persistence of a deleted object.
    
    Returns:
    
    Whether you can call persist on a deleted object
  - allowDeleteOfNonPersistentObject
```
boolean allowDeleteOfNonPersistentObject()
```
    Whether the API allows deletion of a non-persistent object.
    
    Returns:
    
    Whether you can call delete on an object not yet persisted
  - allowReadFieldOfDeletedObject
```
boolean allowReadFieldOfDeletedObject()
```
    Whether the API allows reading a field of a deleted object.
    
    Returns:
    
    Whether you can read after deleting
  - clearLoadedFlagsOnDeleteObject
```
boolean clearLoadedFlagsOnDeleteObject()
```
    Whether the API requires clearing of the fields of an object when it is deleted.
    
    Returns:
    
    Whether to clear loaded fields at delete
  - getDefaultCascadePersistForField
```
boolean getDefaultCascadePersistForField()
```
    Method to return the default setting for cascading persist of a field
    
    Returns:
    
    default persist cascade setting.
  - getDefaultCascadeUpdateForField
```
boolean getDefaultCascadeUpdateForField()
```
    Method to return the default setting for cascading update of a field
    
    Returns:
    
    default cascade update setting.
  - getDefaultCascadeDeleteForField
```
boolean getDefaultCascadeDeleteForField()
```
    Method to return the default setting for cascading delete of a field
    
    Returns:
    
    default cascade delete setting.
  - getDefaultCascadeRefreshForField
```
boolean getDefaultCascadeRefreshForField()
```
    Method to return the default setting for cascading refresh of a field
    
    Returns:
    
    default cascade refresh setting.
  - getDefaultDFGForPersistableField
```
boolean getDefaultDFGForPersistableField()
```
    Method to return the default DFG setting for a persistable field.
    
    Returns:
    
    DFG default for persistable field
  - getDefaultFactoryProperties
```
Map getDefaultFactoryProperties()
```
    Method to return a set of default properties for the factory (PMF, EMF, etc)
    
    Returns:
    
    The default properties (if any) for this API
  - getApiExceptionForNucleusException
```
RuntimeException getApiExceptionForNucleusException(NucleusException ne)
```
    Convenience method to convert the passed NucleusException into an exception for the API.
    
    Parameters:
    
    ne - The NucleusException
    
    Returns:
    
    The Api Exception
  - getUserExceptionForException
```
RuntimeException getUserExceptionForException(String msg,
                                              Exception e)
```
    Convenience method to return a user exception appropriate for this API when an unexpected exception occurs.
    
    Parameters:
    
    msg - The message
    
    e - The cause (if any)
    
    Returns:
    
    The API exception
  - getDataStoreExceptionForException
```
RuntimeException getDataStoreExceptionForException(String msg,
                                                   Exception e)
```
    Convenience method to return a datastore exception appropriate for this API.
    
    Parameters:
    
    msg - The message
    
    e - The cause (if any)
    
    Returns:
    
    The exception

Interface ApiAdapter

Method Summary

Method Detail

getName

isMemberDefaultPersistent

isManaged

getExecutionContext

getLifeCycleState

isPersistent

isNew

isDirty

isDeleted

isDetached

isTransactional

isPersistable

isPersistable

isDetachable

getObjectState

makeDirty

getIdForObject

getVersionForObject

isValidPrimaryKeyClass

copyKeyFieldsFromIdToObject

allowPersistOfDeletedObject

allowDeleteOfNonPersistentObject

allowReadFieldOfDeletedObject

clearLoadedFlagsOnDeleteObject

getDefaultCascadePersistForField

getDefaultCascadeUpdateForField

getDefaultCascadeDeleteForField

getDefaultCascadeRefreshForField

getDefaultDFGForPersistableField

getDefaultFactoryProperties

getApiExceptionForNucleusException

getUserExceptionForException

getDataStoreExceptionForException