Class BaseTorqueBasicUserPeerImpl

java.lang.Object
org.apache.torque.util.BasePeerImpl<TorqueBasicUser>
org.apache.torque.util.AbstractPeerImpl<TorqueBasicUser>
org.apache.fulcrum.security.torque.om.BaseTorqueBasicUserPeerImpl
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TorqueBasicUserPeerImpl

public abstract class BaseTorqueBasicUserPeerImpl extends org.apache.torque.util.AbstractPeerImpl<TorqueBasicUser>
The skeleton for this class was autogenerated by Torque on: [Fri Jan 03 13:59:32 CET 2025] You should not use this class directly. It should not even be extended; all references should be to TorqueBasicUserPeer
See Also:
  • Constructor Details

    • BaseTorqueBasicUserPeerImpl

      public BaseTorqueBasicUserPeerImpl()
      Constructor. The recordMapper, tableMap and databaseName fields are correctly initialized.
    • BaseTorqueBasicUserPeerImpl

      public BaseTorqueBasicUserPeerImpl(org.apache.torque.om.mapper.RecordMapper<TorqueBasicUser> recordMapper, org.apache.torque.map.TableMap tableMap, String databaseName)
      Constructor providing the objects to be injected as parameters.
      Parameters:
      recordMapper - a record mapper to map JDBC result sets to objects
      tableMap - the default table map
      databaseName - the name of the database
  • Method Details

    • getDbObjectInstance

      public TorqueBasicUser getDbObjectInstance()
      Returns a new instance of the Data object class
    • doUpdate

      public int doUpdate(org.apache.torque.util.ColumnValues columnValues, Connection con) throws org.apache.torque.TorqueException
      Method to do updates. This method is to be used during a transaction, otherwise use the doUpdate(Criteria) method.
      Overrides:
      doUpdate in class org.apache.torque.util.BasePeerImpl<TorqueBasicUser>
      Parameters:
      columnValues - the values to update plus the primary key identifying the row to update.
      con - the connection to use, not null.
      Returns:
      the number of affected rows.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • doDelete

      public int doDelete(TorqueBasicUser obj) throws org.apache.torque.TorqueException
      Deletes a data object, i.e. a row in a table, in the database.
      Parameters:
      obj - the data object to delete in the database, not null.
      Returns:
      the number of deleted rows.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • doDelete

      public int doDelete(TorqueBasicUser obj, Connection con) throws org.apache.torque.TorqueException
      Deletes a data object, i.e. a row in a table, in the database. This method is to be used during a transaction, otherwise use the doDelete(TorqueBasicUser) method.
      Parameters:
      obj - the data object to delete in the database, not null.
      con - the connection to use, not null.
      Returns:
      the number of deleted rows.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • doDelete

      public int doDelete(Collection<TorqueBasicUser> objects) throws org.apache.torque.TorqueException
      Deletes data objects, i.e. rows in a table, in the database.
      Parameters:
      objects - the data object to delete in the database, not null, may not contain null.
      Returns:
      the number of deleted rows.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • doDelete

      public int doDelete(Collection<TorqueBasicUser> objects, Connection con) throws org.apache.torque.TorqueException
      Deletes data objects, i.e. rows in a table, in the database. This method uses the passed connection to delete the rows; if a transaction is open in the connection, the deletion happens inside this transaction.
      Parameters:
      objects - the data objects to delete in the database, not null, may not contain null.
      con - the connection to use for deleting, not null.
      Returns:
      the number of deleted rows.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • buildCriteria

      public org.apache.torque.criteria.Criteria buildCriteria(org.apache.torque.om.ObjectKey<?> pk)
      Build a Criteria object which selects all objects which have a given primary key.
      Overrides:
      buildCriteria in class org.apache.torque.util.AbstractPeerImpl<TorqueBasicUser>
      Parameters:
      pk - the primary key value to build the criteria from, not null.
    • buildCriteria

      public org.apache.torque.criteria.Criteria buildCriteria(Collection<org.apache.torque.om.ObjectKey<?>> pks)
      Build a Criteria object which selects all objects which primary keys are contained in the passed collection.
      Parameters:
      pks - the primary key values to build the criteria from, not null, may not contain null.
    • buildPkCriteria

      public org.apache.torque.criteria.Criteria buildPkCriteria(Collection<TorqueBasicUser> objects)
      Build a Criteria object which selects all passed objects using their primary key. Objects which do not yet have a primary key are ignored.
      Parameters:
      objects - the objects to build the criteria from, not null, may not contain null.
    • buildCriteria

      public org.apache.torque.criteria.Criteria buildCriteria(TorqueBasicUser obj)
      Build a Criteria object from the data object for this peer. The primary key columns are only added if the object is not new.
      Specified by:
      buildCriteria in class org.apache.torque.util.AbstractPeerImpl<TorqueBasicUser>
      Parameters:
      obj - the object to build the criteria from, not null.
    • buildSelectCriteria

      public org.apache.torque.criteria.Criteria buildSelectCriteria(TorqueBasicUser obj)
      Build a Criteria object from the data object for this peer, skipping all binary columns.
      Specified by:
      buildSelectCriteria in class org.apache.torque.util.AbstractPeerImpl<TorqueBasicUser>
      Parameters:
      obj - the object to build the criteria from, not null.
    • buildColumnValues

      public org.apache.torque.util.ColumnValues buildColumnValues(TorqueBasicUser torqueBasicUser) throws org.apache.torque.TorqueException
      Returns the contents of the object as ColumnValues object. Primary key columns which are generated on insertion are not added to the returned object if they still have their initial value. Also, columns which have the useDatabaseDefaultValue flag set to true are also not added to the returned object if they still have their initial value.
      Specified by:
      buildColumnValues in class org.apache.torque.util.AbstractPeerImpl<TorqueBasicUser>
      Throws:
      org.apache.torque.TorqueException - if the table map cannot be retrieved (should not happen).
    • retrieveByPK

      public TorqueBasicUser retrieveByPK(Integer pk) throws org.apache.torque.TorqueException, org.apache.torque.NoRowsException, org.apache.torque.TooManyRowsException
      Retrieve a single object by pk
      Parameters:
      pk - the primary key
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
      org.apache.torque.NoRowsException - Primary key was not found in database.
      org.apache.torque.TooManyRowsException - Primary key was not found in database.
    • retrieveByPK

      public TorqueBasicUser retrieveByPK(Integer pk, Connection con) throws org.apache.torque.TorqueException, org.apache.torque.NoRowsException, org.apache.torque.TooManyRowsException
      Retrieve a single object by pk
      Parameters:
      pk - the primary key
      con - the connection to use
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
      org.apache.torque.NoRowsException - Primary key was not found in database.
      org.apache.torque.TooManyRowsException - Primary key was not found in database.
    • retrieveByPK

      public TorqueBasicUser retrieveByPK(org.apache.torque.om.ObjectKey<?> pk) throws org.apache.torque.TorqueException, org.apache.torque.NoRowsException, org.apache.torque.TooManyRowsException
      Retrieve a single object by pk
      Parameters:
      pk - the primary key
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
      org.apache.torque.NoRowsException - Primary key was not found in database.
      org.apache.torque.TooManyRowsException - Primary key was not found in database.
    • retrieveByPK

      public TorqueBasicUser retrieveByPK(org.apache.torque.om.ObjectKey<?> pk, Connection con) throws org.apache.torque.TorqueException, org.apache.torque.NoRowsException, org.apache.torque.TooManyRowsException
      Retrieve a single object by pk
      Parameters:
      pk - the primary key
      con - the connection to use
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
      org.apache.torque.NoRowsException - Primary key was not found in database.
      org.apache.torque.TooManyRowsException - Primary key was not found in database.
    • retrieveByTypedPKs

      public List<TorqueBasicUser> retrieveByTypedPKs(Collection<Integer> pks) throws org.apache.torque.TorqueException
      Retrieve multiple objects by pk.
      Parameters:
      pks - List of primary keys. Entries in pks which do not match entries in the database are ignored.
      Returns:
      the list of matching objects, not null.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • retrieveByTypedPKs

      public List<TorqueBasicUser> retrieveByTypedPKs(Collection<Integer> pks, Connection dbcon) throws org.apache.torque.TorqueException
      Retrieve multiple objects by pk.
      Parameters:
      pks - List of primary keys. Entries in pks which do not match entries in the database are ignored.
      dbcon - the connection to use
      Returns:
      the list of matching objects, not null.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • retrieveByObjectKeys

      public List<TorqueBasicUser> retrieveByObjectKeys(Collection<org.apache.torque.om.ObjectKey<?>> pks) throws org.apache.torque.TorqueException
      Retrieve multiple objects by pk.
      Parameters:
      pks - List of primary keys. Entries in pks which do not match entries in the database are ignored.
      Returns:
      the list of matching objects, not null.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • retrieveByObjectKeys

      public List<TorqueBasicUser> retrieveByObjectKeys(Collection<org.apache.torque.om.ObjectKey<?>> pks, Connection dbcon) throws org.apache.torque.TorqueException
      Retrieve multiple objects by pk.
      Parameters:
      pks - List of primary keys. Entries in pks which do not match entries in the database are ignored.
      dbcon - the connection to use
      Returns:
      the list of matching objects, not null.
      Throws:
      org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
    • setAndSaveTorqueBasicUserGroups

      public void setAndSaveTorqueBasicUserGroups(TorqueBasicUser toLinkTo, Collection<TorqueBasicUserGroup> toSave) throws org.apache.torque.TorqueException
      Saves the passed collection as linked objects. This means the following is done:
      • The current collection of objects which are linked to toLinkTo and which are also in the list toSave is read from the database into the list intersection.
      • All objects in toSave which are not in intersection are inserted.
      • All objects in intersection are updated with the corresponding values in toSave and saved.
      • All objects in the database which are linked to toLinkTo but are not in toSave are deleted from the database.
      Parameters:
      toLinkTo - the object which collections should be set with the values in toSave.
      toSave - Contains the objects to save, not null, may not contain null.
      Throws:
      org.apache.torque.TorqueException - if an error accessing the database occurs.
      NullPointerException - if toSave is null or contains null elements.
    • setAndSaveTorqueBasicUserGroups

      public void setAndSaveTorqueBasicUserGroups(TorqueBasicUser toLinkTo, Collection<TorqueBasicUserGroup> toSave, Connection connection) throws org.apache.torque.TorqueException
      Saves the passed collection as linked objects. This means the following is done:
      • The current collection of objects which are linked to toLinkTo and which are also in the list toSave is read from the database into the list intersection.
      • All objects in toSave which are not in intersection are inserted.
      • All objects in intersection are updated with the corresponding values in toSave and saved.
      • All objects in the database which are linked to toLinkTo but are not in toSave are deleted from the database.
      Parameters:
      toLinkTo - the object which collections should be set with the values in toSave.
      toSave - Contains the objects to save, not null, may not contain null.
      connection - the database connection to use.
      Throws:
      org.apache.torque.TorqueException - if an error accessing the database occurs.
      NullPointerException - if toSave is null or contains null elements.