co.ecg.alpaca.toolkit.helper.services

Class ServiceHelper

java.lang.Object

co.ecg.alpaca.toolkit.helper.services.ServiceHelper

public class ServiceHelper
extends Object

The ServiceHelper class houses utility methods that aid in handling User, Group, and System services and service packs. Created on: Jun 16, 2015

Author:

Matthew Keathley - mkeathley@e-c-group.com

Constructor Summary

Constructors

Constructor and Description
ServiceHelper()

Method Summary

Modifier and Type	Method and Description
static void	authorizeAndAssignService(BroadWorksUser user, UserService service) Authorizes and Assigns a UserService at the ServiceProvider, Group, and User level.
static <T extends BroadWorksUser> List<T>	getAllUsersWithService(BroadWorksServer bws, List<T> users, UserService service) Populates a list of User objects using asynchronous calls to perform the population in an efficient manner
static boolean	serviceIsAssigned(User user, UserService service) Checks if a UserService is assigned to a User.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceHelper

public ServiceHelper()

Method Detail

authorizeAndAssignService

public static void authorizeAndAssignService(BroadWorksUser user,
                                             UserService service)
                                      throws HelperException

Authorizes and Assigns a UserService at the ServiceProvider, Group, and User level. This effectively forces a service onto a User even if it is currently not available for the User.

Parameters:

user - The user to assign

service - The UserService to assign

Throws:

HelperException - Thrown if the parameters are NULL.

getAllUsersWithService

public static <T extends BroadWorksUser> List<T> getAllUsersWithService(BroadWorksServer bws,
                                                                        List<T> users,
                                                                        UserService service)
                                                                 throws HelperException

Populates a list of User objects using asynchronous calls to perform the population in an efficient manner

Parameters:

bws - The BroadWorksServer connection to use for the requests

users - The list of Users to populate

Returns:

Returns the same list of users with the fields populated with data

Throws:

HelperException - Thrown if an error occurs while retrieving users.

serviceIsAssigned

public static boolean serviceIsAssigned(User user,
                                        UserService service)
                                 throws HelperException

Checks if a UserService is assigned to a User.

Parameters:

user - The user to check

service - The UserService to check

Returns:

Returns true iff the service is assigned to the User

Throws:

HelperException - Thrown if an error occurs while check service assignment.