org.ofbiz.core.entity

Interface DelegatorInterface

All Known Implementing Classes:

GenericDelegator, LockedDatabaseGenericDelegator

public interface DelegatorInterface

Delegator Interface

Since:

2.0

Version:

$Revision: 1.1 $

Author:

Patrick Lightbody

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAllCacheLinesByDummyPK(Collection<? extends GenericEntity> dummyPKs)
void	clearAllCacheLinesByValue(Collection<? extends GenericValue> values)
void	clearAllCaches()
void	clearAllCaches(boolean distribute)
void	clearCacheLine(GenericPK primaryKey)
void	clearCacheLine(GenericPK primaryKey, boolean distribute)
void	clearCacheLine(GenericValue value)
void	clearCacheLine(GenericValue value, boolean distribute)
void	clearCacheLine(String entityName, Map<String,?> fields)
void	clearCacheLineFlexible(GenericEntity dummyPK)
void	clearCacheLineFlexible(GenericEntity dummyPK, boolean distribute)
int	countAll(String entityName)
int	countByAnd(String entityName, String fieldName, List<? extends EntityCondition> expressions, EntityFindOptions findOptions)
int	countByCondition(String entityName, String fieldName, EntityCondition condition, EntityFindOptions findOptions)
int	countByOr(String entityName, String fieldName, List<? extends EntityCondition> expressions, EntityFindOptions findOptions)
GenericValue	create(GenericPK primaryKey)
GenericValue	create(GenericPK primaryKey, boolean doCacheClear)
GenericValue	create(GenericValue value)
GenericValue	create(GenericValue value, boolean doCacheClear)
GenericValue	create(String entityName, Map<String,?> fields)
List<GenericValue>	findAll(String entityName)
List<GenericValue>	findAll(String entityName, List<String> orderBy)
List<GenericValue>	findAllByPrimaryKeys(Collection<? extends GenericPK> primaryKeys)
List<GenericValue>	findAllByPrimaryKeysCache(Collection<? extends GenericPK> primaryKeys)
List<GenericValue>	findAllCache(String entityName)
List<GenericValue>	findAllCache(String entityName, List<String> orderBy)
List<GenericValue>	findByAnd(ModelEntity modelEntity, Map<String,?> fields, List<String> orderBy)
List<GenericValue>	findByAnd(String entityName, List<? extends EntityCondition> expressions)
List<GenericValue>	findByAnd(String entityName, List<? extends EntityCondition> expressions, List<String> orderBy)
List<GenericValue>	findByAnd(String entityName, Map<String,?> fields)
List<GenericValue>	findByAnd(String entityName, Map<String,?> fields, List<String> orderBy)
List<GenericValue>	findByAndCache(String entityName, Map<String,?> fields)
List<GenericValue>	findByAndCache(String entityName, Map<String,?> fields, List<String> orderBy)
List<GenericValue>	findByCondition(String entityName, EntityCondition entityCondition, Collection<String> fieldsToSelect, List<String> orderBy)
List<GenericValue>	findByLike(String entityName, Map<String,?> fields)
List<GenericValue>	findByLike(String entityName, Map<String,?> fields, List<String> orderBy)
List<GenericValue>	findByOr(String entityName, List<? extends EntityCondition> expressions)
List<GenericValue>	findByOr(String entityName, List<? extends EntityCondition> expressions, List<String> orderBy)
List<GenericValue>	findByOr(String entityName, Map<String,?> fields)
List<GenericValue>	findByOr(String entityName, Map<String,?> fields, List<String> orderBy)
GenericValue	findByPrimaryKey(GenericPK primaryKey)
GenericValue	findByPrimaryKey(String entityName, Map<String,?> fields)
GenericValue	findByPrimaryKeyCache(GenericPK primaryKey)
GenericValue	findByPrimaryKeyCache(String entityName, Map<String,?> fields)
GenericValue	findByPrimaryKeyPartial(GenericPK primaryKey, Set<String> keys)
EntityListIterator	findListIteratorByCondition(String entityName, EntityCondition entityCondition, Collection<String> fieldsToSelect, List<String> orderBy)
EntityListIterator	findListIteratorByCondition(String entityName, EntityCondition whereEntityCondition, EntityCondition havingEntityCondition, Collection<String> fieldsToSelect, List<String> orderBy, EntityFindOptions findOptions)
UtilCache<String,List<GenericValue>>	getAllCache()
UtilCache<GenericPK,List<GenericValue>>	getAndCache()
String	getDelegatorName()
ModelFieldType	getEntityFieldType(ModelEntity entity, String type)
Collection<String>	getEntityFieldTypeNames(ModelEntity entity)
String	getEntityGroupName(String entityName)
GenericHelper	getEntityHelper(ModelEntity entity)
GenericHelper	getEntityHelper(String entityName)
String	getEntityHelperName(ModelEntity entity)
String	getEntityHelperName(String entityName)
Set<Set<String>>	getFieldNameSetsCopy(String entityName)
List<GenericValue>	getFromAllCache(String entityName)
List<GenericValue>	getFromAndCache(ModelEntity entity, Map<String,?> fields)
List<GenericValue>	getFromAndCache(String entityName, Map<String,?> fields)
GenericValue	getFromPrimaryKeyCache(GenericPK primaryKey)
String	getGroupHelperName(String groupName)
List<ModelEntity>	getModelEntitiesByGroup(String groupName)
ModelEntity	getModelEntity(String entityName)
Map<String,ModelEntity>	getModelEntityMapByGroup(String groupName)
ModelGroupReader	getModelGroupReader()
ModelReader	getModelReader()
List<GenericValue>	getMultiRelation(GenericValue value, String relationNameOne, String relationNameTwo)
List<GenericValue>	getMultiRelation(GenericValue value, String relationNameOne, String relationNameTwo, List<String> orderBy)
Long	getNextSeqId(String seqName)
UtilCache<GenericEntity,GenericValue>	getPrimaryKeyCache()
List<GenericValue>	getRelated(String relationName, GenericValue value)
List<GenericValue>	getRelated(String relationName, Map<String,?> byAndFields, List<String> orderBy, GenericValue value)
List<GenericValue>	getRelatedByAnd(String relationName, Map<String,?> byAndFields, GenericValue value)
List<GenericValue>	getRelatedCache(String relationName, GenericValue value)
GenericPK	getRelatedDummyPK(String relationName, Map<String,?> byAndFields, GenericValue value)
GenericValue	getRelatedOne(String relationName, GenericValue value)
GenericValue	getRelatedOneCache(String relationName, GenericValue value)
List<GenericValue>	getRelatedOrderBy(String relationName, List<String> orderBy, GenericValue value)
GenericPK	makePK(String entityName, Map<String,?> fields)
GenericValue	makeValue(String entityName, Map<String,?> fields)
void	putAllInPrimaryKeyCache(List<? extends GenericValue> values)
void	putInAllCache(ModelEntity entity, List<? extends GenericValue> values)
void	putInAllCache(String entityName, List<? extends GenericValue> values)
void	putInAndCache(ModelEntity entity, Map<String,?> fields, List<? extends GenericValue> values)
void	putInAndCache(String entityName, Map<String,?> fields, List<? extends GenericValue> values)
void	putInPrimaryKeyCache(GenericPK primaryKey, GenericValue value)
void	refresh(GenericValue value)
void	refresh(GenericValue value, boolean doCacheClear)
void	refreshSequencer()
int	removeAll(List<? extends GenericEntity> dummyPKs)
int	removeAll(List<? extends GenericEntity> dummyPKs, boolean doCacheClear)
int	removeByAnd(String entityName, Map<String,?> fields)
int	removeByAnd(String entityName, Map<String,?> fields, boolean doCacheClear)
int	removeByCondition(String entityName, EntityCondition entityCondition)
int	removeByCondition(String entityName, EntityCondition entityCondition, boolean doCacheClear)
int	removeByPrimaryKey(GenericPK primaryKey)
int	removeByPrimaryKey(GenericPK primaryKey, boolean doCacheClear)
int	removeRelated(String relationName, GenericValue value)
int	removeRelated(String relationName, GenericValue value, boolean doCacheClear)
int	removeValue(GenericValue value)
int	removeValue(GenericValue value, boolean doCacheClear)
void	setSequencer(SequenceUtil sequencer)
int	store(GenericValue value)
int	store(GenericValue value, boolean doCacheClear)
int	storeAll(List<? extends GenericValue> values)
int	storeAll(List<? extends GenericValue> values, boolean doCacheClear)
List<GenericValue>	transform(String entityName, EntityCondition entityCondition, List<String> orderBy, String lockField, Transformation transformation) Applies the given transformation to any entities matching the given condition.

Method Detail

getDelegatorName

String getDelegatorName()

getModelReader

ModelReader getModelReader()

getModelGroupReader

ModelGroupReader getModelGroupReader()

getModelEntity

ModelEntity getModelEntity(String entityName)

getEntityGroupName

String getEntityGroupName(String entityName)

getModelEntitiesByGroup

List<ModelEntity> getModelEntitiesByGroup(String groupName)

getModelEntityMapByGroup

Map<String,ModelEntity> getModelEntityMapByGroup(String groupName)

getGroupHelperName

String getGroupHelperName(String groupName)

getEntityHelperName

String getEntityHelperName(String entityName)

getEntityHelperName

String getEntityHelperName(ModelEntity entity)

getEntityHelper

GenericHelper getEntityHelper(String entityName)
                              throws GenericEntityException

Throws:

GenericEntityException

getEntityHelper

GenericHelper getEntityHelper(ModelEntity entity)
                              throws GenericEntityException

Throws:

GenericEntityException

getEntityFieldType

ModelFieldType getEntityFieldType(ModelEntity entity,
                                String type)
                                  throws GenericEntityException

Throws:

GenericEntityException

getEntityFieldTypeNames

Collection<String> getEntityFieldTypeNames(ModelEntity entity)
                                           throws GenericEntityException

Throws:

GenericEntityException

makeValue

GenericValue makeValue(String entityName,
                     Map<String,?> fields)

makePK

GenericPK makePK(String entityName,
               Map<String,?> fields)

create

GenericValue create(String entityName,
                  Map<String,?> fields)
                    throws GenericEntityException

Throws:

GenericEntityException

create

GenericValue create(GenericValue value)
                    throws GenericEntityException

Throws:

GenericEntityException

create

GenericValue create(GenericValue value,
                  boolean doCacheClear)
                    throws GenericEntityException

Throws:

GenericEntityException

create

GenericValue create(GenericPK primaryKey)
                    throws GenericEntityException

Throws:

GenericEntityException

create

GenericValue create(GenericPK primaryKey,
                  boolean doCacheClear)
                    throws GenericEntityException

Throws:

GenericEntityException

findByPrimaryKey

GenericValue findByPrimaryKey(GenericPK primaryKey)
                              throws GenericEntityException

Throws:

GenericEntityException

findByPrimaryKeyCache

GenericValue findByPrimaryKeyCache(GenericPK primaryKey)
                                   throws GenericEntityException

Throws:

GenericEntityException

findByPrimaryKey

GenericValue findByPrimaryKey(String entityName,
                            Map<String,?> fields)
                              throws GenericEntityException

Throws:

GenericEntityException

findByPrimaryKeyCache

GenericValue findByPrimaryKeyCache(String entityName,
                                 Map<String,?> fields)
                                   throws GenericEntityException

Throws:

GenericEntityException

findByPrimaryKeyPartial

GenericValue findByPrimaryKeyPartial(GenericPK primaryKey,
                                   Set<String> keys)
                                     throws GenericEntityException

Throws:

GenericEntityException

findAllByPrimaryKeys

List<GenericValue> findAllByPrimaryKeys(Collection<? extends GenericPK> primaryKeys)
                                        throws GenericEntityException

Throws:

GenericEntityException

findAllByPrimaryKeysCache

List<GenericValue> findAllByPrimaryKeysCache(Collection<? extends GenericPK> primaryKeys)
                                             throws GenericEntityException

Throws:

GenericEntityException

removeByPrimaryKey

int removeByPrimaryKey(GenericPK primaryKey)
                       throws GenericEntityException

Throws:

GenericEntityException

removeByPrimaryKey

int removeByPrimaryKey(GenericPK primaryKey,
                     boolean doCacheClear)
                       throws GenericEntityException

Throws:

GenericEntityException

removeValue

int removeValue(GenericValue value)
                throws GenericEntityException

Throws:

GenericEntityException

removeValue

int removeValue(GenericValue value,
              boolean doCacheClear)
                throws GenericEntityException

Throws:

GenericEntityException

findAll

List<GenericValue> findAll(String entityName)
                           throws GenericEntityException

Throws:

GenericEntityException

findAll

List<GenericValue> findAll(String entityName,
                         List<String> orderBy)
                           throws GenericEntityException

Throws:

GenericEntityException

findAllCache

List<GenericValue> findAllCache(String entityName)
                                throws GenericEntityException

Throws:

GenericEntityException

findAllCache

List<GenericValue> findAllCache(String entityName,
                              List<String> orderBy)
                                throws GenericEntityException

Throws:

GenericEntityException

findByAnd

List<GenericValue> findByAnd(String entityName,
                           Map<String,?> fields)
                             throws GenericEntityException

Throws:

GenericEntityException

findByOr

List<GenericValue> findByOr(String entityName,
                          Map<String,?> fields)
                            throws GenericEntityException

Throws:

GenericEntityException

findByAnd

List<GenericValue> findByAnd(String entityName,
                           Map<String,?> fields,
                           List<String> orderBy)
                             throws GenericEntityException

Throws:

GenericEntityException

findByAnd

List<GenericValue> findByAnd(ModelEntity modelEntity,
                           Map<String,?> fields,
                           List<String> orderBy)
                             throws GenericEntityException

Throws:

GenericEntityException

findByOr

List<GenericValue> findByOr(String entityName,
                          Map<String,?> fields,
                          List<String> orderBy)
                            throws GenericEntityException

Throws:

GenericEntityException

findByAndCache

List<GenericValue> findByAndCache(String entityName,
                                Map<String,?> fields)
                                  throws GenericEntityException

Throws:

GenericEntityException

findByAndCache

List<GenericValue> findByAndCache(String entityName,
                                Map<String,?> fields,
                                List<String> orderBy)
                                  throws GenericEntityException

Throws:

GenericEntityException

findByAnd

List<GenericValue> findByAnd(String entityName,
                           List<? extends EntityCondition> expressions)
                             throws GenericEntityException

Throws:

GenericEntityException

findByOr

List<GenericValue> findByOr(String entityName,
                          List<? extends EntityCondition> expressions)
                            throws GenericEntityException

Throws:

GenericEntityException

findByAnd

List<GenericValue> findByAnd(String entityName,
                           List<? extends EntityCondition> expressions,
                           List<String> orderBy)
                             throws GenericEntityException

Throws:

GenericEntityException

findByOr

List<GenericValue> findByOr(String entityName,
                          List<? extends EntityCondition> expressions,
                          List<String> orderBy)
                            throws GenericEntityException

Throws:

GenericEntityException

findByLike

List<GenericValue> findByLike(String entityName,
                            Map<String,?> fields)
                              throws GenericEntityException

Throws:

GenericEntityException

findByLike

List<GenericValue> findByLike(String entityName,
                            Map<String,?> fields,
                            List<String> orderBy)
                              throws GenericEntityException

Throws:

GenericEntityException

findByCondition

List<GenericValue> findByCondition(String entityName,
                                 EntityCondition entityCondition,
                                 Collection<String> fieldsToSelect,
                                 List<String> orderBy)
                                   throws GenericEntityException

Throws:

GenericEntityException

countByAnd

int countByAnd(String entityName,
             String fieldName,
             List<? extends EntityCondition> expressions,
             EntityFindOptions findOptions)
               throws GenericEntityException

Throws:

GenericEntityException

countByOr

int countByOr(String entityName,
            String fieldName,
            List<? extends EntityCondition> expressions,
            EntityFindOptions findOptions)
              throws GenericEntityException

Throws:

GenericEntityException

countByCondition

int countByCondition(String entityName,
                   String fieldName,
                   EntityCondition condition,
                   EntityFindOptions findOptions)
                     throws GenericEntityException

Throws:

GenericEntityException

countAll

int countAll(String entityName)
             throws GenericEntityException

Throws:

GenericEntityException

findListIteratorByCondition

EntityListIterator findListIteratorByCondition(String entityName,
                                             EntityCondition entityCondition,
                                             Collection<String> fieldsToSelect,
                                             List<String> orderBy)
                                               throws GenericEntityException

Throws:

GenericEntityException

findListIteratorByCondition

EntityListIterator findListIteratorByCondition(String entityName,
                                             EntityCondition whereEntityCondition,
                                             EntityCondition havingEntityCondition,
                                             Collection<String> fieldsToSelect,
                                             List<String> orderBy,
                                             EntityFindOptions findOptions)
                                               throws GenericEntityException

Throws:

GenericEntityException

removeByAnd

int removeByAnd(String entityName,
              Map<String,?> fields)
                throws GenericEntityException

Throws:

GenericEntityException

removeByAnd

int removeByAnd(String entityName,
              Map<String,?> fields,
              boolean doCacheClear)
                throws GenericEntityException

Throws:

GenericEntityException

removeByCondition

int removeByCondition(String entityName,
                    EntityCondition entityCondition)
                      throws GenericEntityException

Throws:

GenericEntityException

removeByCondition

int removeByCondition(String entityName,
                    EntityCondition entityCondition,
                    boolean doCacheClear)
                      throws GenericEntityException

Throws:

GenericEntityException

getMultiRelation

List<GenericValue> getMultiRelation(GenericValue value,
                                  String relationNameOne,
                                  String relationNameTwo,
                                  List<String> orderBy)
                                    throws GenericEntityException

Throws:

GenericEntityException

getMultiRelation

List<GenericValue> getMultiRelation(GenericValue value,
                                  String relationNameOne,
                                  String relationNameTwo)
                                    throws GenericEntityException

Throws:

GenericEntityException

getRelated

List<GenericValue> getRelated(String relationName,
                            GenericValue value)
                              throws GenericEntityException

Throws:

GenericEntityException

getRelatedByAnd

List<GenericValue> getRelatedByAnd(String relationName,
                                 Map<String,?> byAndFields,
                                 GenericValue value)
                                   throws GenericEntityException

Throws:

GenericEntityException

getRelatedOrderBy

List<GenericValue> getRelatedOrderBy(String relationName,
                                   List<String> orderBy,
                                   GenericValue value)
                                     throws GenericEntityException

Throws:

GenericEntityException

getRelated

List<GenericValue> getRelated(String relationName,
                            Map<String,?> byAndFields,
                            List<String> orderBy,
                            GenericValue value)
                              throws GenericEntityException

Throws:

GenericEntityException

getRelatedDummyPK

GenericPK getRelatedDummyPK(String relationName,
                          Map<String,?> byAndFields,
                          GenericValue value)
                            throws GenericEntityException

Throws:

GenericEntityException

getRelatedCache

List<GenericValue> getRelatedCache(String relationName,
                                 GenericValue value)
                                   throws GenericEntityException

Throws:

GenericEntityException

getRelatedOne

GenericValue getRelatedOne(String relationName,
                         GenericValue value)
                           throws GenericEntityException

Throws:

GenericEntityException

getRelatedOneCache

GenericValue getRelatedOneCache(String relationName,
                              GenericValue value)
                                throws GenericEntityException

Throws:

GenericEntityException

removeRelated

int removeRelated(String relationName,
                GenericValue value)
                  throws GenericEntityException

Throws:

GenericEntityException

removeRelated

int removeRelated(String relationName,
                GenericValue value,
                boolean doCacheClear)
                  throws GenericEntityException

Throws:

GenericEntityException

refresh

void refresh(GenericValue value)
             throws GenericEntityException

Throws:

GenericEntityException

refresh

void refresh(GenericValue value,
           boolean doCacheClear)
             throws GenericEntityException

Throws:

GenericEntityException

store

int store(GenericValue value)
          throws GenericEntityException

Throws:

GenericEntityException

store

int store(GenericValue value,
        boolean doCacheClear)
          throws GenericEntityException

Throws:

GenericEntityException

storeAll

int storeAll(List<? extends GenericValue> values)
             throws GenericEntityException

Throws:

GenericEntityException

storeAll

int storeAll(List<? extends GenericValue> values,
           boolean doCacheClear)
             throws GenericEntityException

Throws:

GenericEntityException

removeAll

int removeAll(List<? extends GenericEntity> dummyPKs)
              throws GenericEntityException

Throws:

GenericEntityException

removeAll

int removeAll(List<? extends GenericEntity> dummyPKs,
            boolean doCacheClear)
              throws GenericEntityException

Throws:

GenericEntityException

clearAllCaches

void clearAllCaches()

clearAllCaches

void clearAllCaches(boolean distribute)

clearCacheLine

void clearCacheLine(String entityName,
                  Map<String,?> fields)

clearCacheLineFlexible

void clearCacheLineFlexible(GenericEntity dummyPK)

clearCacheLineFlexible

void clearCacheLineFlexible(GenericEntity dummyPK,
                          boolean distribute)

clearCacheLine

void clearCacheLine(GenericPK primaryKey)

clearCacheLine

void clearCacheLine(GenericPK primaryKey,
                  boolean distribute)

clearCacheLine

void clearCacheLine(GenericValue value)

clearCacheLine

void clearCacheLine(GenericValue value,
                  boolean distribute)

getFieldNameSetsCopy

Set<Set<String>> getFieldNameSetsCopy(String entityName)

clearAllCacheLinesByDummyPK

void clearAllCacheLinesByDummyPK(Collection<? extends GenericEntity> dummyPKs)

clearAllCacheLinesByValue

void clearAllCacheLinesByValue(Collection<? extends GenericValue> values)

getFromPrimaryKeyCache

GenericValue getFromPrimaryKeyCache(GenericPK primaryKey)

getFromAllCache

List<GenericValue> getFromAllCache(String entityName)

getFromAndCache

List<GenericValue> getFromAndCache(String entityName,
                                 Map<String,?> fields)

getFromAndCache

List<GenericValue> getFromAndCache(ModelEntity entity,
                                 Map<String,?> fields)

putInPrimaryKeyCache

void putInPrimaryKeyCache(GenericPK primaryKey,
                        GenericValue value)

putAllInPrimaryKeyCache

void putAllInPrimaryKeyCache(List<? extends GenericValue> values)

putInAllCache

void putInAllCache(String entityName,
                 List<? extends GenericValue> values)

putInAllCache

void putInAllCache(ModelEntity entity,
                 List<? extends GenericValue> values)

putInAndCache

void putInAndCache(String entityName,
                 Map<String,?> fields,
                 List<? extends GenericValue> values)

putInAndCache

void putInAndCache(ModelEntity entity,
                 Map<String,?> fields,
                 List<? extends GenericValue> values)

getNextSeqId

Long getNextSeqId(String seqName)

setSequencer

void setSequencer(SequenceUtil sequencer)

refreshSequencer

void refreshSequencer()

getPrimaryKeyCache

UtilCache<GenericEntity,GenericValue> getPrimaryKeyCache()

getAndCache

UtilCache<GenericPK,List<GenericValue>> getAndCache()

getAllCache

UtilCache<String,List<GenericValue>> getAllCache()

transform

List<GenericValue> transform(String entityName,
                           EntityCondition entityCondition,
                           List<String> orderBy,
                           String lockField,
                           Transformation transformation)
                             throws GenericEntityException

Applies the given transformation to any entities matching the given condition.

Parameters:

entityName - the type of entity to transform (required)

entityCondition - the condition that selects the entities to transform (null means transform all)

orderBy - the order in which the entities should be selected for updating (null means no ordering)

lockField - the entity field to use for optimistic locking; the value of this field will be read between the SELECT and the UPDATE to determine whether another process has updated one of the target records in the meantime; if so, the transformation will be reapplied and another UPDATE attempted

transformation - the transformation to apply (required)

Returns:

the transformed entities in the order they were selected (never null)

Throws:

GenericEntityException

Since:

1.0.41