org.cyclos.services.users

Interface BrokeringService

All Superinterfaces:

Service

public interface BrokeringService
extends Service

Service interface for brokering

Author:

micael

Method Summary

Modifier and Type	Method and Description
java.lang.Long	addBroker(UserLocatorVO userLocator, UserLocatorVO brokerLocator, boolean mainBroker) Adds a broker for the given user, optionally setting the broker as main
AddBrokerData	getAddBrokerData(UserLocatorVO locator) Returns data for adding a broker to the given user
java.util.List<BrokeringLogVO>	getBrokeringLogs(UserLocatorVO locator) Return the brokering logs associated to the given user.
BrokeringData	getData(UserLocatorVO locator) Returns data for a user brokerings
void	removeBroker(UserLocatorVO userLocator, UserLocatorVO brokerLocator) Removes the given broker from the user brokerings
void	setMainBroker(UserLocatorVO userLocator, UserLocatorVO brokerLocator) Assigns the given brokering as main

Method Detail

addBroker

java.lang.Long addBroker(@NotNull
                         UserLocatorVO userLocator,
                         @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
                               UserLocatorVO locator)
                        throws FrameworkException

Returns data for adding a broker to the given user

Throws:

FrameworkException

getBrokeringLogs

java.util.List<BrokeringLogVO> getBrokeringLogs(@NotNull
                                                UserLocatorVO locator)
                                         throws FrameworkException

Return the brokering logs associated to the given user.

Throws:

FrameworkException

getData

BrokeringData getData(@NotNull
                      UserLocatorVO locator)
               throws FrameworkException

Returns data for a user brokerings

Throws:

FrameworkException

removeBroker

void removeBroker(@NotNull
                  UserLocatorVO userLocator,
                  @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
                   UserLocatorVO userLocator,
                   @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