Package net.sf.basedb.core.data

Class RoleData

java.lang.Object
net.sf.basedb.core.data.BasicData
net.sf.basedb.core.data.RoleData
All Implemented Interfaces:
IdentifiableData, NameableData, RegisteredData, RemovableData, SystemData
public class RoleData
extends BasicData
implements NameableData, RemovableData, SystemData, RegisteredData
This class holds information about a role.
Version:
2.0
Author:
Nicklas
See Also:
Role, Developer documentation: User authentication
Last modified
$Date: 2015-11-17 13:57:57 +0100 (ti, 17 nov 2015) $
Hibernate: class
table="`Roles`" lazy="false"

  • Field Details

    • name

      private String name

    • description

      private String description

    • removedBy

      private Integer removedBy

    • systemId

      private String systemId

    • entryDate

      private Date entryDate

    • users

      private Set<UserData> users

    • keys

      private Set<RoleKeyData> keys

    • isDefault

      private boolean isDefault

  • Constructor Details

    • RoleData

      public RoleData()

  • 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 role.
      Hibernate: set
      table="`UserRoles`" lazy="true"
      Hibernate: collection-key
      column="`role_id`"
      Hibernate: collection-many-to-many
      column="`user_id`" class="net.sf.basedb.core.data.UserData"

    • setUsers

      void setUsers​(Set<UserData> users)

    • getKeys

      Set<RoleKeyData> getKeys()
      This is the inverse end.
      See Also:
      RoleKeyData.getRoles()
      Hibernate: set
      table="`RoleKeys`" lazy="true"
      Hibernate: collection-key
      column="`role_id`"
      Hibernate: collection-many-to-many
      column="`key_id`" class="net.sf.basedb.core.data.RoleKeyData"

    • setKeys

      void setKeys​(Set<RoleKeyData> keys)

    • isDefault

      public boolean isDefault()
      If this role 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)