OperatorService (Cyclos 4.13 WS API Documentation)

All Superinterfaces:

CRUDService<OperatorDTO,OperatorData,OperatorDataParams>, CRUDWithConfirmationPasswordService<OperatorDTO,OperatorData,OperatorDataParams>, Service
```
public interface OperatorService
extends CRUDWithConfirmationPasswordService<OperatorDTO,OperatorData,OperatorDataParams>
```
Service used to manage a user's operators

Author:

luis

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`OperatorsSearchData`	`getSearchData(UserLocatorVO user)` Returns data for searching operators of the given user
`ViewOperatorProfileData`	`getViewProfileData(@NotNull UserLocatorVO locator)` Returns data for viewing an operator profile
`UserRegistrationResult`	`register(@NotNull OperatorRegistrationDTO dto)` Registers an operator, returning the status and generated data
`Page<OperatorWithFieldsVO>`	`search(@NotNull OperatorQuery params)` Searches for operators according to the given criteria

Methods inherited from interface org.cyclos.services.CRUDWithConfirmationPasswordService
getConfirmationPasswordInputForRemove, removeAllWithConfirmationPassword, removeWithConfirmationPassword, saveWithConfirmationPassword

Methods inherited from interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

Method Detail

getSearchData

OperatorsSearchData getSearchData(UserLocatorVO user)
                           throws FrameworkException

Returns data for searching operators of the given user

Throws:: FrameworkException

getViewProfileData

ViewOperatorProfileData getViewProfileData(@NotNull
                                           @NotNull UserLocatorVO locator)
                                    throws FrameworkException

Returns data for viewing an operator profile

Throws:: FrameworkException

register

UserRegistrationResult register(@NotNull
                                @NotNull OperatorRegistrationDTO dto)
                         throws FrameworkException

Registers an operator, returning the status and generated data

Throws:: FrameworkException

search

Page<OperatorWithFieldsVO> search(@NotNull
                                  @NotNull OperatorQuery params)
                           throws FrameworkException

Searches for operators according to the given criteria

Throws:: FrameworkException

Interface OperatorService