All Superinterfaces:

Service

All Known Subinterfaces:

BrokeringServiceLocal
```
public interface BrokeringService
extends Service
```
Service interface for brokering

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Long`	`addBroker(@NotNull UserLocatorVO userLocator, @NotNull UserLocatorVO brokerLocator, boolean mainBroker)`	Adds a broker for the given user, optionally setting the broker as main
`AddBrokerData`	`getAddBrokerData(@NotNull UserLocatorVO locator)`	Returns data for adding a broker to the given user
`BrokeringWithUserVO`	`getByUserAndBroker(@NotNull UserLocatorVO userLocator, @NotNull UserLocatorVO brokerLocator)`	Returns details of a brokering relation by user and broker, only if the broker is currently the user's broker
`BrokeringData`	`getData(@NotNull UserLocatorVO locator)`	Returns data for a user brokerings
`void`	`removeBroker(@NotNull UserLocatorVO userLocator, @NotNull UserLocatorVO brokerLocator)`	Removes the given broker from the user brokerings
`void`	`setMainBroker(@NotNull UserLocatorVO userLocator, @NotNull UserLocatorVO brokerLocator)`	Assigns the given brokering as main

Method Detail

addBroker

Long addBroker(@NotNull
               @NotNull UserLocatorVO userLocator,
               @NotNull
               @NotNull UserLocatorVO brokerLocator,
               boolean mainBroker)
        throws FrameworkException

Adds a broker for the given user, optionally setting the broker as main

Throws:: IllegalActionException - When the given broker is either inactive or is not a broker; FrameworkException

getAddBrokerData

AddBrokerData getAddBrokerData(@NotNull
                               @NotNull UserLocatorVO locator)
                        throws FrameworkException

Returns data for adding a broker to the given user

Throws:: FrameworkException

getByUserAndBroker

BrokeringWithUserVO getByUserAndBroker(@NotNull
                                       @NotNull UserLocatorVO userLocator,
                                       @NotNull
                                       @NotNull UserLocatorVO brokerLocator)
                                throws FrameworkException

Returns details of a brokering relation by user and broker, only if the broker is currently the user's broker

Throws:: FrameworkException

getData

BrokeringData getData(@NotNull
                      @NotNull UserLocatorVO locator)
               throws FrameworkException

Returns data for a user brokerings

Throws:: FrameworkException

removeBroker

void removeBroker(@NotNull
                  @NotNull UserLocatorVO userLocator,
                  @NotNull
                  @NotNull UserLocatorVO brokerLocator)
           throws FrameworkException

Removes the given broker from the user brokerings

Throws:: IllegalActionException - When the given broker is not a broker of the given user; FrameworkException

setMainBroker

void setMainBroker(@NotNull
                   @NotNull UserLocatorVO userLocator,
                   @NotNull
                   @NotNull UserLocatorVO brokerLocator)
            throws FrameworkException

Assigns the given brokering as main

Throws:: IllegalActionException - When the given broker is not a broker of the given user; FrameworkException

Interface BrokeringService