com.atlassian.crowd.model.group

Interface Group

All Superinterfaces:

Comparable<Group>, DirectoryEntity

All Known Subinterfaces:

GroupWithAttributes, InternalDirectoryGroup, TimestampedGroup

All Known Implementing Classes:

BaseImmutableGroup, DelegatingGroupWithAttributes, GroupEntity, GroupTemplate, GroupTemplateWithAttributes, GroupWithMembershipChanges, ImmutableDirectoryGroup, ImmutableDirectoryGroupWithAttributes, ImmutableGroup, InternalGroup, InternalGroupWithAttributes, LDAPGroupWithAttributes

public interface Group
extends DirectoryEntity, Comparable<Group>

Represents a group.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getExternalId() This will return null for directories which do not support external ids
GroupType	getType()
boolean	isActive()

Methods inherited from interface com.atlassian.crowd.model.DirectoryEntity

equals, getDirectoryId, getName, hashCode

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getType

GroupType getType()

Returns:

the type of the group.

isActive

boolean isActive()

Returns:

true if and only if the user is allowed to authenticate.

getDescription

String getDescription()

Returns:

description of the group or null if there is no description.

getExternalId

@Nullable
String getExternalId()

This will return null for directories which do not support external ids

Returns:

external id of the group or null it there is no external id