Class GroupData

java.lang.Object
net.sf.basedb.core.data.BasicData
net.sf.basedb.core.data.GroupData
All Implemented Interfaces:
IdentifiableData, NameableData, RegisteredData, RemovableData, SystemData

public class GroupData
extends BasicData
implements NameableData, RemovableData, SystemData, RegisteredData
This class holds information about a group.
Version:
2.0
Author:
Nicklas
See Also:
Group, Developer documentation: User authentication
Last modified
$Date: 2015-11-17 13:57:57 +0100 (ti, 17 nov 2015) $
Hibernate: class
table="`Groups`" lazy="false"
  • Field Details

  • Constructor Details

    • GroupData

      public GroupData()
  • Method Details

    • getName

      public String getName()
      Description copied from interface: NameableData
      Get the name of the item.
      Specified by:
      getName in interface NameableData
      Returns:
      A String with the name of the item
    • setName

      public void setName​(String name)
      Description copied from interface: NameableData
      Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.
      Specified by:
      setName in interface NameableData
      Parameters:
      name - The new name for the item
    • getDescription

      public String getDescription()
      Description copied from interface: NameableData
      Get the description for the item.
      Specified by:
      getDescription in interface NameableData
      Returns:
      A String with a description of the item
    • setDescription

      public void setDescription​(String description)
      Description copied from interface: NameableData
      Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.
      Specified by:
      setDescription in interface NameableData
      Parameters:
      description - The new description for the item
    • getRemovedBy

      public Integer getRemovedBy()
      Description copied from interface: RemovableData
      Get the ID of the user that removed this item.
      Specified by:
      getRemovedBy in interface RemovableData
      Returns:
      The ID of a user or null if the item is not removed
    • setRemovedBy

      public void setRemovedBy​(Integer removedBy)
      Description copied from interface: RemovableData
      Set the ID of the user that removed this item or null to restore the item.
      Specified by:
      setRemovedBy in interface RemovableData
    • getSystemId

      public String getSystemId()
      Description copied from interface: SystemData
      Get the system id for the item.
      Specified by:
      getSystemId in interface SystemData
      Returns:
      The id of the item or null
    • setSystemId

      public void setSystemId​(String systemId)
    • getEntryDate

      public Date getEntryDate()
      Description copied from interface: RegisteredData
      Get the date this item was added to the database. The value is generated at creation time and can't be modified later.
      Specified by:
      getEntryDate in interface RegisteredData
    • setEntryDate

      public void setEntryDate​(Date entryDate)
    • getUsers

      public Set<UserData> getUsers()
      Get the set that manages which users are members of this group.
      Hibernate: set
      table="`UserGroups`" lazy="true"
      Hibernate: collection-key
      column="`group_id`"
      Hibernate: collection-many-to-many
      column="`user_id`" class="net.sf.basedb.core.data.UserData"
    • setUsers

      void setUsers​(Set<UserData> users)
    • getChildren

      public Set<GroupData> getChildren()
      Get the set that manages which other groups are members of this group.
      Hibernate: set
      table="`GroupGroups`" lazy="true"
      Hibernate: collection-key
      column="`parent_id`"
      Hibernate: collection-many-to-many
      column="`child_id`" class="net.sf.basedb.core.data.GroupData"
    • setChildren

      void setChildren​(Set<GroupData> children)
    • getParents

      Set<GroupData> getParents()
      This is the inverse end.
      See Also:
      getChildren()
      Hibernate: set
      table="`GroupGroups`" lazy="true"
      Hibernate: collection-key
      column="`child_id`"
      Hibernate: collection-many-to-many
      column="`parent_id`" class="net.sf.basedb.core.data.GroupData"
    • setParents

      void setParents​(Set<GroupData> parents)
    • getProjects

      Set<ProjectData> getProjects()
      This is the inverse end.
      See Also:
      ProjectData.getGroups()
      Hibernate: set
      table="`GroupProjects`" lazy="true"
      Hibernate: collection-key
      column="`group_id`"
      Hibernate: collection-many-to-many
      column="`project_id`" class="net.sf.basedb.core.data.ProjectData"
    • setProjects

      void setProjects​(Set<ProjectData> projects)
    • getItemKeys

      Set<ItemKeyData> getItemKeys()
      This is the inverse end.
      See Also:
      ItemKeyData.getGroups()
      Hibernate: set
      table="`GroupKeys`" lazy="true"
      Hibernate: collection-key
      column="`group_id`"
      Hibernate: collection-many-to-many
      column="`key_id`" class="net.sf.basedb.core.data.ItemKeyData"
    • setItemKeys

      void setItemKeys​(Set<ItemKeyData> itemKeys)
    • getQuota

      public QuotaData getQuota()
      Get the quota object which holds quota information for this group.
      Hibernate: many-to-one
      column="`quota_id`" not-null="false" outer-join="false"
    • setQuota

      public void setQuota​(QuotaData quota)
    • isDefault

      public boolean isDefault()
      If this group should be assigned to new users by default or not.
      Since:
      2.4
      Hibernate: property
      column="`is_default`" type="boolean" not-null="true"
    • setDefault

      public void setDefault​(boolean isDefault)
    • getHiddenMembers

      public boolean getHiddenMembers()
      A flag indicating if members of the group should be hidden to each other or not.
      Since:
      2.13
      Hibernate: property
      column="`hidden_members`" type="boolean" not-null="true"
    • setHiddenMembers

      public void setHiddenMembers​(boolean hiddenMembers)