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	getRunAdData(CustomOperationVO customOperation, BasicAdVO ad) Returns data to run a custom operation over an specific ad.
RunCustomOperationData	getRunData(CustomOperationVO customOperation) Returns data to run a custom operation with one of the following scopes: CustomOperationScope.SYSTEM CustomOperationScope.INTERNAL CustomOperationScope.MENU
java.util.List<CustomOperationVO>	getRunnableOperationsForAd(BasicAdVO ad) Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement
java.util.List<CustomOperationVO>	getRunnableOperationsForRecord(RecordVO record) Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record
java.util.List<CustomOperationVO>	getRunnableOperationsForSystem() Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
java.util.List<CustomOperationVO>	getRunnableOperationsForUser(UserLocatorVO locator) Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)
RunCustomOperationData	getRunRecordData(CustomOperationVO customOperation, RecordVO record) Returns data to run a custom operation over an specific record.
RunCustomOperationData	getRunUserData(CustomOperationVO customOperation, UserLocatorVO user) Returns data to run a custom operation over an specific user.
java.util.List<CustomOperationResultVO>	list() Lists all available custom operations
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
void	saveOrder(java.util.List<java.lang.Long> ids) Saves the order according to the given operation ids

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getRunAdData

RunCustomOperationData getRunAdData(@NotNull
                                    CustomOperationVO customOperation,
                                    @NotNull
                                    BasicAdVO ad)
                             throws FrameworkException

Returns data to run a custom operation over an specific ad. The scope of the custom operation must be CustomOperationScope.ADVERTISEMENT

Throws:

FrameworkException

getRunData

RunCustomOperationData getRunData(@NotNull
                                  CustomOperationVO customOperation)
                           throws FrameworkException

Returns data to run a custom operation with one of the following scopes:

CustomOperationScope.SYSTEM CustomOperationScope.INTERNAL CustomOperationScope.MENU

Throws:

FrameworkException

getRunnableOperationsForAd

java.util.List<CustomOperationVO> getRunnableOperationsForAd(BasicAdVO ad)
                                                      throws FrameworkException

Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement

Throws:

FrameworkException

getRunnableOperationsForRecord

java.util.List<CustomOperationVO> getRunnableOperationsForRecord(RecordVO record)
                                                          throws FrameworkException

Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record

Throws:

FrameworkException

getRunnableOperationsForSystem

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

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

Throws:

FrameworkException

getRunnableOperationsForUser

java.util.List<CustomOperationVO> getRunnableOperationsForUser(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

getRunRecordData

RunCustomOperationData getRunRecordData(@NotNull
                                        CustomOperationVO customOperation,
                                        @NotNull
                                        RecordVO record)
                                 throws FrameworkException

Returns data to run a custom operation over an specific record. The scope of the custom operation must be CustomOperationScope.RECORD

Throws:

FrameworkException

getRunUserData

RunCustomOperationData getRunUserData(@NotNull
                                      CustomOperationVO customOperation,
                                      UserLocatorVO user)
                               throws FrameworkException

Returns data to run a custom operation over an specific user. The scope of the custom operation must be CustomOperationScope.USER

Throws:

FrameworkException

list

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

Lists all available custom operations

Throws:

FrameworkException

run

RunCustomOperationResult run(@NotNull
                             RunCustomOperationDTO params)
                      throws FrameworkException

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

Throws:

FrameworkException

runExternalRedirectCallback

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

Runs the callback for a custom operation of type external redirect

Throws:

FrameworkException

saveOrder

void saveOrder(@NotNull
               java.util.List<java.lang.Long> ids)
        throws FrameworkException

Saves the order according to the given operation ids

Throws:

FrameworkException