org.cyclos.impl.system

Interface CustomOperationServiceLocal

All Superinterfaces:

CRUDService<CustomOperationDTO,CustomOperationData,java.lang.Void>, CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,java.lang.Void>, CustomOperationService, Service

public interface CustomOperationServiceLocal
extends CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,java.lang.Void>, CustomOperationService

Local interface for CustomOperationService

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_AD Script attribute: the BasicAd
static java.lang.String	ATTR_BULK_ACTION Script attribute: the BulkAction being executed
static java.lang.String	ATTR_CURRENT_PAGE Script attribute: the current page, used when the result type is page results
static java.lang.String	ATTR_CUSTOM_OPERATION Script attribute: the CustomOperation
static java.lang.String	ATTR_EXTERNAL_REDIRECT_EXECUTION Script attribute: the ExternalRedirectExecution backing an CustomOperationResultType.EXTERNAL_REDIRECT
static java.lang.String	ATTR_FORM_PARAMETERS Script attribute: the form parameters (custom field values)
static java.lang.String	ATTR_INPUT_FILE Script attribute: the FileInfo for the uploaded file
static java.lang.String	ATTR_MENU_ITEM Script attribute: the MenuItem
static java.lang.String	ATTR_PAGE_CONTEXT Script attribute: the CustomOperationPageContext
static java.lang.String	ATTR_PAGE_SIZE Script attribute: the page size, used when the result type is page results
static java.lang.String	ATTR_PARAMETER_STORAGE Script attribute: the ObjectParameterStorage used on operations of type external redirect, both on first execution and on the callback
static java.lang.String	ATTR_RECORD Script attribute: the Record
static java.lang.String	ATTR_REQUEST Script attribute: the RequestInfo used on external redirect callback
static java.lang.String	ATTR_RETURN_URL Script attribute: the URL for the external service to call Cyclos and complete the operation, for CustomOperationResultType.EXTERNAL_REDIRECT
static java.lang.String	ATTR_USER Script attribute: the User

Method Summary

Modifier and Type	Method and Description
java.util.List<CustomOperation>	getRunnableCustomOperationsForSystem() Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
java.util.List<CustomOperation>	getRunnableOperationsForAd(BasicAd ad) Returns the custom operations that can be run by the logged user over the given ad
java.util.List<CustomOperation>	getRunnableOperationsForBulkActions() Returns the custom operations that can be run by the logged user as a bulk action
java.util.List<CustomOperation>	getRunnableOperationsForMenu() Returns the custom operations which can be run as menu items for the current session
java.util.List<CustomOperation>	getRunnableOperationsForRecord(Record record) Returns the custom operations that can be run by the logged user over the given record
java.util.List<CustomOperation>	getRunnableOperationsForUser(User user) Returns the custom operations that can be run by the logged user as a user action
java.util.List<CustomOperation>	listAllowedToRun() Lists all custom operations the logged user is allowed to run
java.util.List<CustomOperation>	listByScope(CustomOperationScope... scopes) Lists the custom operations for the given scopes
java.util.List<CustomOperation>	listOperationsRedirectingTo(CustomOperation internal) Lists the custom operations that use the given internal operation, either as row action or as action
java.util.List<CustomOperation>	listWithRecordScope(RecordTypeNature... natures) Lists the custom operations with scope record configured with at least one record type of the given nature(s)
org.cyclos.impl.users.BulkActionUserResult	runForBulkAction(BulkActionUser user) Runs the custom operation for a bulk action execution

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, toDTO, toEntity, validate

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

getRunAdData, getRunData, getRunnableOperationsForAd, getRunnableOperationsForRecord, getRunnableOperationsForSystem, getRunnableOperationsForUser, getRunRecordData, getRunUserData, list, run, runExternalRedirectCallback, saveOrder

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Field Detail

ATTR_CUSTOM_OPERATION

static final java.lang.String ATTR_CUSTOM_OPERATION

Script attribute: the CustomOperation

See Also:

Constant Field Values

ATTR_USER

static final java.lang.String ATTR_USER

Script attribute: the User

See Also:

Constant Field Values

ATTR_AD

static final java.lang.String ATTR_AD

Script attribute: the BasicAd

See Also:

Constant Field Values

ATTR_RECORD

static final java.lang.String ATTR_RECORD

Script attribute: the Record

See Also:

Constant Field Values

ATTR_MENU_ITEM

static final java.lang.String ATTR_MENU_ITEM

Script attribute: the MenuItem

See Also:

Constant Field Values

ATTR_INPUT_FILE

static final java.lang.String ATTR_INPUT_FILE

Script attribute: the FileInfo for the uploaded file

See Also:

Constant Field Values

ATTR_FORM_PARAMETERS

static final java.lang.String ATTR_FORM_PARAMETERS

Script attribute: the form parameters (custom field values)

See Also:

Constant Field Values

ATTR_REQUEST

static final java.lang.String ATTR_REQUEST

Script attribute: the RequestInfo used on external redirect callback

See Also:

Constant Field Values

ATTR_BULK_ACTION

static final java.lang.String ATTR_BULK_ACTION

Script attribute: the BulkAction being executed

See Also:

Constant Field Values

ATTR_PARAMETER_STORAGE

static final java.lang.String ATTR_PARAMETER_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_RETURN_URL

static final java.lang.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_EXTERNAL_REDIRECT_EXECUTION

static final java.lang.String ATTR_EXTERNAL_REDIRECT_EXECUTION

Script attribute: the ExternalRedirectExecution backing an CustomOperationResultType.EXTERNAL_REDIRECT

See Also:

Constant Field Values

ATTR_CURRENT_PAGE

static final java.lang.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 java.lang.String ATTR_PAGE_SIZE

Script attribute: the page size, used when the result type is page results

See Also:

Constant Field Values

ATTR_PAGE_CONTEXT

static final java.lang.String ATTR_PAGE_CONTEXT

Script attribute: the CustomOperationPageContext

See Also:

Constant Field Values

Method Detail

getRunnableCustomOperationsForSystem

java.util.List<CustomOperation> getRunnableCustomOperationsForSystem()

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

getRunnableOperationsForAd

java.util.List<CustomOperation> getRunnableOperationsForAd(BasicAd ad)

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

getRunnableOperationsForBulkActions

java.util.List<CustomOperation> getRunnableOperationsForBulkActions()

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

getRunnableOperationsForMenu

java.util.List<CustomOperation> getRunnableOperationsForMenu()

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

getRunnableOperationsForRecord

java.util.List<CustomOperation> getRunnableOperationsForRecord(Record record)

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

getRunnableOperationsForUser

java.util.List<CustomOperation> getRunnableOperationsForUser(User user)

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

listAllowedToRun

java.util.List<CustomOperation> listAllowedToRun()

Lists all custom operations the logged user is allowed to run

listByScope

java.util.List<CustomOperation> listByScope(CustomOperationScope... scopes)

Lists the custom operations for the given scopes

listOperationsRedirectingTo

java.util.List<CustomOperation> listOperationsRedirectingTo(CustomOperation internal)

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

listWithRecordScope

java.util.List<CustomOperation> listWithRecordScope(RecordTypeNature... natures)

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

runForBulkAction

org.cyclos.impl.users.BulkActionUserResult runForBulkAction(BulkActionUser user)

Runs the custom operation for a bulk action execution