Package org.cyclos.impl.system

Class CustomOperationServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>

org.cyclos.impl.system.CustomOperationServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,Void>, CustomOperationServiceLocal, CRUDService<CustomOperationDTO,CustomOperationData,Void>, CRUDWithConfirmationPasswordService<CustomOperationDTO,CustomOperationData,Void>, Service, CustomOperationService

@Service
public class CustomOperationServiceImpl
extends CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>
implements CustomOperationServiceLocal

Implementation for CustomOperationService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomOperationServiceImpl.Action
static class	CustomOperationServiceImpl.ActionsContainer
class	CustomOperationServiceImpl.PageResultAdapter	Adapts the simple format for custom operations that returns result pages, supporting both simple format (headers / results) and complex format (columns / rows)

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.system.CustomOperationServiceLocal

ATTR_AD, ATTR_BULK_ACTION, ATTR_CONTACT, ATTR_CONTACT_INFO, ATTR_CONTAINER_CUSTOM_OPERATION, ATTR_CURRENT_PAGE, ATTR_CUSTOM_OPERATION, ATTR_EXECUTION, ATTR_EXPORT_FORMAT, ATTR_EXTERNAL_REDIRECT_EXECUTION, ATTR_FORM_PARAMETERS, ATTR_INPUT_FILE, ATTR_MENU_ITEM, ATTR_PAGE_CONTEXT, ATTR_PAGE_SIZE, ATTR_PARAMETER_STORAGE, ATTR_RECORD, ATTR_REQUEST, ATTR_RETURN_URL, ATTR_SCANNED_QR_CODE, ATTR_SKIP_TOTAL_COUNT, ATTR_STORAGE, ATTR_TRANSFER, ATTR_USER

Constructor Summary

Constructors

Constructor	Description
CustomOperationServiceImpl()

Method Summary

Modifier and Type	Method	Description
PasswordInputDTO	getConfirmationPasswordInputForRun(RunCustomOperationDataParams params)	Returns the PasswordInputDTO for the confirmation password that would be required if executing the given custom operation.
protected CustomOperationData	getData(CustomOperation customOperation)	Returns details data for the given entity
SimpleEntity	getRelatedEntity(RunCustomOperationDataParams params)	Returns the entity associated with the given RunCustomOperationDataParams
SimpleEntity	getRelatedEntity(RunCustomOperationDTO params)	Returns the entity associated with the given RunCustomOperationDTO
RunCustomOperationData	getRunData(RunCustomOperationDataParams params)	Returns data to run a custom operation.
List<CustomOperation>	getRunnableCustomOperationsForSystem()	Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
List<CustomOperation>	getRunnableOperationsForAd(BasicAd ad)	Returns the custom operations that can be run by the logged user over the given ad
List<RunnableCustomOperationVO>	getRunnableOperationsForAd(BasicAdVO vo)	Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement
List<CustomOperation>	getRunnableOperationsForBulkActions()	Returns the custom operations that can be run by the logged user as a bulk action
List<CustomOperation>	getRunnableOperationsForContact(Contact contact)	Returns the custom operations that can be run by the logged user over the given contact
List<RunnableCustomOperationVO>	getRunnableOperationsForContact(ContactVO contactVO)	Lists the user custom operations scope = CustomOperationScope.CONTACT the logged user can run over the given contact
List<CustomOperation>	getRunnableOperationsForContactInfo(ContactInfo contactInfo)	Returns the custom operations that can be run by the logged user over the given additional contact information
List<RunnableCustomOperationVO>	getRunnableOperationsForContactInfo(ContactInfoVO contactInfoVO)	Lists the user custom operations scope = CustomOperationScope.CONTACT_INFO the logged user can run over the given additional contact information
List<CustomOperation>	getRunnableOperationsForMenu()	Returns the custom operations which can be run as menu items for the current session
List<CustomOperation>	getRunnableOperationsForRecord(Record record)	Returns the custom operations that can be run by the logged user over the given record
List<RunnableCustomOperationVO>	getRunnableOperationsForRecord(RecordVO vo)	Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record
List<RunnableCustomOperationVO>	getRunnableOperationsForSystem()	Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
List<CustomOperation>	getRunnableOperationsForTransfer(Transfer transfer)	Returns the custom operations that can be run by the logged user over the given transfer
List<RunnableCustomOperationVO>	getRunnableOperationsForTransfer(TransferVO vo)	Lists the custom operations with scope = CustomOperationScope.TRANSFER the logged user can run over the given transfer
List<CustomOperation>	getRunnableOperationsForUser(User user)	Returns the custom operations that can be run by the logged user as a user action
List<RunnableCustomOperationVO>	getRunnableOperationsForUser(UserLocatorVO locator)	Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)
List<CustomOperationResultVO>	list()	Lists all available custom operations
List<CustomOperation>	listAllowedToRun()	Lists all custom operations the logged user is allowed to run
List<CustomOperation>	listByScope(CustomOperationScope... scopes)	Lists the custom operations for the given scopes
List<CustomOperation>	listOperationsRedirectingTo(CustomOperation internal)	Lists the custom operations that use the given internal operation, either as row action or as action
List<CustomOperation>	listWithRecordScope(RecordTypeNature... natures)	Lists the custom operations with scope record configured with at least one record type of the given nature(s)
CustomOperation	newEntity(Void params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(CustomOperation entity)	May be overridden in order to perform custom logic after removing an entity
protected Object	onBeforeSave(CustomOperation operation, CustomOperation currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	preProcessCurrentCopy(CustomOperationDTO dto, CustomOperation currentCopy)	This method is invoked before saving the entity and also, if the log is enabled, before removing.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
CustomOperation	resolveCustomOperation(SimpleEntity entity, CustomOperationVO customOperation)	Returns the custom operation associated to the given entity if corresponds.
protected Validator	resolveValidator(CustomOperationDTO dto)
RunCustomOperationResult	run(RunCustomOperationDTO params)	Runs a custom operation, returning the result with all type information
RunCustomOperationResult	runExternalRedirectCallback(RunExternalRedirectCallbackParams params)	Runs the callback for a custom operation of type external redirect.
BulkActionUserResult	runForBulkAction(BulkActionUser bulkActionUser)	Runs the custom operation for a bulk action execution
void	setMissingFormParameters(RunnableCustomOperationVO runnable, CustomOperation customOperation)	Sets to RunnableCustomOperationVO.MISSING_REQUIRED_PARAMETERS the list of all required parameter and to RunnableCustomOperationVO.MISSING_OPTIONAL_PARAMETERS all the optional ones from the given CustomOperation

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterSave, onBeforeRemove, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, toDTO, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.system.CustomOperationService

saveOrder

Constructor Detail

CustomOperationServiceImpl

public CustomOperationServiceImpl()

Method Detail

getConfirmationPasswordInputForRun

public PasswordInputDTO getConfirmationPasswordInputForRun(RunCustomOperationDataParams params)

Description copied from interface: CustomOperationService

Returns the PasswordInputDTO for the confirmation password that would be required if executing the given custom operation.

Specified by:

getConfirmationPasswordInputForRun in interface CustomOperationService

getRelatedEntity

public SimpleEntity getRelatedEntity(RunCustomOperationDataParams params)

Description copied from interface: CustomOperationServiceLocal

Returns the entity associated with the given RunCustomOperationDataParams

Specified by:

getRelatedEntity in interface CustomOperationServiceLocal

getRelatedEntity

public SimpleEntity getRelatedEntity(RunCustomOperationDTO params)

Description copied from interface: CustomOperationServiceLocal

Returns the entity associated with the given RunCustomOperationDTO

Specified by:

getRelatedEntity in interface CustomOperationServiceLocal

getRunData

public RunCustomOperationData getRunData(RunCustomOperationDataParams params)

Description copied from interface: CustomOperationService

Returns data to run a custom operation. Depending on the custom operation scope, the input parameters must be a subclass of RunCustomOperationDataParams with the specific parmeters set (for example, a RunRecordCustomOperationDataParams with the record set if the scope is CustomOperationScope.RECORD) The result will also be a subclass of RunCustomOperationData depending on the custom operation scope, for example a RunRecordCustomOperationData.

Specified by:

getRunData in interface CustomOperationService

getRunnableCustomOperationsForSystem

public List<CustomOperation> getRunnableCustomOperationsForSystem()

Description copied from interface: CustomOperationServiceLocal

Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run

Specified by:

getRunnableCustomOperationsForSystem in interface CustomOperationServiceLocal

getRunnableOperationsForAd

public List<CustomOperation> getRunnableOperationsForAd(BasicAd ad)

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations that can be run by the logged user over the given ad

Specified by:

getRunnableOperationsForAd in interface CustomOperationServiceLocal

getRunnableOperationsForAd

public List<RunnableCustomOperationVO> getRunnableOperationsForAd(BasicAdVO vo)
                                                           throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement

Specified by:

getRunnableOperationsForAd in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForBulkActions

public List<CustomOperation> getRunnableOperationsForBulkActions()

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations that can be run by the logged user as a bulk action

Specified by:

getRunnableOperationsForBulkActions in interface CustomOperationServiceLocal

getRunnableOperationsForContact

public List<CustomOperation> getRunnableOperationsForContact(Contact contact)

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations that can be run by the logged user over the given contact

Specified by:

getRunnableOperationsForContact in interface CustomOperationServiceLocal

getRunnableOperationsForContact

public List<RunnableCustomOperationVO> getRunnableOperationsForContact(ContactVO contactVO)
                                                                throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.CONTACT the logged user can run over the given contact

Specified by:

getRunnableOperationsForContact in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForContactInfo

public List<CustomOperation> getRunnableOperationsForContactInfo(ContactInfo contactInfo)

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations that can be run by the logged user over the given additional contact information

Specified by:

getRunnableOperationsForContactInfo in interface CustomOperationServiceLocal

getRunnableOperationsForContactInfo

public List<RunnableCustomOperationVO> getRunnableOperationsForContactInfo(ContactInfoVO contactInfoVO)
                                                                    throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.CONTACT_INFO the logged user can run over the given additional contact information

Specified by:

getRunnableOperationsForContactInfo in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForMenu

public List<CustomOperation> getRunnableOperationsForMenu()
                                                   throws FrameworkException

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations which can be run as menu items for the current session

Specified by:

getRunnableOperationsForMenu in interface CustomOperationServiceLocal

Throws:

FrameworkException

getRunnableOperationsForRecord

public List<CustomOperation> getRunnableOperationsForRecord(Record record)

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations that can be run by the logged user over the given record

Specified by:

getRunnableOperationsForRecord in interface CustomOperationServiceLocal

getRunnableOperationsForRecord

public List<RunnableCustomOperationVO> getRunnableOperationsForRecord(RecordVO vo)
                                                               throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record

Specified by:

getRunnableOperationsForRecord in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForSystem

public List<RunnableCustomOperationVO> getRunnableOperationsForSystem()
                                                               throws FrameworkException

Description copied from interface: CustomOperationService

Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run

Specified by:

getRunnableOperationsForSystem in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForTransfer

public List<CustomOperation> getRunnableOperationsForTransfer(Transfer transfer)

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations that can be run by the logged user over the given transfer

Specified by:

getRunnableOperationsForTransfer in interface CustomOperationServiceLocal

getRunnableOperationsForTransfer

public List<RunnableCustomOperationVO> getRunnableOperationsForTransfer(TransferVO vo)
                                                                 throws FrameworkException

Description copied from interface: CustomOperationService

Lists the custom operations with scope = CustomOperationScope.TRANSFER the logged user can run over the given transfer

Specified by:

getRunnableOperationsForTransfer in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForUser

public List<CustomOperation> getRunnableOperationsForUser(User user)

Description copied from interface: CustomOperationServiceLocal

Returns the custom operations that can be run by the logged user as a user action

Specified by:

getRunnableOperationsForUser in interface CustomOperationServiceLocal

getRunnableOperationsForUser

public List<RunnableCustomOperationVO> getRunnableOperationsForUser(UserLocatorVO locator)
                                                             throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)

Specified by:

getRunnableOperationsForUser in interface CustomOperationService

Throws:

FrameworkException

list

public List<CustomOperationResultVO> list()
                                   throws FrameworkException

Description copied from interface: CustomOperationService

Lists all available custom operations

Specified by:

list in interface CustomOperationService

Throws:

FrameworkException

listAllowedToRun

public List<CustomOperation> listAllowedToRun()

Description copied from interface: CustomOperationServiceLocal

Lists all custom operations the logged user is allowed to run

Specified by:

listAllowedToRun in interface CustomOperationServiceLocal

listByScope

public List<CustomOperation> listByScope(CustomOperationScope... scopes)
                                  throws FrameworkException

Description copied from interface: CustomOperationServiceLocal

Lists the custom operations for the given scopes

Specified by:

listByScope in interface CustomOperationServiceLocal

Throws:

FrameworkException

listOperationsRedirectingTo

public List<CustomOperation> listOperationsRedirectingTo(CustomOperation internal)

Description copied from interface: CustomOperationServiceLocal

Lists the custom operations that use the given internal operation, either as row action or as action

Specified by:

listOperationsRedirectingTo in interface CustomOperationServiceLocal

listWithRecordScope

public List<CustomOperation> listWithRecordScope(RecordTypeNature... natures)
                                          throws FrameworkException

Description copied from interface: CustomOperationServiceLocal

Lists the custom operations with scope record configured with at least one record type of the given nature(s)

Specified by:

listWithRecordScope in interface CustomOperationServiceLocal

Throws:

FrameworkException

newEntity

public CustomOperation newEntity(Void params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,Void>

Specified by:

newEntity in class CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>

resolveCustomOperation

public CustomOperation resolveCustomOperation(SimpleEntity entity,
                                              CustomOperationVO customOperation)

Description copied from interface: CustomOperationServiceLocal

Returns the custom operation associated to the given entity if corresponds. Otherwise, the conversion of the given customOperationVO

Specified by:

resolveCustomOperation in interface CustomOperationServiceLocal

run

public RunCustomOperationResult run(RunCustomOperationDTO params)
                             throws FrameworkException

Description copied from interface: CustomOperationService

Runs a custom operation, returning the result with all type information

Specified by:

run in interface CustomOperationService

Throws:

FrameworkException

runExternalRedirectCallback

public RunCustomOperationResult runExternalRedirectCallback(RunExternalRedirectCallbackParams params)
                                                     throws FrameworkException

Description copied from interface: CustomOperationService

Runs the callback for a custom operation of type external redirect. The result is currently always sent with result type = CustomOperationResultType.NOTIFICATION.

Specified by:

runExternalRedirectCallback in interface CustomOperationService

Throws:

FrameworkException

runForBulkAction

public BulkActionUserResult runForBulkAction(BulkActionUser bulkActionUser)

Description copied from interface: CustomOperationServiceLocal

Runs the custom operation for a bulk action execution

Specified by:

runForBulkAction in interface CustomOperationServiceLocal

setMissingFormParameters

public void setMissingFormParameters(RunnableCustomOperationVO runnable,
                                     CustomOperation customOperation)

Description copied from interface: CustomOperationServiceLocal

Sets to RunnableCustomOperationVO.MISSING_REQUIRED_PARAMETERS the list of all required parameter and to RunnableCustomOperationVO.MISSING_OPTIONAL_PARAMETERS all the optional ones from the given CustomOperation

Specified by:

setMissingFormParameters in interface CustomOperationServiceLocal

getData

protected CustomOperationData getData(CustomOperation customOperation)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>

onAfterRemove

protected void onAfterRemove(CustomOperation entity)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after removing an entity

Overrides:

onAfterRemove in class CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>

onBeforeSave

protected Object onBeforeSave(CustomOperation operation,
                              CustomOperation currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>

preProcessCurrentCopy

protected void preProcessCurrentCopy(CustomOperationDTO dto,
                                     CustomOperation currentCopy)

Description copied from class: CRUDServiceImpl

This method is invoked before saving the entity and also, if the log is enabled, before removing. Subclasses can override it to fetch lazy relationships, etc as the current copy will be detached. In case of removing (i.e the log is enabled for this entity) the dto parameter will be null.

Overrides:

preProcessCurrentCopy in class CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(CustomOperationDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<CustomOperation,QCustomOperation,CustomOperationDTO,CustomOperationData,Void>