Package 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
A publicly mutable Group implementation.
Used to create or update a group.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionGroupTemplate
(Group group) Build a template from an existing group.GroupTemplate
(String name) GroupTemplate
(String name, long directoryId) Contructor that defaults theGroupType
toGroupType.GROUP
GroupTemplate
(String name, long directoryId, GroupType type) Build a template for a new group. -
Method Summary
Modifier and TypeMethodDescriptionint
boolean
Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().long
This will returnnull
for directories which do not support external idsgetName()
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
void
toString()
withDirectoryId
(long directoryId)
-
Constructor Details
-
GroupTemplate
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 seeGroupType
-
GroupTemplate
-
GroupTemplate
Contructor that defaults theGroupType
toGroupType.GROUP
- Parameters:
name
- the name of the groupdirectoryId
- ID of the directory in which to store the new group.
-
GroupTemplate
Build a template from an existing group.Used to update a group.
- Parameters:
group
- group to build template from.
-
-
Method Details
-
withDirectoryId
- 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
-
setDirectoryId
public void setDirectoryId(long directoryId) -
getDirectoryId
public long getDirectoryId()- Specified by:
getDirectoryId
in interfaceDirectoryEntity
- Returns:
- id of the directory in which the DirectoryEntity is stored.
-
getName
- Specified by:
getName
in interfaceDirectoryEntity
- Returns:
- name of the entity.
-
isActive
public boolean isActive() -
setActive
public void setActive(boolean active) -
getDescription
- Specified by:
getDescription
in interfaceGroup
- Returns:
- description of the group or
null
if there is no description.
-
setDescription
-
getType
-
setType
-
isLocal
public boolean isLocal() -
setLocal
public void setLocal(boolean local) -
getExternalId
Description copied from interface:Group
This will returnnull
for directories which do not support external ids- Specified by:
getExternalId
in interfaceGroup
- Returns:
- external id of the group or
null
it there is no external id
-
setExternalId
-
equals
Description copied from interface:DirectoryEntity
Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().- Specified by:
equals
in interfaceDirectoryEntity
- Overrides:
equals
in classObject
- 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 interfaceDirectoryEntity
- Overrides:
hashCode
in classObject
- Returns:
- hashcode.
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Group>
-
toString
-