org.cyclos.services.system

Interface CustomOperationService

All Superinterfaces:

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

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

Service for managing custom operations

Author:

luis

Method Summary

Modifier and Type	Method and Description
RunCustomOperationData	getRunData(CustomOperationVO customOperation, UserLocatorVO user, BasicAdVO ad) Returns data to run a custom operation over an specific user or specific ad.
java.util.List<CustomOperationVO>	list() Lists all available custom operations
java.util.List<CustomOperationVO>	listSystemToRun() Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
java.util.List<CustomOperationVO>	listUserToRun(UserLocatorVO locator) Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)
RunCustomOperationResult	run(RunCustomOperationDTO params) Runs a custom operation, returning the result with all type information
java.lang.String	runExternalRedirectCallback(RunExternalRedirectCallbackParams params) Runs the callback for a custom operation of type external redirect
CustomOperationContentResult	runForContent(RunCustomOperationDTO params, FileInfo inputFile) Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead
FileInfo	runForCSV(RunCustomOperationDTO params, FileInfo inputFile) Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead
FileInfo	runForFile(RunCustomOperationDTO params, FileInfo inputFile) Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead
CustomOperationPageResult	runForPage(RunCustomOperationDTO params, FileInfo inputFile) Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead
FileInfo	runForPDF(RunCustomOperationDTO params, FileInfo inputFile) Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead
java.lang.String	runForString(RunCustomOperationDTO params, FileInfo inputFile) Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getRunData

RunCustomOperationData getRunData(CustomOperationVO customOperation,
                                  UserLocatorVO user,
                                  BasicAdVO ad)
                           throws FrameworkException

Returns data to run a custom operation over an specific user or specific ad. If the operation has CustomOperationScope.SYSTEM, user and ad must be null. if CustomOperationScope.USER, user must be passed in if CustomOperationScope.ADVERTISEMENT, ad must be passed in

Throws:

FrameworkException

list

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

Lists all available custom operations

Throws:

FrameworkException

listSystemToRun

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

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

Throws:

FrameworkException

listUserToRun

java.util.List<CustomOperationVO> listUserToRun(UserLocatorVO locator)
                                         throws FrameworkException

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

Throws:

FrameworkException

run

RunCustomOperationResult run(RunCustomOperationDTO params)
                      throws FrameworkException

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

Throws:

FrameworkException

runExternalRedirectCallback

java.lang.String runExternalRedirectCallback(RunExternalRedirectCallbackParams params)
                                      throws FrameworkException

Runs the callback for a custom operation of type external redirect

Throws:

FrameworkException

runForContent

@Deprecated
CustomOperationContentResult runForContent(RunCustomOperationDTO params,
                                                       FileInfo inputFile)
                                                throws FrameworkException

Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead

Runs a content 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

runForCSV

@Deprecated
FileInfo runForCSV(RunCustomOperationDTO params,
                               FileInfo inputFile)
                        throws FrameworkException

Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead

Runs a result page custom operation, returning the all 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

@Deprecated
FileInfo runForFile(RunCustomOperationDTO params,
                                FileInfo inputFile)
                         throws FrameworkException

Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead

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

@Deprecated
CustomOperationPageResult runForPage(RunCustomOperationDTO params,
                                                 FileInfo inputFile)
                                          throws FrameworkException

Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead

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

runForPDF

@Deprecated
FileInfo runForPDF(RunCustomOperationDTO params,
                               FileInfo inputFile)
                        throws FrameworkException

Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead

Runs a result page custom operation, returning the page results in a PDF 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

runForString

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

Deprecated. Will be removed in future versions. Use run(RunCustomOperationDTO) instead

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