com.atlassian.crowd.model.group

Class GroupTemplate

java.lang.Object

com.atlassian.crowd.model.group.GroupTemplate

All Implemented Interfaces:

DirectoryEntity, Group, Serializable, Comparable<Group>

Direct Known Subclasses:

GroupTemplateWithAttributes

public class GroupTemplate
extends Object
implements Group, Serializable

A publicly mutable Group implementation.

Used to create or update a group.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GroupTemplate(Group group) Build a template from an existing group.
GroupTemplate(String name)
GroupTemplate(String name, long directoryId) Contructor that defaults the GroupType to GroupType.GROUP
GroupTemplate(String name, long directoryId, GroupType type) Build a template for a new group.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Group other)
boolean	equals(Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
String	getDescription()
long	getDirectoryId()
String	getExternalId() This will return null for directories which do not support external ids
String	getName()
GroupType	getType()
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isActive()
boolean	isLocal()
void	setActive(boolean active)
void	setDescription(String description)
void	setDirectoryId(long directoryId)
void	setExternalId(String externalId)
void	setLocal(boolean local)
void	setName(String name)
void	setType(GroupType type)
String	toString()
GroupTemplate	withDirectoryId(long directoryId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GroupTemplate

public GroupTemplate(String name,
                     long directoryId,
                     GroupType type)

Build a template for a new group.

Used to create a group.

Parameters:

name - group name of new group.

directoryId - ID of the directory in which to store the new group.

type - the group type see GroupType

GroupTemplate

public GroupTemplate(String name)

GroupTemplate

public GroupTemplate(String name,
                     long directoryId)

Contructor that defaults the GroupType to GroupType.GROUP

Parameters:

name - the name of the group

directoryId - ID of the directory in which to store the new group.

GroupTemplate

public GroupTemplate(Group group)

Build a template from an existing group.

Used to update a group.

Parameters:

group - group to build template from.

Method Detail

withDirectoryId

public GroupTemplate withDirectoryId(long directoryId)

Parameters:

directoryId - directory id for the returned group template

Returns:

a copy of this group template, with the directory id of this copy set to directoryId

setName

public void setName(String name)

setDirectoryId

public void setDirectoryId(long directoryId)

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface DirectoryEntity

Returns:

id of the directory in which the DirectoryEntity is stored.

getName

public String getName()

Specified by:

getName in interface DirectoryEntity

Returns:

name of the entity.

isActive

public boolean isActive()

Specified by:

isActive in interface Group

Returns:

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

setActive

public void setActive(boolean active)

getDescription

public String getDescription()

Specified by:

getDescription in interface Group

Returns:

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

setDescription

public void setDescription(String description)

getType

public GroupType getType()

Specified by:

getType in interface Group

Returns:

the type of the group.

setType

public void setType(GroupType type)

isLocal

public boolean isLocal()

setLocal

public void setLocal(boolean local)

getExternalId

@Nullable
public String getExternalId()

Description copied from interface: Group

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

Specified by:

getExternalId in interface Group

Returns:

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

setExternalId

public void setExternalId(String externalId)

equals

public boolean equals(Object o)

Description copied from interface: DirectoryEntity

Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().

Specified by:

equals in interface DirectoryEntity

Overrides:

equals in class Object

Parameters:

o - object to compare to.

Returns:

true if and only if the directoryId and the lowercase names of the directory entities match.

hashCode

public int hashCode()

Description copied from interface: DirectoryEntity

Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().

Specified by:

hashCode in interface DirectoryEntity

Overrides:

hashCode in class Object

Returns:

hashcode.

compareTo

public int compareTo(Group other)

Specified by:

compareTo in interface Comparable<Group>

toString

public String toString()

Overrides:

toString in class Object