GroupDefinitionManagerRemote (RHQ Enterprise Server JAR 4.6.0 API)

All Known Implementing Classes:

GroupDefinitionManagerBean
```
public interface GroupDefinitionManagerRemote
```
The remote interface to the SLSB GroupDefinitionManager.

Author:

Jirka Kremser

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`calculateGroupMembership(org.rhq.core.domain.auth.Subject subject, int groupDefinitionId)` Explicitly recalculates the group membership, depending on the GroupDefinition's expression.
`org.rhq.core.domain.resource.group.GroupDefinition`	`createGroupDefinition(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.group.GroupDefinition newGroupDefinition)` Creates a new group definiton.
`org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.group.GroupDefinition>`	`findGroupDefinitionsByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.ResourceGroupDefinitionCriteria criteria)` Fetches the group definitions based on provided criteria.
`void`	`removeGroupDefinition(org.rhq.core.domain.auth.Subject subject, Integer groupDefinitionId)` Deletes the given group definition.
`org.rhq.core.domain.resource.group.GroupDefinition`	`updateGroupDefinition(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.group.GroupDefinition updated)` Updates the given group definition.

Method Detail

createGroupDefinition

org.rhq.core.domain.resource.group.GroupDefinition createGroupDefinition(org.rhq.core.domain.auth.Subject subject,
                                                                       org.rhq.core.domain.resource.group.GroupDefinition newGroupDefinition)
                                                                         throws GroupDefinitionAlreadyExistsException,
                                                                                GroupDefinitionCreateException

Creates a new group definiton. The subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:: subject - the user who is asking create the group definition; newGroupDefinition - the object defining the group definition
Returns:: instance of GroupDefinition
Throws:: GroupDefinitionAlreadyExistsException; GroupDefinitionCreateException

findGroupDefinitionsByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.group.GroupDefinition> findGroupDefinitionsByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                                   org.rhq.core.domain.criteria.ResourceGroupDefinitionCriteria criteria)

Fetches the group definitions based on provided criteria. The subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:: subject - the user who is asking to find the group definitions; criteria - the criteria
Returns:: instance of GroupDefinition

removeGroupDefinition
```
void removeGroupDefinition(org.rhq.core.domain.auth.Subject subject,
                         Integer groupDefinitionId)
                           throws GroupDefinitionNotFoundException,
                                  GroupDefinitionDeleteException
```
Deletes the given group definition. The subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:
subject - the user who is asking to remove the group definition
groupDefinitionId - the id of a group definition to be deleted

Throws:

GroupDefinitionNotFoundException

GroupDefinitionDeleteException

updateGroupDefinition

org.rhq.core.domain.resource.group.GroupDefinition updateGroupDefinition(org.rhq.core.domain.auth.Subject subject,
                                                                       org.rhq.core.domain.resource.group.GroupDefinition updated)
                                                                         throws GroupDefinitionAlreadyExistsException,
                                                                                GroupDefinitionUpdateException,
                                                                                org.rhq.core.domain.resource.group.InvalidExpressionException,
                                                                                ResourceGroupUpdateException

Updates the given group definition. The subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:: subject - the user who is asking to update the group definition; updated - the object defining the group definition to be changed (based on its id)
Returns:: the updated group definition
Throws:: GroupDefinitionAlreadyExistsException; GroupDefinitionUpdateException; org.rhq.core.domain.resource.group.InvalidExpressionException; ResourceGroupUpdateException

calculateGroupMembership

void calculateGroupMembership(org.rhq.core.domain.auth.Subject subject,
                            int groupDefinitionId)
                              throws ResourceGroupDeleteException,
                                     GroupDefinitionDeleteException,
                                     GroupDefinitionNotFoundException,
                                     org.rhq.core.domain.resource.group.InvalidExpressionException

Explicitly recalculates the group membership, depending on the GroupDefinition's expression. The subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:: subject - the user who is asking to recalculate the group membership; groupDefinitionId - the id of a group definition to be recalculated
Throws:: ResourceGroupDeleteException; GroupDefinitionDeleteException; GroupDefinitionNotFoundException; org.rhq.core.domain.resource.group.InvalidExpressionException

Interface GroupDefinitionManagerRemote