com.atlassian.crowd.plugin.rest.util
Class GroupEntityUtil

java.lang.Object
  com.atlassian.crowd.plugin.rest.util.GroupEntityUtil

public class GroupEntityUtil
extends java.lang.Object

Utility class for GroupEntity.

Method Summary

static GroupEntity

expandGroup(ApplicationService applicationService, Application application, GroupEntity minimalGroupEntity, boolean expandAttributes) Expands a GroupEntity from its minimal form to the expanded version.

Methods inherited from class java.lang.Object

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

Method Detail

expandGroup

public static GroupEntity expandGroup(ApplicationService applicationService,
                                      Application application,
                                      GroupEntity minimalGroupEntity,
                                      boolean expandAttributes)
                               throws GroupNotFoundException

Expands a GroupEntity from its minimal form to the expanded version. Attributes are expanded if expandAttributes is true, otherwise, GroupEntity is returned with no attributes expanded.

N.B. This is not the same as expanding a group entity, which expands a GroupEntity from its minimal form, to having all the description, type, etc filled in. Expanding a GroupEntity is automatically performed in GroupEntityExpander.

Parameters:

applicationService - ApplicationService to find a group

application - name of the application requesting the group

minimalGroupEntity - Minimal representation of a GroupEntity. Must include at least a group name and a link.

expandAttributes - set to true if the expanded GroupEntity should expand attributes.

Returns:

GroupEntity expanded GroupEntity

Throws:

java.lang.IllegalArgumentException - if the minimal GroupEntity does not include at least a group name and a link.

GroupNotFoundException