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
public class GroupTemplate extends Object implements Group, Serializable
A publicly mutable Group implementation.

Used to create or update a group.

See Also:

  • Constructor Details

    • 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 Details

    • 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

    • getName

      public String getName()
      Specified by:
      getName in interface DirectoryEntity

    • isActive

      public boolean isActive()
      Specified by:
      isActive in interface Group

    • setActive

      public void setActive(boolean active)

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface Group

    • setDescription

      public void setDescription(String description)

    • getType

      public GroupType getType()
      Specified by:
      getType in interface Group

    • setType

      public void setType(GroupType type)

    • isLocal

      public boolean isLocal()

    • setLocal

      public void setLocal(boolean local)

    • getExternalId

      @Nullable public String getExternalId()
      Specified by:
      getExternalId in interface Group

    • setExternalId

      public void setExternalId(String externalId)

    • equals

      public boolean equals(Object o)
      Specified by:
      equals in interface DirectoryEntity
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface DirectoryEntity
      Overrides:
      hashCode in class Object

    • compareTo

      public int compareTo(Group other)
      Specified by:
      compareTo in interface Comparable<Group>

    • toString

      public String toString()
      Overrides:
      toString in class Object