Interface ModelService
-
- All Known Implementing Classes:
AbstractModelService
,DefaultModelService
,MockModelService
,SAPB2BModelService
public interface ModelService
Central point of model management. Manages the creation, loading and writing of models.- Since:
- 4.0
- Spring Bean ID:
- modelService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
attach(java.lang.Object model)
Attaches a model instance to the current model context.void
clearTransactionsSettings()
Clears any local transactions settings set byenableTransactions()
ordisableTransactions()
methods which influences onsave
operations.<T> T
clone(java.lang.Object original, java.lang.Class<T> targetType)
Creates a deep copy of the given model except that the result object type may be changed here.<T> T
clone(java.lang.Object original, java.lang.Class<T> targetType, ModelCloningContext ctx)
Creates a deep copy of the given model except that the result object type may be changed here.<T> T
clone(T original)
Creates a deep copy of the given model.<T> T
clone(T original, ModelCloningContext ctx)
Creates a deep copy of the given model.<T> T
create(java.lang.Class modelClass)
Creates a new empty model instance of those class which is registered for given type model.<T> T
create(java.lang.String typeCode)
Creates a new empty model instance of those class which is registered for given type code.void
detach(PK sourcePK)
Removes a model instance from the current model context.void
detach(java.lang.Object model)
Removes a model instance from the current model context.void
detachAll()
Removes all model instances attached to the current model context.void
disableTransactions()
Disables transactions for save operation.void
enableTransactions()
Enables transactions for save operation.<T> T
get(PK sourcePK)
Returns a model instance for the source object the given pk represents.<T> T
get(java.lang.Object source)
Returns a model instance for the given source object.<T> T
get(java.lang.Object source, java.lang.String conversionType)
Special loading method, which allows to specify the type for looking up the converter to be used.<T extends java.util.Collection>
TgetAll(java.util.Collection<? extends java.lang.Object> sources, T result)
Convenience method to load all objects in a source collection and adding the loaded objects to a result collection.<T extends java.util.Collection>
TgetAll(java.util.Collection<? extends java.lang.Object> sources, T result, java.lang.String conversionType)
Convenience method to load all objects in a source collection and adding the loaded objects to a result collection.<T extends java.util.Collection>
TgetAllSources(java.util.Collection<? extends java.lang.Object> models, T result)
Convenience method to load all the sources of a given collection of models<T> T
getAttributeValue(java.lang.Object model, java.lang.String attributeQualifier)
Generic attribute value getter to read attribute data from arbitrary model instances.<T> T
getAttributeValue(java.lang.Object model, java.lang.String attributeQualifier, java.util.Locale locale)
Generic attribute value getter to read attribute data for given Locale from arbitrary model instances.<T> java.util.Map<java.util.Locale,T>
getAttributeValues(java.lang.Object model, java.lang.String attributeQualifier, java.util.Locale... locales)
Generic attribute value getter to read attribute data for given list of Locales from arbitrary model instances.<T> T
getByExample(T example)
Deprecated.since 6.1.0 - Please useFlexibleSearchService.getModelByExample(Object)
.java.lang.String
getModelType(java.lang.Class modelClass)
Returns the type mapped to a model class.java.lang.String
getModelType(java.lang.Object model)
Returns the actual type of a given model instance.java.lang.Class
getModelTypeClass(java.lang.Class modelClass)
If the given class is a model class the mapped jalo class will be returned.<T> T
getSource(java.lang.Object model)
Returns underlying source for given model.<T> T
getWithLock(java.lang.Object source)
Lock jalo item and wrap it into model.void
initDefaults(java.lang.Object model)
Initializes newly created model instance.boolean
isAttached(java.lang.Object model)
Tells if the model is attached to the contextboolean
isModified(java.lang.Object model)
Tells if the model has been modified.boolean
isNew(java.lang.Object model)
Tells if the model has been created and has not been saved yet.boolean
isRemoved(java.lang.Object model)
Tells if the model has been removed.boolean
isSourceAttached(java.lang.Object source)
boolean
isUniqueConstraintErrorAsRootCause(java.lang.Exception e)
Checks whether the root cause of the given exception is the database rejecting a new item due to some unique key constraint violation.boolean
isUpToDate(java.lang.Object model)
Checks if the given model represents the current persistent state of its source.void
lock(PK itemPK)
Lock item with given PK in for changes.void
lock(java.lang.Object source)
Lock jalo item for changes.void
refresh(java.lang.Object model)
Requests the persistence layer to fetch a new, updated version of the passed model.void
remove(PK pk)
Tries to remove the source belonging to the specified PK.void
remove(java.lang.Object model)
Tries to remove the source (and all part-of elements) of the given model.void
removeAll(java.lang.Object... models)
Tries to remove the source (and all part-of elements) of the given collection of models.void
removeAll(java.util.Collection<? extends java.lang.Object> models)
Tries to remove the source (and all part-of elements) of the given collection of models.void
save(java.lang.Object model)
Saves all attribute values from the model to the wrapped source object or creates a new one if no source is mapped yet.void
saveAll()
Saves all modified and new model instances which are attached to the current request context.void
saveAll(java.lang.Object... models)
Saves several model model instances at once.void
saveAll(java.util.Collection<? extends java.lang.Object> models)
Saves several model model instances at once.void
setAttributeValue(java.lang.Object model, java.lang.String attributeQualifier, java.lang.Object value)
Generic attribute value setter to modify attribute data on arbitrary model instances.<T> void
setAttributeValue(java.lang.Object model, java.lang.String attributeQualifier, java.util.Map<java.util.Locale,T> value)
Generic attribute value setter to modify attribute data on arbitrary model instances for a given Locale.<T> T
toModelLayer(java.lang.Object persistentValue)
Converts arbitrary values into a representation to be used inside the model layer.<T> T
toPersistenceLayer(java.lang.Object modelValue)
Converts arbitrary model layer values into a form which may be used in persistence layer.
-
-
-
Method Detail
-
attach
void attach(java.lang.Object model)
Attaches a model instance to the current model context. This is necessary for all models being created manually using their constructors. This context keeps track of all models being loaded, created or modified. There is a single context per thread/request. Loading models for the same source element multiple times will return a single model instance inside one context (thread/request).- Parameters:
model
- the model instance to attach- Throws:
java.lang.IllegalStateException
- if the current context already holds a model for the same source element
-
detach
void detach(java.lang.Object model)
Removes a model instance from the current model context. Afterward it will no longer be saved automatically viasaveAll()
. Please note that loading a model for its source again results in a new instance being attached to the context! This context keeps track of all models being loaded, created or modified. There is a single context per thread/request. Loading models for the same source element multiple times will return a single model instance inside one context (thread/request).- Parameters:
model
- the model instance to detach
-
detach
void detach(PK sourcePK)
Removes a model instance from the current model context. Afterward it will no longer be saved automatically viasaveAll()
. Please note that loading a model for its source again results in a new instance being attached to the context! This context keeps track of all models being loaded, created or modified. There is a single context per thread/request. Loading models for the same source element multiple times will return a single model instance inside one context (thread/request).- Parameters:
sourcePK
- the source primary key belonging to the model to be detached
-
detachAll
void detachAll()
Removes all model instances attached to the current model context. Afterward they will no longer be saved automatically viasaveAll()
. Also note that loading models for their sources again results in new instances being attached to the context!
-
clone
<T> T clone(T original)
Creates a deep copy of the given model. The resulting object is not persisted yet in order to allow modifications like unique key adjustments etc.
-
clone
<T> T clone(java.lang.Object original, java.lang.Class<T> targetType)
Creates a deep copy of the given model except that the result object type may be changed here. Please note that only attributes that exist in both types are actually copied! The resulting object is not persisted yet in order to allow modifications like unique key adjustments etc.
-
clone
<T> T clone(T original, ModelCloningContext ctx)
Creates a deep copy of the given model. The resulting object is not persisted yet in order to allow modifications like unique key adjustments etc. The optional context allows to adjust the cloning process in some aspects. SeeModelCloningContext
for details.
-
clone
<T> T clone(java.lang.Object original, java.lang.Class<T> targetType, ModelCloningContext ctx)
Creates a deep copy of the given model except that the result object type may be changed here. Please note that only attributes that exist in both types are actually copied! The resulting object is not persisted yet in order to allow modifications like unique key adjustments etc. The optional context allows to adjust the cloning process in some aspects. SeeModelCloningContext
for details.
-
create
<T> T create(java.lang.Class modelClass)
Creates a new empty model instance of those class which is registered for given type model.- Parameters:
modelClass
- the model class to create a new instance of- Returns:
- new empty model
-
create
<T> T create(java.lang.String typeCode)
Creates a new empty model instance of those class which is registered for given type code.- Parameters:
typeCode
- type code whose registered model implementation will be used for instantiation- Returns:
- new empty model
-
get
<T> T get(java.lang.Object source)
Returns a model instance for the given source object. It is tried to find a target class using the type of the source object.- Parameters:
source
- the object for which to retrieve a model instance- Returns:
- a model for the given source object
-
get
<T> T get(java.lang.Object source, java.lang.String conversionType)
Special loading method, which allows to specify the type for looking up the converter to be used. Normally there is no need to prefer this toget(Object)
- use with care!- Parameters:
source
- the persistent object to convertconversionType
- the type to use when looking up the converter
-
get
<T> T get(PK sourcePK)
Returns a model instance for the source object the given pk represents. It is tried to find a target class using the type of the source object resolved from given PK.- Parameters:
sourcePK
- the object pk for which to retrieve a model instance- Returns:
- a model for the given source object pk
-
getAll
<T extends java.util.Collection> T getAll(java.util.Collection<? extends java.lang.Object> sources, T result)
Convenience method to load all objects in a source collection and adding the loaded objects to a result collection.- Parameters:
sources
- the objects for which to retrieve model instancesresult
- the collection to add the model instances to- Returns:
- the result collects
- See Also:
get(Object)
-
getAll
<T extends java.util.Collection> T getAll(java.util.Collection<? extends java.lang.Object> sources, T result, java.lang.String conversionType)
Convenience method to load all objects in a source collection and adding the loaded objects to a result collection. This method allows to specify the type to lookup the converter!- Parameters:
sources
- the objects for which to retrieve model instancesresult
- the collection to add the model instances toconversionType
- the type to be used for looking up the model converter- Returns:
- the result collects
- See Also:
get(Object)
-
refresh
void refresh(java.lang.Object model)
Requests the persistence layer to fetch a new, updated version of the passed model.- Parameters:
model
- model to be updated
-
save
void save(java.lang.Object model) throws ModelSavingException
Saves all attribute values from the model to the wrapped source object or creates a new one if no source is mapped yet.- Parameters:
model
- the model to save- Throws:
ModelSavingException
- if the save operation failed- See Also:
saveAll(Collection)
-
saveAll
void saveAll(java.util.Collection<? extends java.lang.Object> models) throws ModelSavingException
Saves several model model instances at once. If at least one instance causes a validation error no modifications are written.- Parameters:
models
- the model instances to save- Throws:
ModelSavingException
- See Also:
save(Object)
-
saveAll
void saveAll(java.lang.Object... models) throws ModelSavingException
Saves several model model instances at once. If at least one instance causes a validation error no modifications are written.- Parameters:
models
- the model instances to save- Throws:
ModelSavingException
- See Also:
save(Object)
-
saveAll
void saveAll() throws ModelSavingException
Saves all modified and new model instances which are attached to the current request context. A model becomes attached if- it has been loaded
- it has been created
- it has been attached explicitly via
attach(Object)
- Throws:
ModelSavingException
-
isUniqueConstraintErrorAsRootCause
boolean isUniqueConstraintErrorAsRootCause(java.lang.Exception e)
Checks whether the root cause of the given exception is the database rejecting a new item due to some unique key constraint violation.
-
remove
void remove(java.lang.Object model) throws ModelRemovalException
Tries to remove the source (and all part-of elements) of the given model.- Parameters:
model
- the model for which to remove the source- Throws:
ModelRemovalException
- if the remove action failed
-
removeAll
void removeAll(java.util.Collection<? extends java.lang.Object> models) throws ModelRemovalException
Tries to remove the source (and all part-of elements) of the given collection of models.- Parameters:
models
- the models for which to remove the source- Throws:
ModelRemovalException
- if the remove action failed
-
removeAll
void removeAll(java.lang.Object... models) throws ModelRemovalException
Tries to remove the source (and all part-of elements) of the given collection of models.- Parameters:
models
- the models for which to remove the source- Throws:
ModelRemovalException
- if the remove action failed
-
remove
void remove(PK pk) throws ModelRemovalException
Tries to remove the source belonging to the specified PK.- Parameters:
pk
- the primary key of the source to remove- Throws:
ModelRemovalException
- if the remove action failed
-
getSource
<T> T getSource(java.lang.Object model)
Returns underlying source for given model.- Parameters:
model
- the model for which to return the source- Returns:
- the underlying source of the given model, or null if the source doesn't (yet) exist
-
getAllSources
<T extends java.util.Collection> T getAllSources(java.util.Collection<? extends java.lang.Object> models, T result)
Convenience method to load all the sources of a given collection of models- Parameters:
models
- the objects for which to retrieve model instancesresult
- the collection to add the model instances to- Returns:
- the result collects
- Throws:
ModelValidationException
- in case of a validation error
-
getModelType
java.lang.String getModelType(java.lang.Class modelClass)
Returns the type mapped to a model class.- Parameters:
modelClass
- the model class
-
getModelTypeClass
java.lang.Class getModelTypeClass(java.lang.Class modelClass)
If the given class is a model class the mapped jalo class will be returned. Otherwise the same class is returned.- Parameters:
modelClass
- a model class- Returns:
- the mapped jalo class
-
getModelType
java.lang.String getModelType(java.lang.Object model)
Returns the actual type of a given model instance.- Parameters:
model
- the model instance
-
toModelLayer
<T> T toModelLayer(java.lang.Object persistentValue)
Converts arbitrary values into a representation to be used inside the model layer. Generally this converts all object with existing model converter into their model representation. Collections and maps are copied on demand. Any other objects stay unchanged.- Parameters:
persistentValue
- the value loaded from persistence layer.
-
toPersistenceLayer
<T> T toPersistenceLayer(java.lang.Object modelValue)
Converts arbitrary model layer values into a form which may be used in persistence layer. Generally this converts all models back into their source. Collections and maps are copied on demand. Any other objects stay unchanged.- Parameters:
modelValue
- the value to be translated back into persistence layer form- Throws:
java.lang.IllegalStateException
- if models are found which do not have a persistence representation (yet) - be sure to save all models before converting them!
-
initDefaults
void initDefaults(java.lang.Object model) throws ModelInitializationException
Initializes newly created model instance.ModelService s = ... // create plain instance - no defaults whatsoever ProductModel myModel = new ProductModel(); // now load defaults s.initDefaults( myModel );
- Parameters:
model
-- Throws:
ModelInitializationException
-
getAttributeValue
<T> T getAttributeValue(java.lang.Object model, java.lang.String attributeQualifier)
Generic attribute value getter to read attribute data from arbitrary model instances. If attribute is localized value for current Locale is returned.- Parameters:
model
- the model instanceattributeQualifier
- the attribute qualifier
-
getAttributeValue
<T> T getAttributeValue(java.lang.Object model, java.lang.String attributeQualifier, java.util.Locale locale)
Generic attribute value getter to read attribute data for given Locale from arbitrary model instances.- Type Parameters:
T
-- Parameters:
model
- the model instanceattributeQualifier
- the attribute qualifier for which value must be returnedlocale
- the locale for which value must be returned- Throws:
java.lang.IllegalArgumentException
- when value cannot be find for given localejava.lang.NullPointerException
- when model, attributeQualifier or locale is null
-
getAttributeValues
<T> java.util.Map<java.util.Locale,T> getAttributeValues(java.lang.Object model, java.lang.String attributeQualifier, java.util.Locale... locales)
Generic attribute value getter to read attribute data for given list of Locales from arbitrary model instances. This method returns immutable map of values mapped to the corresponding locale. If none of the values for a given locale can be found, an empty map will be returned.- Type Parameters:
T
-- Parameters:
model
- the model instanceattributeQualifier
- the attribute qualifier for which value must be returnedlocales
- Locales for which value must be returned (at least one locale is required)- Returns:
- immutable map of values mapped to the corresponding Locale
- Throws:
java.lang.NullPointerException
- when model, attributeQualifier or locale is null
-
setAttributeValue
void setAttributeValue(java.lang.Object model, java.lang.String attributeQualifier, java.lang.Object value)
Generic attribute value setter to modify attribute data on arbitrary model instances.- Parameters:
model
- the modelattributeQualifier
- the attribute qualifiervalue
- the attribute value- Throws:
java.lang.NullPointerException
- when model or attributeQualifier is null
-
setAttributeValue
<T> void setAttributeValue(java.lang.Object model, java.lang.String attributeQualifier, java.util.Map<java.util.Locale,T> value)
Generic attribute value setter to modify attribute data on arbitrary model instances for a given Locale.- Parameters:
model
- the model instanceattributeQualifier
- the attribute qualifier for which value must be returnedvalue
- map of values mapped to the corresponding Locale
-
isUpToDate
boolean isUpToDate(java.lang.Object model)
Checks if the given model represents the current persistent state of its source. It is considered to be up to date if- the model is not modified
- the model is not new
- a source exists for this model
- the persistence version of the source item is the same as stored inside the model
- Parameters:
model
- the model to check
-
isModified
boolean isModified(java.lang.Object model)
Tells if the model has been modified. This applies to models which have been create or modified after loading.- Parameters:
model
- the model to check
-
isNew
boolean isNew(java.lang.Object model)
Tells if the model has been created and has not been saved yet.- Parameters:
model
- the model to check
-
isRemoved
boolean isRemoved(java.lang.Object model)
Tells if the model has been removed.- Parameters:
model
- the model to check
-
isAttached
boolean isAttached(java.lang.Object model)
Tells if the model is attached to the context- Parameters:
model
- the model to check
-
isSourceAttached
boolean isSourceAttached(java.lang.Object source)
-
enableTransactions
void enableTransactions()
Enables transactions for save operation. This setting overrides the global setting and has higher priority. Enabling transactions is done via session (session key: "enableTransactionalSaves") so to make it temporary please use
SessionService.executeInLocalView(de.hybris.platform.servicelayer.session.SessionExecutionBody)
. If you are not planning use local session, please remove completely session key "enableTransactionalSaves" from the session to back to the global setting usingclearTransactionsSettings()
method.Global setting is controlled by property: model.service.transactional.saves
Example usage:
sessionService.executeInLocalView(new SessionExecutionBody() { @Override public Object execute() { modelService.enableTransactions(); modelService.save(someModel); return someModel; } });
-
disableTransactions
void disableTransactions()
Disables transactions for save operation. This setting overrides the global setting and has higher priority. Disabling transactions is done via session (session key: "enableTransactionalSaves") so to make it temporary please use
SessionService.executeInLocalView(de.hybris.platform.servicelayer.session.SessionExecutionBody)
. If you are not planning use local session, please remove completely session key "enableTransactionalSaves" from the session to back to the global setting usingclearTransactionsSettings()
method.Global setting is controlled by property: model.service.transactional.saves
Example usage:
sessionService.executeInLocalView(new SessionExecutionBody() { @Override public Object execute() { modelService.disableTransactions(); modelService.save(someModel); return someModel; } });
-
clearTransactionsSettings
void clearTransactionsSettings()
Clears any local transactions settings set byenableTransactions()
ordisableTransactions()
methods which influences onsave
operations. After executing this method global setting for transactions will be respected.
-
getByExample
@Deprecated <T> T getByExample(T example)
Deprecated.since 6.1.0 - Please useFlexibleSearchService.getModelByExample(Object)
.Search for an existing object (in the database) by a given (not saved) example. Every modified attribute in this example is used as search parameter.- Type Parameters:
T
- the type of the example and the return type- Parameters:
example
- the example- Returns:
- the result if this was found by the example.
- Throws:
ModelNotFoundException
- if nothing was foundAmbiguousIdentifierException
- if by the given searchparams to many models where found
-
lock
void lock(PK itemPK)
Lock item with given PK in for changes.Calls to
lock
can only be made between calls toTransaction.begin()
andTransaction.commit()
orTransaction.rollback()
. All locks that are acquired during a transaction are automatically released on calls toTransaction.commit()
orTransaction.rollback()
. If a lock is held by another transaction, this method will block until the lock can be acquired.- Parameters:
itemPK
- pk of the item to lock.
-
lock
void lock(java.lang.Object source)
Lock jalo item for changes. Source must not be null and should be type ofItem
.Calls to
lock
can only be made between calls toTransaction.begin()
andTransaction.commit()
orTransaction.rollback()
. All locks that are acquired during a transaction are automatically released on calls toTransaction.commit()
orTransaction.rollback()
. If a lock is held by another transaction, this method will block until the lock can be acquired.- Parameters:
source
- item to lock.
-
getWithLock
<T> T getWithLock(java.lang.Object source)
Lock jalo item and wrap it into model. Source must not be null and should be type ofItem
.Calls to
lock
can only be made between calls toTransaction.begin()
andTransaction.commit()
orTransaction.rollback()
. All locks that are acquired during a transaction are automatically released on calls toTransaction.commit()
orTransaction.rollback()
. If a lock is held by another transaction, this method will block until the lock can be acquired.- Type Parameters:
T
- Type of returned model.- Parameters:
source
- item to lock.- Returns:
- locked model for given source.
-
-