All Superinterfaces:

CRUDService<CustomOperationDTO,CustomOperationData,Void>, CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,Void>, CustomOperationService, Service
```
public interface CustomOperationServiceLocal
extends CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,Void>, CustomOperationService
```
Local interface for CustomOperationService

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ATTR_AD`	Script attribute: the `BasicAd`
`static String`	`ATTR_BULK_ACTION`	Script attribute: the `BulkAction` being executed
`static String`	`ATTR_CONTACT`	Script attribute: the `Contact`
`static String`	`ATTR_CONTACT_INFO`	Script attribute: the `ContactInfo`
`static String`	`ATTR_CONTAINER_CUSTOM_OPERATION`	Script attribute: the `CustomOperation` which has actions
`static String`	`ATTR_CURRENT_PAGE`	Script attribute: the current page, used when the result type is page results
`static String`	`ATTR_CUSTOM_OPERATION`	Script attribute: the `CustomOperation`
`static String`	`ATTR_EXECUTION`	Script attribute: the `ExternalRedirectExecution` backing an `CustomOperationResultType.EXTERNAL_REDIRECT`
`static String`	`ATTR_EXPORT_FORMAT`	Script attribute: the `ExportFormat`
`static String`	`ATTR_EXTERNAL_REDIRECT_EXECUTION`	Alias to `ATTR_EXECUTION`
`static String`	`ATTR_FORM_PARAMETERS`	Script attribute: the form parameters (custom field values)
`static String`	`ATTR_INPUT_FILE`	Script attribute: the `FileInfo` for the uploaded file
`static String`	`ATTR_MENU_ITEM`	Script attribute: the `MenuItem`
`static String`	`ATTR_PAGE_CONTEXT`	Script attribute: the pageContext.
`static String`	`ATTR_PAGE_SIZE`	Script attribute: the page size, used when the result type is page results
`static String`	`ATTR_PARAMETER_STORAGE`	Script attribute: Alias for storage.
`static String`	`ATTR_RECORD`	Script attribute: the `Record`
`static String`	`ATTR_REQUEST`	Script attribute: the `RequestInfo` used on external redirect callback
`static String`	`ATTR_RETURN_URL`	Script attribute: the URL for the external service to call Cyclos and complete the operation, for `CustomOperationResultType.EXTERNAL_REDIRECT`
`static String`	`ATTR_SCANNED_QR_CODE`	Script attribute: the scanned QR-code used to submit the form
`static String`	`ATTR_SKIP_TOTAL_COUNT`	Script attribute: whether to ignore the total count on search
`static String`	`ATTR_STORAGE`	Script attribute: the `ObjectParameterStorage` used on operations of type external redirect, both on first execution and on the callback
`static String`	`ATTR_TRANSFER`	Script attribute: the `Transfer`
`static String`	`ATTR_USER`	Script attribute: the `User`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SimpleEntity`	`getRelatedEntity(RunCustomOperationDataParams params)`	Returns the entity associated with the given `RunCustomOperationDataParams`
`SimpleEntity`	`getRelatedEntity(RunCustomOperationDTO params)`	Returns the entity associated with the given `RunCustomOperationDTO`
`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<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<CustomOperation>`	`getRunnableOperationsForContactInfo(ContactInfo contactInfo)`	Returns the custom operations that can be run by the logged user over the given public 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<CustomOperation>`	`getRunnableOperationsForTransfer(Transfer transfer)`	Returns the custom operations that can be run by the logged user 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<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`	`resolveCustomOperation(SimpleEntity entity, CustomOperationVO customOperation)`	Returns the custom operation associated to the given entity if corresponds.
`BulkActionUserResult`	`runForBulkAction(BulkActionUser user)`	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 interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal
find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.system.CustomOperationService
getConfirmationPasswordInputForRun, getRunData, getRunnableOperationsForAd, getRunnableOperationsForContact, getRunnableOperationsForContactInfo, getRunnableOperationsForRecord, getRunnableOperationsForSystem, getRunnableOperationsForTransfer, getRunnableOperationsForUser, list, run, runExternalRedirectCallback, saveOrder

- Field Detail
  - ATTR_CUSTOM_OPERATION
```
static final String ATTR_CUSTOM_OPERATION
```
    Script attribute: the CustomOperation
    
    See Also:
    
    Constant Field Values
  - ATTR_CONTAINER_CUSTOM_OPERATION
```
static final String ATTR_CONTAINER_CUSTOM_OPERATION
```
    Script attribute: the CustomOperation which has actions
    
    See Also:
    
    Constant Field Values
  - ATTR_USER
```
static final String ATTR_USER
```
    Script attribute: the User
    
    See Also:
    
    Constant Field Values
  - ATTR_CONTACT
```
static final String ATTR_CONTACT
```
    Script attribute: the Contact
    
    See Also:
    
    Constant Field Values
  - ATTR_CONTACT_INFO
```
static final String ATTR_CONTACT_INFO
```
    Script attribute: the ContactInfo
    
    See Also:
    
    Constant Field Values
  - ATTR_AD
```
static final String ATTR_AD
```
    Script attribute: the BasicAd
    
    See Also:
    
    Constant Field Values
  - ATTR_RECORD
```
static final String ATTR_RECORD
```
    Script attribute: the Record
    
    See Also:
    
    Constant Field Values
  - ATTR_TRANSFER
```
static final String ATTR_TRANSFER
```
    Script attribute: the Transfer
    
    See Also:
    
    Constant Field Values
  - ATTR_MENU_ITEM
```
static final String ATTR_MENU_ITEM
```
    Script attribute: the MenuItem
    
    See Also:
    
    Constant Field Values
  - ATTR_INPUT_FILE
```
static final String ATTR_INPUT_FILE
```
    Script attribute: the FileInfo for the uploaded file
    
    See Also:
    
    Constant Field Values
  - ATTR_FORM_PARAMETERS
```
static final String ATTR_FORM_PARAMETERS
```
    Script attribute: the form parameters (custom field values)
    
    See Also:
    
    Constant Field Values
  - ATTR_SCANNED_QR_CODE
```
static final String ATTR_SCANNED_QR_CODE
```
    Script attribute: the scanned QR-code used to submit the form
    
    See Also:
    
    Constant Field Values
  - ATTR_REQUEST
```
static final String ATTR_REQUEST
```
    Script attribute: the RequestInfo used on external redirect callback
    
    See Also:
    
    Constant Field Values
  - ATTR_BULK_ACTION
```
static final String ATTR_BULK_ACTION
```
    Script attribute: the BulkAction being executed
    
    See Also:
    
    Constant Field Values
  - ATTR_STORAGE
```
static final String ATTR_STORAGE
```
    Script attribute: the ObjectParameterStorage used on operations of type external redirect, both on first execution and on the callback
    
    See Also:
    
    Constant Field Values
  - ATTR_PARAMETER_STORAGE
```
static final String ATTR_PARAMETER_STORAGE
```
    Script attribute: Alias for storage. Kept for compatibility.
    
    See Also:
    
    Constant Field Values
  - ATTR_RETURN_URL
```
static final String ATTR_RETURN_URL
```
    Script attribute: the URL for the external service to call Cyclos and complete the operation, for CustomOperationResultType.EXTERNAL_REDIRECT
    
    See Also:
    
    Constant Field Values
  - ATTR_EXECUTION
```
static final String ATTR_EXECUTION
```
    Script attribute: the ExternalRedirectExecution backing an CustomOperationResultType.EXTERNAL_REDIRECT
    
    See Also:
    
    Constant Field Values
  - ATTR_EXTERNAL_REDIRECT_EXECUTION
```
static final String ATTR_EXTERNAL_REDIRECT_EXECUTION
```
    Alias to ATTR_EXECUTION
    
    See Also:
    
    Constant Field Values
  - ATTR_CURRENT_PAGE
```
static final String ATTR_CURRENT_PAGE
```
    Script attribute: the current page, used when the result type is page results
    
    See Also:
    
    Constant Field Values
  - ATTR_PAGE_SIZE
```
static final String ATTR_PAGE_SIZE
```
    Script attribute: the page size, used when the result type is page results
    
    See Also:
    
    Constant Field Values
  - ATTR_SKIP_TOTAL_COUNT
```
static final String ATTR_SKIP_TOTAL_COUNT
```
    Script attribute: whether to ignore the total count on search
    
    See Also:
    
    Constant Field Values
  - ATTR_PAGE_CONTEXT
```
static final String ATTR_PAGE_CONTEXT
```
    Script attribute: the pageContext. This is actually deprecated, but is there to not break old scripts
    
    See Also:
    
    Constant Field Values
  - ATTR_EXPORT_FORMAT
```
static final String ATTR_EXPORT_FORMAT
```
    Script attribute: the ExportFormat
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getRelatedEntity
```
SimpleEntity getRelatedEntity(RunCustomOperationDataParams params)
```
    Returns the entity associated with the given RunCustomOperationDataParams
  - getRelatedEntity
```
SimpleEntity getRelatedEntity(RunCustomOperationDTO params)
```
    Returns the entity associated with the given RunCustomOperationDTO
  - getRunnableCustomOperationsForSystem
```
List<CustomOperation> getRunnableCustomOperationsForSystem()
```
    Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
  - getRunnableOperationsForAd
```
List<CustomOperation> getRunnableOperationsForAd(BasicAd ad)
```
    Returns the custom operations that can be run by the logged user over the given ad
  - getRunnableOperationsForBulkActions
```
List<CustomOperation> getRunnableOperationsForBulkActions()
```
    Returns the custom operations that can be run by the logged user as a bulk action
  - getRunnableOperationsForContact
```
List<CustomOperation> getRunnableOperationsForContact(Contact contact)
```
    Returns the custom operations that can be run by the logged user over the given contact
  - getRunnableOperationsForContactInfo
```
List<CustomOperation> getRunnableOperationsForContactInfo(ContactInfo contactInfo)
```
    Returns the custom operations that can be run by the logged user over the given public contact information
  - getRunnableOperationsForMenu
```
List<CustomOperation> getRunnableOperationsForMenu()
```
    Returns the custom operations which can be run as menu items for the current session
  - getRunnableOperationsForRecord
```
List<CustomOperation> getRunnableOperationsForRecord(Record record)
```
    Returns the custom operations that can be run by the logged user over the given record
  - getRunnableOperationsForTransfer
```
List<CustomOperation> getRunnableOperationsForTransfer(Transfer transfer)
```
    Returns the custom operations that can be run by the logged user over the given transfer
  - getRunnableOperationsForUser
```
List<CustomOperation> getRunnableOperationsForUser(User user)
```
    Returns the custom operations that can be run by the logged user as a user action
  - listAllowedToRun
```
List<CustomOperation> listAllowedToRun()
```
    Lists all custom operations the logged user is allowed to run
  - listByScope
```
List<CustomOperation> listByScope(CustomOperationScope... scopes)
```
    Lists the custom operations for the given scopes
  - listOperationsRedirectingTo
```
List<CustomOperation> listOperationsRedirectingTo(CustomOperation internal)
```
    Lists the custom operations that use the given internal operation, either as row action or as action
  - listWithRecordScope
```
List<CustomOperation> listWithRecordScope(RecordTypeNature... natures)
```
    Lists the custom operations with scope record configured with at least one record type of the given nature(s)
  - resolveCustomOperation
```
CustomOperation resolveCustomOperation(SimpleEntity entity,
                                       CustomOperationVO customOperation)
```
    Returns the custom operation associated to the given entity if corresponds. Otherwise, the conversion of the given customOperationVO
  - runForBulkAction
```
BulkActionUserResult runForBulkAction(BulkActionUser user)
```
    Runs the custom operation for a bulk action execution
  - setMissingFormParameters
```
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

Interface CustomOperationServiceLocal

Field Summary

Method Summary

Methods inherited from interface org.cyclos.services.CRUDService

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

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

Field Detail

ATTR_CUSTOM_OPERATION

ATTR_CONTAINER_CUSTOM_OPERATION

ATTR_USER

ATTR_CONTACT

ATTR_CONTACT_INFO

ATTR_AD

ATTR_RECORD

ATTR_TRANSFER

ATTR_MENU_ITEM

ATTR_INPUT_FILE

ATTR_FORM_PARAMETERS

ATTR_SCANNED_QR_CODE

ATTR_REQUEST

ATTR_BULK_ACTION

ATTR_STORAGE

ATTR_PARAMETER_STORAGE

ATTR_RETURN_URL

ATTR_EXECUTION

ATTR_EXTERNAL_REDIRECT_EXECUTION

ATTR_CURRENT_PAGE

ATTR_PAGE_SIZE

ATTR_SKIP_TOTAL_COUNT

ATTR_PAGE_CONTEXT

ATTR_EXPORT_FORMAT

Method Detail

getRelatedEntity

getRelatedEntity

getRunnableCustomOperationsForSystem

getRunnableOperationsForAd

getRunnableOperationsForBulkActions

getRunnableOperationsForContact

getRunnableOperationsForContactInfo

getRunnableOperationsForMenu

getRunnableOperationsForRecord

getRunnableOperationsForTransfer

getRunnableOperationsForUser

listAllowedToRun

listByScope

listOperationsRedirectingTo

listWithRecordScope

resolveCustomOperation

runForBulkAction

setMissingFormParameters