Package org.cyclos.impl.system

Interface ScriptHelper

All Known Implementing Classes:

ScriptHelperImpl

public interface ScriptHelper

Helper for script execution

Method Summary

Modifier and Type	Method	Description
void	addOnCommit(Runnable runnable)	Adds a listener to be executed when the main transaction commits, which is not executed in a database transaction
void	addOnCommitTransactional(Runnable runnable)	Adds a listener to be executed when the main transaction commits, which is executed inside a new transaction
void	addOnRollback(Runnable runnable)	Adds a listener to be executed when the main transaction rollbacks, which is not executed in a database transaction
void	addOnRollbackTransactional(Runnable runnable)	Adds a listener to be executed when the main transaction is rolled-back, which is executed inside a new transaction
<T> T	bean(Class<T> beanType)	Returns a bean by type
Object	bean(String name)	Returns a bean by short name.
ApplicationContext	getApplicationContext()	Returns the Spring application context
Map<String,Object>	getBeanMap()	Returns a Map with all beans accessible by bean(String)
Long	maskId(Object id)	Returns a value suitable to be sent to clients, which represents the given entity identifier
<T> long	processBatch(Iterable<T> iterable, Consumer<T> closure)	See QueryHelper#processBatch(CloseableIterator, Consumer, BaseEntityManagerHandler)
<T> long	processBatch(Iterator<T> iterator, Consumer<T> closure)	See QueryHelper#processBatch(CloseableIterator, Consumer, BaseEntityManagerHandler)
Long	unmaskId(Object id)	Returns a value suitable to be used on server side, given the argument is a masked identifier
Map<String,Object>	wrap(Object object)	Wraps an object in a Map, providing access to object properties as map keys.
Map<String,Object>	wrap(Object object, Collection<? extends CustomField<?,?,?>> customFields)	Same as wrap(Object), but providing an explicit custom fields collection, instead of trying to get from the object.

Method Detail

addOnCommit

void addOnCommit(Runnable runnable)

Adds a listener to be executed when the main transaction commits, which is not executed in a database transaction

addOnCommitTransactional

void addOnCommitTransactional(Runnable runnable)

Adds a listener to be executed when the main transaction commits, which is executed inside a new transaction

addOnRollback

void addOnRollback(Runnable runnable)

Adds a listener to be executed when the main transaction rollbacks, which is not executed in a database transaction

addOnRollbackTransactional

void addOnRollbackTransactional(Runnable runnable)

Adds a listener to be executed when the main transaction is rolled-back, which is executed inside a new transaction

bean

<T> T bean(Class<T> beanType)

Returns a bean by type

bean

Object bean(String name)

Returns a bean by short name. For example, userService returns the UserServiceLocal, invokerHandler returns InvokerHandler and so on.

getApplicationContext

ApplicationContext getApplicationContext()

Returns the Spring application context

getBeanMap

Map<String,Object> getBeanMap()

Returns a Map with all beans accessible by bean(String)

maskId

Long maskId(Object id)

Returns a value suitable to be sent to clients, which represents the given entity identifier

processBatch

<T> long processBatch(Iterable<T> iterable,
                      Consumer<T> closure)

See QueryHelper#processBatch(CloseableIterator, Consumer, BaseEntityManagerHandler)

processBatch

<T> long processBatch(Iterator<T> iterator,
                      Consumer<T> closure)

See QueryHelper#processBatch(CloseableIterator, Consumer, BaseEntityManagerHandler)

unmaskId

Long unmaskId(Object id)

Returns a value suitable to be used on server side, given the argument is a masked identifier

wrap

Map<String,Object> wrap(Object object)

Wraps an object in a Map, providing access to object properties as map keys. For objects with custom fields (that implement either ModelWithCustomValues or EntityWithCustomValues), custom fields can be accessed via the field internal name. So, for example, for a user, user.gender would return the CustomFieldPossibleValue, assuming it is an enumerated custom field.

wrap

Map<String,Object> wrap(Object object,
                              Collection<? extends CustomField<?,?,?>> customFields)

Same as wrap(Object), but providing an explicit custom fields collection, instead of trying to get from the object. Is useful, for example, when creating a new entity / DTO, when it doesn't yet have a list of custom values