Class BaseTorqueDynamicRole

All Implemented Interfaces:
Serializable, Role, SecurityEntity, DynamicRole, org.apache.torque.om.ObjectModel, org.apache.torque.om.Persistent
Direct Known Subclasses:
TorqueDynamicRole

public abstract class BaseTorqueDynamicRole extends TorqueAbstractDynamicRole implements org.apache.torque.om.Persistent, Serializable
This class was autogenerated by Torque on: [Fri Jan 03 13:59:28 CET 2025] You should not use this class directly. It should not even be extended; all references should be to TorqueDynamicRole
See Also:
  • Field Details

    • collTorqueDynamicRolePermissions

      protected List<TorqueDynamicRolePermission> collTorqueDynamicRolePermissions
      Defines the collTorqueDynamicRolePermissions field.
    • collTorqueDynamicGroupRoles

      protected List<TorqueDynamicGroupRole> collTorqueDynamicGroupRoles
      Defines the collTorqueDynamicGroupRoles field.
  • Constructor Details

    • BaseTorqueDynamicRole

      public BaseTorqueDynamicRole()
  • Method Details

    • getEntityId

      public Integer getEntityId()
      Get the value of entityId.
      Specified by:
      getEntityId in class TorqueAbstractSecurityEntity
      Returns:
      the value of entityId as Integer
    • setEntityId

      public void setEntityId(Integer v)
      Set the value of entityId.
      Specified by:
      setEntityId in class TorqueAbstractSecurityEntity
      Parameters:
      v - new value of entityId
    • getEntityName

      public String getEntityName()
      Get the value of entityName.
      Specified by:
      getEntityName in class TorqueAbstractSecurityEntity
      Returns:
      the value of entityName as String
    • setEntityName

      public void setEntityName(String v)
      Set the value of entityName.
      Specified by:
      setEntityName in class TorqueAbstractSecurityEntity
      Parameters:
      v - new value of entityName
    • isNew

      public boolean isNew()
      Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.
      Specified by:
      isNew in interface org.apache.torque.om.ObjectModel
      Returns:
      true, if the object has never been persisted.
    • setNew

      public void setNew(boolean isNew)
      Sets whether the object has ever been saved.
      Specified by:
      setNew in interface org.apache.torque.om.ObjectModel
      Parameters:
      isNew - true if the object has never been saved, false otherwise.
    • isModified

      public boolean isModified()
      Returns whether the object has been modified.
      Specified by:
      isModified in interface org.apache.torque.om.ObjectModel
      Returns:
      True if the object has been modified.
    • setModified

      public void setModified(boolean modified)
      Sets whether the object has been modified.
      Specified by:
      setModified in interface org.apache.torque.om.ObjectModel
      Parameters:
      modified - true if the object has been modified, false otherwise.
    • resetModified

      public void resetModified()
      Sets the modified state for the object to be false.
    • isSaving

      public boolean isSaving()
      Returns whether this object is currently saving.
      Returns:
      true if this object is currently saving, false otherwise.
    • setSaving

      public void setSaving(boolean saving)
      Sets whether this object is currently saving.
      Parameters:
      saving - true if this object is currently saving, false otherwise.
    • isLoading

      public boolean isLoading()
      Returns whether this object is currently being loaded from the database.
      Returns:
      true if this object is currently loading, false otherwise.
    • setLoading

      public void setLoading(boolean loading)
      Sets whether this object is currently being loaded from the database.
      Parameters:
      loading - true if this object is currently loading, false otherwise.
    • isDeleted

      public boolean isDeleted()
      Returns whether this object was deleted from the database. Note that this getter does not automatically reflect database state, it will be set to true by Torque if doDelete() was called with this object. Bulk deletes and deletes via primary key do not change this flag. Also, if doDelete() was called on an object which does not exist in the database, the deleted flag is set to true even if it was not deleted.
      Returns:
      true if this object was deleted, false otherwise.
    • setDeleted

      public void setDeleted(boolean deleted)
      Sets whether this object was deleted from the database.
      Parameters:
      deleted - true if this object was deleted, false otherwise.
    • initTorqueDynamicRolePermissions

      public List<TorqueDynamicRolePermission> initTorqueDynamicRolePermissions()
      Initializes the cache collTorqueDynamicRolePermissions for referenced objects. This, means, if collTorqueDynamicRolePermissions is null when this operation is called, it is initialized with an empty collection, otherwise it remains unchanged.
      Returns:
      the (possibly new) content of the field collTorqueDynamicRolePermissions, not null.
    • isTorqueDynamicRolePermissionsInitialized

      public boolean isTorqueDynamicRolePermissionsInitialized()
      Checks whether the cache collTorqueDynamicRolePermissions for referenced objects has either been loaded from the database or has been manually initialized.
      Returns:
      boolean true if initialized
    • addTorqueDynamicRolePermission

      public void addTorqueDynamicRolePermission(TorqueDynamicRolePermission toAdd) throws org.apache.torque.TorqueException
      Method called to associate a TorqueDynamicRolePermission object to this object through the collTorqueDynamicRolePermissions foreign key attribute. If the associated objects were not retrieved before and this object is not new, the associated objects are retrieved from the database before adding the toAdd object.
      Parameters:
      toAdd - the object to add to the associated objects, not null.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails.
      NullPointerException - if toAdd is null.
    • addTorqueDynamicRolePermission

      public void addTorqueDynamicRolePermission(TorqueDynamicRolePermission l, Connection con) throws org.apache.torque.TorqueException
      Method called to associate a TorqueDynamicRolePermission object to this object through the collTorqueDynamicRolePermissions foreign key attribute using connection.
      Parameters:
      l - TorqueDynamicRolePermission
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails.
    • resetTorqueDynamicRolePermission

      public void resetTorqueDynamicRolePermission()
      Method called to reset the cache of TorqueDynamicRolePermission objects which are related through the collTorqueDynamicRolePermissions foreign key attribute.
    • getTorqueDynamicRolePermissions

      public List<TorqueDynamicRolePermission> getTorqueDynamicRolePermissions() throws org.apache.torque.TorqueException
      If this collection has already been initialized, returns the collection. Otherwise returns the results of getTorqueDynamicRolePermissions(new Criteria())
      Returns:
      the collection of associated objects
      Throws:
      org.apache.torque.TorqueException
    • getTorqueDynamicRolePermissions

      public List<TorqueDynamicRolePermission> getTorqueDynamicRolePermissions(org.apache.torque.criteria.Criteria criteria) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole has previously been saved, it will retrieve related collTorqueDynamicRolePermissions from storage. If this BaseTorqueDynamicRole is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.
      Throws:
      org.apache.torque.TorqueException - If a problem occurs with the get[criteria] method.
    • getTorqueDynamicRolePermissions

      public List<TorqueDynamicRolePermission> getTorqueDynamicRolePermissions(Connection con) throws org.apache.torque.TorqueException
      If this collection has already been initialized, returns the collection. Otherwise returns the results of getTorqueDynamicRolePermissions(new Criteria(),Connection) This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input
      Parameters:
      con - the Connection
      Returns:
      List results of the collection
      Throws:
      org.apache.torque.TorqueException - If a problem occurs with the get[connection] method.
    • getTorqueDynamicRolePermissions

      public List<TorqueDynamicRolePermission> getTorqueDynamicRolePermissions(org.apache.torque.criteria.Criteria criteria, Connection con) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole has previously been saved, it will retrieve the related TorqueDynamicRolePermission Objects from storage. If this BaseTorqueDynamicRole is new, it will return an empty collection or the current collection, the criteria is ignored on a new object. This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input
      Parameters:
      con - the Connection
      Returns:
      List results of the collection
      Throws:
      org.apache.torque.TorqueException - If a problem occurs with the get[connection] method.
    • initTorqueDynamicGroupRoles

      public List<TorqueDynamicGroupRole> initTorqueDynamicGroupRoles()
      Initializes the cache collTorqueDynamicGroupRoles for referenced objects. This, means, if collTorqueDynamicGroupRoles is null when this operation is called, it is initialized with an empty collection, otherwise it remains unchanged.
      Returns:
      the (possibly new) content of the field collTorqueDynamicGroupRoles, not null.
    • isTorqueDynamicGroupRolesInitialized

      public boolean isTorqueDynamicGroupRolesInitialized()
      Checks whether the cache collTorqueDynamicGroupRoles for referenced objects has either been loaded from the database or has been manually initialized.
      Returns:
      boolean true if initialized
    • addTorqueDynamicGroupRole

      public void addTorqueDynamicGroupRole(TorqueDynamicGroupRole toAdd) throws org.apache.torque.TorqueException
      Method called to associate a TorqueDynamicGroupRole object to this object through the collTorqueDynamicGroupRoles foreign key attribute. If the associated objects were not retrieved before and this object is not new, the associated objects are retrieved from the database before adding the toAdd object.
      Parameters:
      toAdd - the object to add to the associated objects, not null.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails.
      NullPointerException - if toAdd is null.
    • addTorqueDynamicGroupRole

      public void addTorqueDynamicGroupRole(TorqueDynamicGroupRole l, Connection con) throws org.apache.torque.TorqueException
      Method called to associate a TorqueDynamicGroupRole object to this object through the collTorqueDynamicGroupRoles foreign key attribute using connection.
      Parameters:
      l - TorqueDynamicGroupRole
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails.
    • resetTorqueDynamicGroupRole

      public void resetTorqueDynamicGroupRole()
      Method called to reset the cache of TorqueDynamicGroupRole objects which are related through the collTorqueDynamicGroupRoles foreign key attribute.
    • getTorqueDynamicGroupRoles

      public List<TorqueDynamicGroupRole> getTorqueDynamicGroupRoles() throws org.apache.torque.TorqueException
      If this collection has already been initialized, returns the collection. Otherwise returns the results of getTorqueDynamicGroupRoles(new Criteria())
      Returns:
      the collection of associated objects
      Throws:
      org.apache.torque.TorqueException
    • getTorqueDynamicGroupRoles

      public List<TorqueDynamicGroupRole> getTorqueDynamicGroupRoles(org.apache.torque.criteria.Criteria criteria) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole has previously been saved, it will retrieve related collTorqueDynamicGroupRoles from storage. If this BaseTorqueDynamicRole is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.
      Throws:
      org.apache.torque.TorqueException - If a problem occurs with the get[criteria] method.
    • getTorqueDynamicGroupRoles

      public List<TorqueDynamicGroupRole> getTorqueDynamicGroupRoles(Connection con) throws org.apache.torque.TorqueException
      If this collection has already been initialized, returns the collection. Otherwise returns the results of getTorqueDynamicGroupRoles(new Criteria(),Connection) This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input
      Parameters:
      con - the Connection
      Returns:
      List results of the collection
      Throws:
      org.apache.torque.TorqueException - If a problem occurs with the get[connection] method.
    • getTorqueDynamicGroupRoles

      public List<TorqueDynamicGroupRole> getTorqueDynamicGroupRoles(org.apache.torque.criteria.Criteria criteria, Connection con) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole has previously been saved, it will retrieve the related TorqueDynamicGroupRole Objects from storage. If this BaseTorqueDynamicRole is new, it will return an empty collection or the current collection, the criteria is ignored on a new object. This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input
      Parameters:
      con - the Connection
      Returns:
      List results of the collection
      Throws:
      org.apache.torque.TorqueException - If a problem occurs with the get[connection] method.
    • getTorqueDynamicRolePermissionsJoinTorqueDynamicPermission

      protected List<TorqueDynamicRolePermission> getTorqueDynamicRolePermissionsJoinTorqueDynamicPermission(org.apache.torque.criteria.Criteria criteria) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole is new, it will return an empty collection; or if this thisObjectClassName has previously been saved, it will retrieve the related objects from storage. This method is protected by default in order to keep the public api reasonable. You can change the access modifier to public by overriding this method in the child class.
      Parameters:
      criteria - the criteria to use when filling the collection.
      Returns:
      List the collection
      Throws:
      org.apache.torque.TorqueException - if associated objects are not found
    • getTorqueDynamicRolePermissionsJoinTorqueDynamicPermission

      protected List<TorqueDynamicRolePermission> getTorqueDynamicRolePermissionsJoinTorqueDynamicPermission(org.apache.torque.criteria.Criteria criteria, Connection connection) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole is new, it will return an empty collection; or if this BaseTorqueDynamicRole has previously been saved, it will retrieve the related objects from storage. This method is protected by default in order to keep the public api reasonable. You can change the access modifier to public by overriding this method in the child class.
      Overrides:
      getTorqueDynamicRolePermissionsJoinTorqueDynamicPermission in class TorqueAbstractDynamicRole
      Parameters:
      criteria - Criteria to define the selection of records
      connection - a database connection
      Returns:
      a list of Role/Permission relations
      Throws:
      org.apache.torque.TorqueException - if any database error occurs
    • getTorqueDynamicGroupRolesJoinTorqueDynamicGroup

      protected List<TorqueDynamicGroupRole> getTorqueDynamicGroupRolesJoinTorqueDynamicGroup(org.apache.torque.criteria.Criteria criteria) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole is new, it will return an empty collection; or if this thisObjectClassName has previously been saved, it will retrieve the related objects from storage. This method is protected by default in order to keep the public api reasonable. You can change the access modifier to public by overriding this method in the child class.
      Parameters:
      criteria - the criteria to use when filling the collection.
      Returns:
      List the collection
      Throws:
      org.apache.torque.TorqueException - if associated objects are not found
    • getTorqueDynamicGroupRolesJoinTorqueDynamicGroup

      protected List<TorqueDynamicGroupRole> getTorqueDynamicGroupRolesJoinTorqueDynamicGroup(org.apache.torque.criteria.Criteria criteria, Connection connection) throws org.apache.torque.TorqueException
      If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueDynamicRole is new, it will return an empty collection; or if this BaseTorqueDynamicRole has previously been saved, it will retrieve the related objects from storage. This method is protected by default in order to keep the public api reasonable. You can change the access modifier to public by overriding this method in the child class.
      Overrides:
      getTorqueDynamicGroupRolesJoinTorqueDynamicGroup in class TorqueAbstractDynamicRole
      Parameters:
      criteria - Criteria to define the selection of records
      connection - a database connection
      Returns:
      a list of Group/Role relations
      Throws:
      org.apache.torque.TorqueException - if any database error occurs
    • save

      public void save() throws org.apache.torque.TorqueException
      Stores an object in the database. If the object is new, it is inserted; otherwise an update is performed.
      Specified by:
      save in interface org.apache.torque.om.Persistent
      Throws:
      org.apache.torque.TorqueException - if an error occurs during saving.
    • save

      public void save(String dbName) throws org.apache.torque.TorqueException
      Stores an object in the database. If the object is new, it is inserted; otherwise an update is performed.
      Specified by:
      save in interface org.apache.torque.om.Persistent
      Parameters:
      dbName - the name of the database to which the object should be saved.
      Throws:
      org.apache.torque.TorqueException - if an error occurs during saving.
    • save

      public void save(Connection con) throws org.apache.torque.TorqueException
      Stores an object in the database. If the object is new, it is inserted; otherwise an update is performed. This method is meant to be used as part of a transaction, otherwise use the save() method and the connection details will be handled internally.
      Specified by:
      save in interface org.apache.torque.om.Persistent
      Parameters:
      con - the connection to use for saving the object, not null.
      Throws:
      org.apache.torque.TorqueException - if an error occurs during saving.
    • setPrimaryKey

      public void setPrimaryKey(org.apache.torque.om.ObjectKey<?> key)
      Set the PrimaryKey using ObjectKey.
      Specified by:
      setPrimaryKey in interface org.apache.torque.om.ObjectModel
      Parameters:
      key - entityId ObjectKey
    • setPrimaryKey

      public void setPrimaryKey(String key)
      Set the PrimaryKey using a String.
      Specified by:
      setPrimaryKey in interface org.apache.torque.om.ObjectModel
      Parameters:
      key - the primary key to set.
    • getPrimaryKey

      public org.apache.torque.om.ObjectKey<?> getPrimaryKey()
      returns an id that differentiates this object from others of its class.
      Specified by:
      getPrimaryKey in interface org.apache.torque.om.ObjectModel
    • copy

      public TorqueDynamicRole copy() throws org.apache.torque.TorqueException
      Makes a copy of this object. It creates a new object filling in the simple attributes. It then fills all the association collections and sets the related objects to isNew=true.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • copy

      public TorqueDynamicRole copy(Connection con) throws org.apache.torque.TorqueException
      Makes a copy of this object using a connection. It creates a new object filling in the simple attributes. It then fills all the association collections and sets the related objects to isNew=true.
      Parameters:
      con - the database connection to read associated objects.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • copy

      public TorqueDynamicRole copy(boolean deepcopy) throws org.apache.torque.TorqueException
      Makes a copy of this object. It creates a new object filling in the simple attributes. If the parameter deepcopy is true, it then fills all the association collections and sets the related objects to isNew=true.
      Parameters:
      deepcopy - whether to copy the associated objects.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • copy

      public TorqueDynamicRole copy(boolean deepcopy, Connection con) throws org.apache.torque.TorqueException
      Makes a copy of this object using connection. It creates a new object filling in the simple attributes. If the parameter deepcopy is true, it then fills all the association collections and sets the related objects to isNew=true.
      Parameters:
      deepcopy - whether to copy the associated objects.
      con - the database connection to read associated objects.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • copyInto

      public TorqueDynamicRole copyInto(TorqueDynamicRole copyObj) throws org.apache.torque.TorqueException
      Fills the copyObj with the contents of this object. The associated objects are also copied and treated as new objects.
      Parameters:
      copyObj - the object to fill.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • copyInto

      public TorqueDynamicRole copyInto(TorqueDynamicRole copyObj, Connection con) throws org.apache.torque.TorqueException
      Fills the copyObj with the contents of this object using connection. The associated objects are also copied and treated as new objects.
      Parameters:
      copyObj - the object to fill.
      con - the database connection to read associated objects.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • copyInto

      protected TorqueDynamicRole copyInto(TorqueDynamicRole copyObj, boolean deepcopy) throws org.apache.torque.TorqueException
      Fills the copyObj with the contents of this object. If deepcopy is true, The associated objects are also copied and treated as new objects.
      Parameters:
      copyObj - the object to fill.
      deepcopy - whether the associated objects should be copied.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • copyInto

      public TorqueDynamicRole copyInto(TorqueDynamicRole copyObj, boolean deepcopy, Connection con) throws org.apache.torque.TorqueException
      Fills the copyObj with the contents of this object using connection. If deepcopy is true, The associated objects are also copied and treated as new objects.
      Parameters:
      copyObj - the object to fill.
      deepcopy - whether the associated objects should be copied.
      con - the database connection to read associated objects.
      Throws:
      org.apache.torque.TorqueException - if retrieval of the associated objects fails
    • getPeer

      public TorqueDynamicRolePeer getPeer()
      returns a peer instance associated with this om. Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.
    • getTableMap

      public org.apache.torque.map.TableMap getTableMap() throws org.apache.torque.TorqueException
      Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
      Returns:
      The associated TableMap object.
      Throws:
      org.apache.torque.TorqueException - if associated objects are not found
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • equals

      public boolean equals(Object toCompare)
      Compares the primary key of this instance with the key of another.
      Overrides:
      equals in class Object
      Parameters:
      toCompare - The object to compare to.
      Returns:
      Whether the primary keys are equal and the object have the same class.
    • hashCode

      public int hashCode()
      If the primary key is not null, return the hashcode of the primary key. Otherwise calls Object.hashCode().
      Overrides:
      hashCode in class Object
      Returns:
      an int value
    • valueEquals

      public boolean valueEquals(TorqueDynamicRole toCompare)
      Compares the content of this object to another object
      Parameters:
      toCompare - The object to compare to.
      Returns:
      true if all of the columns in the other object have the same value as the objects in this class.