com.atlassian.crowd.model.group

Class InternalGroup

java.lang.Object

com.atlassian.crowd.model.InternalEntity

com.atlassian.crowd.model.InternalDirectoryEntity<InternalGroupAttribute>

com.atlassian.crowd.model.group.InternalGroup

All Implemented Interfaces:

DirectoryEntity, Group, InternalDirectoryGroup, TimestampedGroup, TimestampedEntity, Serializable, Comparable<Group>

public class InternalGroup
extends InternalDirectoryEntity<InternalGroupAttribute>
implements InternalDirectoryGroup

Encapsulates the concept of group.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.crowd.model.InternalDirectoryEntity

attributes, directory

Fields inherited from class com.atlassian.crowd.model.InternalEntity

active, createdDate, id, name, updatedDate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalGroup()
	InternalGroup(Group group, Directory directory)
	InternalGroup(InternalEntityTemplate internalEntityTemplate, Directory directory, GroupTemplate groupTemplate)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Group o)
boolean	equals(Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
String	getDescription()
String	getExternalId() This will return null for directories which do not support external ids
String	getLowerName()
GroupType	getType()
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isLocal() Returns true if this is a Local Group.
void	renameTo(String newName)
void	setExternalId(String externalId)
void	setLocal(boolean local)
protected void	setName(String name)
String	toString()
void	updateDetailsFrom(Group group)

Methods inherited from class com.atlassian.crowd.model.InternalDirectoryEntity

getAttributes, getDirectory, getDirectoryId

Methods inherited from class com.atlassian.crowd.model.InternalEntity

getCreatedDate, getId, getName, getUpdatedDate, isActive, setActive, setCreatedDate, setCreatedDateToNow, setUpdatedDate, setUpdatedDateToNow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.crowd.model.group.Group

isActive

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

getDirectoryId, getName

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

getCreatedDate, getUpdatedDate

Constructor Detail

InternalGroup

protected InternalGroup()

InternalGroup

public InternalGroup(InternalEntityTemplate internalEntityTemplate,
                     Directory directory,
                     GroupTemplate groupTemplate)

InternalGroup

public InternalGroup(Group group,
                     Directory directory)

Method Detail

updateDetailsFrom

public void updateDetailsFrom(Group group)

renameTo

public void renameTo(String newName)

setName

protected void setName(String name)

Overrides:

setName in class InternalEntity

getDescription

public String getDescription()

Specified by:

getDescription in interface Group

Returns:

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

getType

public GroupType getType()

Specified by:

getType in interface Group

Returns:

the type of the group.

getLowerName

public String getLowerName()

isLocal

public boolean isLocal()

Description copied from interface: InternalDirectoryGroup

Returns true if this is a Local Group.

Specified by:

isLocal in interface InternalDirectoryGroup

Returns:

true if this is a Local Group.

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

Specified by:

equals in class InternalEntity

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

Specified by:

hashCode in class InternalEntity

Returns:

hashcode.

compareTo

public int compareTo(Group o)

Specified by:

compareTo in interface Comparable<Group>

toString

public String toString()

Overrides:

toString in class Object