org.cyclos.services.system

Interface CustomOperationService

All Superinterfaces:

CRUDService<CustomOperationDTO,CustomOperationData,java.lang.Void>, Service

All Known Subinterfaces:

CustomOperationServiceLocal

public interface CustomOperationService
extends CRUDService<CustomOperationDTO,CustomOperationData,java.lang.Void>

Service for managing custom operations

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
RunCustomOperationData	getRunData(java.lang.Long operationId, java.lang.Long userId) Returns data to run a custom operation over an specific user.
java.util.List<CustomOperationVO>	list() Lists all available custom operations
FileInfo	runForCSV(RunCustomOperationDTO params, FileInfo inputFile) Runs a result page custom operation, returning all results in a CSV file
FileInfo	runForFile(RunCustomOperationDTO params, FileInfo inputFile) Runs a custom operation.
CustomOperationPageResult	runForPage(RunCustomOperationDTO params, FileInfo inputFile) Runs a result page custom operation
java.lang.String	runForString(RunCustomOperationDTO params, FileInfo inputFile) Runs a custom operation.

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getRunData

RunCustomOperationData getRunData(java.lang.Long operationId,
                                java.lang.Long userId)
                                  throws FrameworkException

Returns data to run a custom operation over an specific user. If the operation has CustomOperationScope.SYSTEM, userId must be null. Otherwise, for CustomOperationScope.USER, userId must be passed in

Throws:

FrameworkException

list

java.util.List<CustomOperationVO> list()
                                       throws FrameworkException

Lists all available custom operations

Throws:

FrameworkException

runForCSV

FileInfo runForCSV(RunCustomOperationDTO params,
                 FileInfo inputFile)
                   throws FrameworkException

Runs a result page custom operation, returning all results in a CSV file

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.RESULT_PAGE

FrameworkException

runForFile

FileInfo runForFile(RunCustomOperationDTO params,
                  FileInfo inputFile)
                    throws FrameworkException

Runs a custom operation. This method only should be called if the operation's result type is a file download.

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.FILE_DOWNLOAD

FrameworkException

runForPage

CustomOperationPageResult runForPage(RunCustomOperationDTO params,
                                   FileInfo inputFile)
                                     throws FrameworkException

Runs a result page custom operation

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.RESULT_PAGE

FrameworkException

runForString

java.lang.String runForString(RunCustomOperationDTO params,
                            FileInfo inputFile)
                              throws FrameworkException

Runs a custom operation. This method only should be called if the operation's result type is a string

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not a string

FrameworkException