Package org.cyclos.services.system

Interface CustomOperationService

All Superinterfaces:

CRUDService<CustomOperationDTO,CustomOperationData,Void>, Service

All Known Subinterfaces:

CustomOperationServiceLocal

public interface CustomOperationService
extends CRUDService<CustomOperationDTO,CustomOperationData,Void>

Service for managing custom operations

Method Summary

Modifier and Type	Method	Description
CredentialInputDTO	getConfirmationPasswordInputForRun(RunCustomOperationDataParams params)	Returns the CredentialInputDTO for the confirmation password that would be required if executing the given custom operation.
RunCustomOperationData	getRunData(@NotNull RunCustomOperationDataParams params)	Returns data to run a custom operation.
List<RunnableCustomOperationVO>	getRunnableOperationsForAd(BasicAdVO ad)	Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement
List<RunnableCustomOperationVO>	getRunnableOperationsForContact(ContactVO contact)	Lists the user custom operations scope = CustomOperationScope.CONTACT the logged user can run over the given contact
List<RunnableCustomOperationVO>	getRunnableOperationsForContactInfo(ContactInfoVO contactInfo)	Lists the user custom operations scope = CustomOperationScope.CONTACT_INFO the logged user can run over the given public contact information
List<RunnableCustomOperationVO>	getRunnableOperationsForRecord(RecordVO record)	Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record
List<RunnableCustomOperationVO>	getRunnableOperationsForSystem()	Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
List<RunnableCustomOperationVO>	getRunnableOperationsForTransfer(TransferVO transfer)	Lists the custom operations with scope = CustomOperationScope.TRANSFER the logged user can run over the given transfer
List<RunnableCustomOperationVO>	getRunnableOperationsForUser(UserLocatorVO locator)	Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)
List<CustomOperationResultVO>	list()	Lists all available custom operations
RunCustomOperationResult	run(@NotNull RunCustomOperationDTO params)	Runs a custom operation, returning the result with all type information
RunCustomOperationResult	runExternalRedirectCallback(@NotNull RunExternalRedirectCallbackParams params)	Runs the callback for a custom operation of type external redirect.
void	saveOrder(@NotNull List<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

getConfirmationPasswordInputForRun

CredentialInputDTO getConfirmationPasswordInputForRun(RunCustomOperationDataParams params)

Returns the CredentialInputDTO for the confirmation password that would be required if executing the given custom operation.

getRunData

RunCustomOperationData getRunData(@NotNull
                                  @NotNull RunCustomOperationDataParams params)
                           throws FrameworkException

Returns data to run a custom operation. Depending on the custom operation scope, the input parameters must be a subclass of RunCustomOperationDataParams with the specific parmeters set (for example, a RunRecordCustomOperationDataParams with the record set if the scope is CustomOperationScope.RECORD) The result will also be a subclass of RunCustomOperationData depending on the custom operation scope, for example a RunRecordCustomOperationData.

Throws:

FrameworkException

getRunnableOperationsForAd

List<RunnableCustomOperationVO> getRunnableOperationsForAd(BasicAdVO ad)
                                                    throws FrameworkException

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

Throws:

FrameworkException

getRunnableOperationsForContact

List<RunnableCustomOperationVO> getRunnableOperationsForContact(ContactVO contact)
                                                         throws FrameworkException

Lists the user custom operations scope = CustomOperationScope.CONTACT the logged user can run over the given contact

Throws:

FrameworkException

getRunnableOperationsForContactInfo

List<RunnableCustomOperationVO> getRunnableOperationsForContactInfo(ContactInfoVO contactInfo)
                                                             throws FrameworkException

Lists the user custom operations scope = CustomOperationScope.CONTACT_INFO the logged user can run over the given public contact information

Throws:

FrameworkException

getRunnableOperationsForRecord

List<RunnableCustomOperationVO> 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

List<RunnableCustomOperationVO> getRunnableOperationsForSystem()
                                                        throws FrameworkException

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

Throws:

FrameworkException

getRunnableOperationsForTransfer

List<RunnableCustomOperationVO> getRunnableOperationsForTransfer(TransferVO transfer)
                                                          throws FrameworkException

Lists the custom operations with scope = CustomOperationScope.TRANSFER the logged user can run over the given transfer

Throws:

FrameworkException

getRunnableOperationsForUser

List<RunnableCustomOperationVO> 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

list

List<CustomOperationResultVO> list()
                            throws FrameworkException

Lists all available custom operations

Throws:

FrameworkException

run

RunCustomOperationResult run(@NotNull
                             @NotNull RunCustomOperationDTO params)
                      throws FrameworkException

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

Throws:

FrameworkException

runExternalRedirectCallback

RunCustomOperationResult runExternalRedirectCallback(@NotNull
                                                     @NotNull RunExternalRedirectCallbackParams params)
                                              throws FrameworkException

Runs the callback for a custom operation of type external redirect. The result is currently always sent with result type = CustomOperationResultType.NOTIFICATION.

Throws:

FrameworkException

saveOrder

void saveOrder(@NotNull
               @NotNull List<Long> ids)
        throws FrameworkException

Saves the order according to the given operation ids

Throws:

FrameworkException