org.cyclos.impl.system

Interface CustomOperationServiceLocal

All Superinterfaces:

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

public interface CustomOperationServiceLocal
extends org.cyclos.impl.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_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_FORM_PARAMETERS Script attribute: the form parameters (custom field values)
static java.lang.String	ATTR_INPUT_FILE Script attribute: the SerializableInputStream for the uploaded file
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 ParameterStorage used on operations of type external redirect, both on first execution and on the callback
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
static java.lang.String	ATTR_USER Script attribute: the User

Method Summary

Modifier and Type	Method and Description
java.util.List<CustomOperation>	listAllowedToRun() Lists all custom operations the logged user is allowed to run
java.util.List<CustomOperation>	listByScope(CustomOperationScope scope) Lists the custom operations for a given scope
java.util.List<CustomOperation>	listOperationsRedirectingTo(CustomOperation internal) Lists the custom operations that redirect to the given internal operation
void	prepareContext(org.cyclos.impl.system.ExternalRedirectCallbackContext context, long id, RequestInfo request) Collects in the given context all information needed to run an external redirect callback.
java.lang.String	runExternalRedirectCallback(org.cyclos.impl.system.ExternalRedirectCallbackContext context) Runs the callback for a custom operation of type external redirect

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

getRunData, list, runForContent, runForCSV, runForFile, runForPage, runForPDF, runForString

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_INPUT_FILE

static final java.lang.String ATTR_INPUT_FILE

Script attribute: the SerializableInputStream 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_PARAMETER_STORAGE

static final java.lang.String ATTR_PARAMETER_STORAGE

Script attribute: the ParameterStorage 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

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

listAllowedToRun

java.util.List<CustomOperation> listAllowedToRun()

Lists all custom operations the logged user is allowed to run

listByScope

java.util.List<CustomOperation> listByScope(CustomOperationScope scope)
                                     throws FrameworkException

Lists the custom operations for a given scope

Throws:

FrameworkException

listOperationsRedirectingTo

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

Lists the custom operations that redirect to the given internal operation

prepareContext

void prepareContext(org.cyclos.impl.system.ExternalRedirectCallbackContext context,
                    long id,
                    RequestInfo request)
             throws FrameworkException

Collects in the given context all information needed to run an external redirect callback.

Parameters:

id - the ExternalRedirectExecution's id, the execution created when the custom operation was executed (before redirect to the external url)

Throws:

FrameworkException

runExternalRedirectCallback

java.lang.String runExternalRedirectCallback(org.cyclos.impl.system.ExternalRedirectCallbackContext context)
                                      throws FrameworkException

Runs the callback for a custom operation of type external redirect

Throws:

FrameworkException