BrokeringService (Cyclos 4.6 Scripting API Documentation)

All Superinterfaces:

Service

All Known Subinterfaces:

BrokeringServiceLocal

All Known Implementing Classes:

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

Author:

micael

Method Summary

All Methods Instance Methods Abstract Methods
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 an 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(UserLocatorVO userLocator,
                         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(UserLocatorVO locator)
                        throws FrameworkException

Returns data for adding a broker to the given user

Throws:: FrameworkException

getBrokeringLogs

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

Return the brokering logs associated to the given user.

Throws:: FrameworkException

getData

BrokeringData getData(UserLocatorVO locator)
               throws FrameworkException

Returns data for an user brokerings

Throws:: FrameworkException

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