com.atlassian.crowd.plugin.rest.entity

Class GroupEntity

java.lang.Object

com.atlassian.crowd.plugin.rest.entity.GroupEntity

All Implemented Interfaces:

NamedEntity

@Expander(value=GroupEntityExpander.class)
public class GroupEntity
extends Object
implements NamedEntity

Represents a Group entity.

Since:

v2.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROUP_ATTRIBUTES_FIELD_NAME Name of the attributes field.

Constructor Summary

Constructors

Constructor and Description
GroupEntity(String name, String description, GroupType type, Boolean active, com.atlassian.plugins.rest.common.Link link)

Method Summary

Modifier and Type	Method and Description
MultiValuedAttributeEntityList	getAttributes()
String	getDescription()
com.atlassian.plugins.rest.common.Link	getLink()
String	getName()
GroupType	getType()
Boolean	isActive()
boolean	isExpanded() Does this object represent an expanded group, or does it only contain a group name.
static GroupEntity	newMinimalGroupEntity(String name, String applicationName, URI baseURI) Creates a GroupEntity with the minimal amount of information required.
void	setAttributes(MultiValuedAttributeEntityList attributes)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_ATTRIBUTES_FIELD_NAME

public static final String GROUP_ATTRIBUTES_FIELD_NAME

Name of the attributes field.

See Also:

Constant Field Values

Constructor Detail

GroupEntity

public GroupEntity(String name,
                   String description,
                   GroupType type,
                   Boolean active,
                   com.atlassian.plugins.rest.common.Link link)

Method Detail

getDescription

public String getDescription()

getType

public GroupType getType()

isActive

public Boolean isActive()

getName

public String getName()

Specified by:

getName in interface NamedEntity

setAttributes

public void setAttributes(MultiValuedAttributeEntityList attributes)

getAttributes

public MultiValuedAttributeEntityList getAttributes()

newMinimalGroupEntity

public static GroupEntity newMinimalGroupEntity(String name,
                                                String applicationName,
                                                URI baseURI)

Creates a GroupEntity with the minimal amount of information required.

Parameters:

name - group name.

baseURI - base URI

Returns:

GroupEntity

isExpanded

public boolean isExpanded()

Does this object represent an expanded group, or does it only contain a group name.

Returns:

true if this object represents an expanded group

toString

public String toString()

Overrides:

toString in class Object

getLink

public com.atlassian.plugins.rest.common.Link getLink()