org.rhq.enterprise.server.resource.group
Interface ResourceGroupManagerLocal

All Known Implementing Classes:

ResourceGroupManagerBean

public interface ResourceGroupManagerLocal

A manager that provides methods for creating, updating, deleting, and querying ResourceGroups.

Author:

Ian Springer

Method Summary

void	addResourcesToGroup(Subject subject, int groupId, int[] resourceIds)
ResourceGroup	createResourceGroup(Subject user, ResourceGroup group)
void	deleteResourceGroup(Subject user, int groupId)
void	enableRecursivityForGroup(Subject subject, int groupId)
void	ensureMembershipMatches(Subject subject, int groupId, int[] resourceIds)
PageList<ResourceGroup>	findAvailableResourceGroupsForRole(Subject subject, int roleId, int[] excludeIds, PageControl pageControl)
int[]	findDefinitionsForAutoGroup(Subject subject, int autoGroupParentResourceId, int autoGroupChildResourceTypeId, boolean displayTypeSummaryOnly) Get the MeasurementDefinitions for the passed autogroup
int[]	findDefinitionsForCompatibleGroup(Subject subject, int groupId, boolean displayTypeSummaryOnly) Return the MeasurementDefinitions for the passed comatible group
java.util.List<java.lang.Integer>	findDeletedResourceGroupIds(int[] groupIds)
PageList<ResourceGroup>	findResourceGroupByIds(Subject subject, int[] resourceGroupIds, PageControl pageControl)
PageList<ResourceGroupComposite>	findResourceGroupComposites(Subject subject, GroupCategory groupCategory, ResourceCategory resourceCategory, java.lang.String resourceTypeName, java.lang.String pluginName, java.lang.String nameFilter, java.lang.Integer resourceId, java.lang.Integer groupId, PageControl pc)
PageList<ResourceGroup>	findResourceGroupsByCriteria(Subject subject, ResourceGroupCriteria criteria)
PageList<ResourceGroup>	findResourceGroupsForRole(Subject subject, int roleId, PageControl pc)
java.util.List<Resource>	findResourcesForAutoGroup(Subject subject, int autoGroupParentResourceId, int autoGroupChildResourceTypeId)
java.util.List<Resource>	findResourcesForResourceGroup(Subject subject, int groupId, GroupCategory category)
ResourceGroup	getByGroupDefinitionAndGroupByClause(int groupDefinitionId, java.lang.String groupByClause)
int	getImplicitGroupMemberCount(int resourceGroupId)
ResourceGroup	getResourceGroup(Subject subject, int groupId)
ResourceGroup	getResourceGroupById(Subject user, int id, GroupCategory category)
ResourceGroupComposite	getResourceGroupComposite(Subject subject, int groupId)
int	getResourceGroupCountByCategory(Subject subject, GroupCategory category)
void	removeAllResourcesFromGroup(Subject subject, int groupId)
void	removeResourcesFromGroup(Subject subject, int groupId, int[] resourceIds)
void	setRecursive(Subject subject, int groupId, boolean isRecursive)
void	setResourceType(int resourceGroupId)
void	updateImplicitGroupMembership(Subject subject, Resource resource)
ResourceGroup	updateResourceGroup(Subject subject, ResourceGroup group)
ResourceGroup	updateResourceGroup(Subject user, ResourceGroup group, RecursivityChangeType changeType)

Method Detail

updateResourceGroup

ResourceGroup updateResourceGroup(Subject user,
                                  ResourceGroup group,
                                  RecursivityChangeType changeType)
                                  throws ResourceGroupAlreadyExistsException,
                                         ResourceGroupUpdateException

Throws:

ResourceGroupAlreadyExistsException

ResourceGroupUpdateException

getResourceGroupById

ResourceGroup getResourceGroupById(Subject user,
                                   int id,
                                   GroupCategory category)
                                   throws ResourceGroupNotFoundException

Throws:

ResourceGroupNotFoundException

getResourceGroupCountByCategory

int getResourceGroupCountByCategory(Subject subject,
                                    GroupCategory category)

enableRecursivityForGroup

void enableRecursivityForGroup(Subject subject,
                               int groupId)
                               throws ResourceGroupNotFoundException,
                                      ResourceGroupUpdateException

Throws:

ResourceGroupNotFoundException

ResourceGroupUpdateException

removeAllResourcesFromGroup

void removeAllResourcesFromGroup(Subject subject,
                                 int groupId)
                                 throws ResourceGroupDeleteException

Throws:

ResourceGroupDeleteException

findAvailableResourceGroupsForRole

PageList<ResourceGroup> findAvailableResourceGroupsForRole(Subject subject,
                                                           int roleId,
                                                           int[] excludeIds,
                                                           PageControl pageControl)

findResourceGroupByIds

PageList<ResourceGroup> findResourceGroupByIds(Subject subject,
                                               int[] resourceGroupIds,
                                               PageControl pageControl)

updateImplicitGroupMembership

void updateImplicitGroupMembership(Subject subject,
                                   Resource resource)

findResourcesForAutoGroup

java.util.List<Resource> findResourcesForAutoGroup(Subject subject,
                                                   int autoGroupParentResourceId,
                                                   int autoGroupChildResourceTypeId)

findResourcesForResourceGroup

java.util.List<Resource> findResourcesForResourceGroup(Subject subject,
                                                       int groupId,
                                                       GroupCategory category)

findDefinitionsForCompatibleGroup

int[] findDefinitionsForCompatibleGroup(Subject subject,
                                        int groupId,
                                        boolean displayTypeSummaryOnly)

Return the MeasurementDefinitions for the passed comatible group

Parameters:

subject - Subject of the calling user

groupId - id of the group

displayTypeSummaryOnly - TODO

Returns:

a set of Definitions, which is empty for an invalid groupId

findDefinitionsForAutoGroup

int[] findDefinitionsForAutoGroup(Subject subject,
                                  int autoGroupParentResourceId,
                                  int autoGroupChildResourceTypeId,
                                  boolean displayTypeSummaryOnly)

Get the MeasurementDefinitions for the passed autogroup

Parameters:

subject - Subject of the calling user

autoGroupParentResourceId - id of the parent resource

autoGroupChildResourceTypeId - Id of the ResourceType of the children

displayTypeSummaryOnly - TODO

Returns:

a set of Definitions which is empty for an invalid autoGroupChildResourceType

getByGroupDefinitionAndGroupByClause

ResourceGroup getByGroupDefinitionAndGroupByClause(int groupDefinitionId,
                                                   java.lang.String groupByClause)

setResourceType

void setResourceType(int resourceGroupId)

getImplicitGroupMemberCount

int getImplicitGroupMemberCount(int resourceGroupId)

findResourceGroupComposites

PageList<ResourceGroupComposite> findResourceGroupComposites(Subject subject,
                                                             GroupCategory groupCategory,
                                                             ResourceCategory resourceCategory,
                                                             java.lang.String resourceTypeName,
                                                             java.lang.String pluginName,
                                                             java.lang.String nameFilter,
                                                             java.lang.Integer resourceId,
                                                             java.lang.Integer groupId,
                                                             PageControl pc)

findDeletedResourceGroupIds

java.util.List<java.lang.Integer> findDeletedResourceGroupIds(int[] groupIds)

ensureMembershipMatches

void ensureMembershipMatches(Subject subject,
                             int groupId,
                             int[] resourceIds)
                             throws ResourceGroupUpdateException

Throws:

ResourceGroupUpdateException

addResourcesToGroup

void addResourcesToGroup(Subject subject,
                         int groupId,
                         int[] resourceIds)

createResourceGroup

ResourceGroup createResourceGroup(Subject user,
                                  ResourceGroup group)

deleteResourceGroup

void deleteResourceGroup(Subject user,
                         int groupId)
                         throws ResourceGroupNotFoundException,
                                ResourceGroupDeleteException

Throws:

ResourceGroupNotFoundException

ResourceGroupDeleteException

getResourceGroup

ResourceGroup getResourceGroup(Subject subject,
                               int groupId)

getResourceGroupComposite

ResourceGroupComposite getResourceGroupComposite(Subject subject,
                                                 int groupId)

findResourceGroupsForRole

PageList<ResourceGroup> findResourceGroupsForRole(Subject subject,
                                                  int roleId,
                                                  PageControl pc)

removeResourcesFromGroup

void removeResourcesFromGroup(Subject subject,
                              int groupId,
                              int[] resourceIds)

setRecursive

void setRecursive(Subject subject,
                  int groupId,
                  boolean isRecursive)

updateResourceGroup

ResourceGroup updateResourceGroup(Subject subject,
                                  ResourceGroup group)

findResourceGroupsByCriteria

PageList<ResourceGroup> findResourceGroupsByCriteria(Subject subject,
                                                     ResourceGroupCriteria criteria)