Class BaseTorqueBasicGroup
java.lang.Object
org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity
org.apache.fulcrum.security.torque.basic.TorqueAbstractBasicGroup
org.apache.fulcrum.security.torque.om.BaseTorqueBasicGroup
- All Implemented Interfaces:
Serializable,Group,SecurityEntity,BasicGroup,org.apache.torque.om.ObjectModel,org.apache.torque.om.Persistent
- Direct Known Subclasses:
TorqueBasicGroup
public abstract class BaseTorqueBasicGroup extends TorqueAbstractBasicGroup implements org.apache.torque.om.Persistent, Serializable
This class was autogenerated by Torque on:
[Wed Dec 23 13:20:03 CET 2020]
You should not use this class directly. It should not even be
extended; all references should be to TorqueBasicGroup
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected List<TorqueBasicUserGroup>collTorqueBasicUserGroupsDefines the collTorqueBasicUserGroups field. -
Constructor Summary
Constructors Constructor Description BaseTorqueBasicGroup() -
Method Summary
Modifier and Type Method Description voidaddTorqueBasicUserGroup(TorqueBasicUserGroup toAdd)Method called to associate a TorqueBasicUserGroup object to this object through the collTorqueBasicUserGroups foreign key attribute.voidaddTorqueBasicUserGroup(TorqueBasicUserGroup l, Connection con)Method called to associate a TorqueBasicUserGroup object to this object through the collTorqueBasicUserGroups foreign key attribute using connection.TorqueBasicGroupcopy()Makes a copy of this object.TorqueBasicGroupcopy(boolean deepcopy)Makes a copy of this object.TorqueBasicGroupcopy(boolean deepcopy, Connection con)Makes a copy of this object using connection.TorqueBasicGroupcopy(Connection con)Makes a copy of this object using a connection.TorqueBasicGroupcopyInto(TorqueBasicGroup copyObj)Fills the copyObj with the contents of this object.protected TorqueBasicGroupcopyInto(TorqueBasicGroup copyObj, boolean deepcopy)Fills the copyObj with the contents of this object.TorqueBasicGroupcopyInto(TorqueBasicGroup copyObj, boolean deepcopy, Connection con)Fills the copyObj with the contents of this object using connection.TorqueBasicGroupcopyInto(TorqueBasicGroup copyObj, Connection con)Fills the copyObj with the contents of this object using connection.booleanequals(Object toCompare)Compares the primary key of this instance with the key of another.IntegergetEntityId()Get the value of entityId.StringgetEntityName()Get the value of entityName.TorqueBasicGroupPeergetPeer()returns a peer instance associated with this om.org.apache.torque.om.ObjectKey<?>getPrimaryKey()returns an id that differentiates this object from others of its class.org.apache.torque.map.TableMapgetTableMap()Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().List<TorqueBasicUserGroup>getTorqueBasicUserGroups()If this collection has already been initialized, returns the collection.List<TorqueBasicUserGroup>getTorqueBasicUserGroups(Connection con)If this collection has already been initialized, returns the collection.List<TorqueBasicUserGroup>getTorqueBasicUserGroups(org.apache.torque.criteria.Criteria criteria)If this collection has already been initialized with an identical criteria, it returns the collection.List<TorqueBasicUserGroup>getTorqueBasicUserGroups(org.apache.torque.criteria.Criteria criteria, Connection con)If this collection has already been initialized with an identical criteria, it returns the collection.protected List<TorqueBasicUserGroup>getTorqueBasicUserGroupsJoinTorqueBasicUser(org.apache.torque.criteria.Criteria criteria)If this collection has already been initialized with an identical criteria, it returns the collection.protected List<TorqueBasicUserGroup>getTorqueBasicUserGroupsJoinTorqueBasicUser(org.apache.torque.criteria.Criteria criteria, Connection connection)If this collection has already been initialized with an identical criteria, it returns the collection.inthashCode()If the primary key is notnull, return the hashcode of the primary key.List<TorqueBasicUserGroup>initTorqueBasicUserGroups()Initializes the cache collTorqueBasicUserGroups for referenced objects.booleanisDeleted()Returns whether this object was deleted from the database.booleanisLoading()Returns whether this object is currently being loaded from the database.booleanisModified()Returns whether the object has been modified.booleanisNew()Returns whether the object has ever been saved.booleanisSaving()Returns whether this object is currently saving.booleanisTorqueBasicUserGroupsInitialized()Checks whether the cache collTorqueBasicUserGroups for referenced objects has either been loaded from the database or has been manually initialized.voidresetModified()Sets the modified state for the object to be false.voidresetTorqueBasicUserGroup()Method called to reset the cache of TorqueBasicUserGroup objects which are related through the collTorqueBasicUserGroups foreign key attribute.voidsave()Stores an object in the database.voidsave(String dbName)Stores an object in the database.voidsave(Connection con)Stores an object in the database.voidsetDeleted(boolean deleted)Sets whether this object was deleted from the database.voidsetEntityId(Integer v)Set the value of entityId.voidsetEntityName(String v)Set the value of entityName.voidsetLoading(boolean loading)Sets whether this object is currently being loaded from the database.voidsetModified(boolean modified)Sets whether the object has been modified.voidsetNew(boolean isNew)Sets whether the object has ever been saved.voidsetPrimaryKey(String key)Set the PrimaryKey using a String.voidsetPrimaryKey(org.apache.torque.om.ObjectKey<?> key)Set the PrimaryKey using ObjectKey.voidsetSaving(boolean saving)Sets whether this object is currently saving.StringtoString()booleanvalueEquals(TorqueBasicGroup toCompare)Compares the content of this object to another objectMethods inherited from class org.apache.fulcrum.security.torque.basic.TorqueAbstractBasicGroup
addUser, delete, getDatabaseName, getUsers, getUsersAsSet, removeUser, retrieveAttachedObjects, retrieveAttachedObjects, setUsers, setUsersAsSet, updateMethods inherited from class org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity
getId, getName, setId, setNameMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.fulcrum.security.entity.SecurityEntity
getId, getName, setId, setName
-
Field Details
-
collTorqueBasicUserGroups
Defines the collTorqueBasicUserGroups field.
-
-
Constructor Details
-
BaseTorqueBasicGroup
public BaseTorqueBasicGroup()
-
-
Method Details
-
getEntityId
Get the value of entityId.- Specified by:
getEntityIdin classTorqueAbstractSecurityEntity- Returns:
- the value of entityId as Integer
-
setEntityId
Set the value of entityId.- Specified by:
setEntityIdin classTorqueAbstractSecurityEntity- Parameters:
v- new value of entityId
-
getEntityName
Get the value of entityName.- Specified by:
getEntityNamein classTorqueAbstractSecurityEntity- Returns:
- the value of entityName as String
-
setEntityName
Set the value of entityName.- Specified by:
setEntityNamein classTorqueAbstractSecurityEntity- 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:
isNewin interfaceorg.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:
setNewin interfaceorg.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:
isModifiedin interfaceorg.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:
setModifiedin interfaceorg.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.
-
initTorqueBasicUserGroups
Initializes the cache collTorqueBasicUserGroups for referenced objects. This, means, if collTorqueBasicUserGroups 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 collTorqueBasicUserGroups, not null.
-
isTorqueBasicUserGroupsInitialized
public boolean isTorqueBasicUserGroupsInitialized()Checks whether the cache collTorqueBasicUserGroups for referenced objects has either been loaded from the database or has been manually initialized.- Returns:
- boolean true if initialized
-
addTorqueBasicUserGroup
public void addTorqueBasicUserGroup(TorqueBasicUserGroup toAdd) throws org.apache.torque.TorqueExceptionMethod called to associate a TorqueBasicUserGroup object to this object through the collTorqueBasicUserGroups 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 thetoAddobject.- 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.
-
addTorqueBasicUserGroup
public void addTorqueBasicUserGroup(TorqueBasicUserGroup l, Connection con) throws org.apache.torque.TorqueExceptionMethod called to associate a TorqueBasicUserGroup object to this object through the collTorqueBasicUserGroups foreign key attribute using connection.- Parameters:
l- TorqueBasicUserGroup- Throws:
org.apache.torque.TorqueException- if retrieval of the associated objects fails.
-
resetTorqueBasicUserGroup
public void resetTorqueBasicUserGroup()Method called to reset the cache of TorqueBasicUserGroup objects which are related through the collTorqueBasicUserGroups foreign key attribute. -
getTorqueBasicUserGroups
public List<TorqueBasicUserGroup> getTorqueBasicUserGroups() throws org.apache.torque.TorqueExceptionIf this collection has already been initialized, returns the collection. Otherwise returns the results of getTorqueBasicUserGroups(new Criteria())- Returns:
- the collection of associated objects
- Throws:
org.apache.torque.TorqueException
-
getTorqueBasicUserGroups
public List<TorqueBasicUserGroup> getTorqueBasicUserGroups(org.apache.torque.criteria.Criteria criteria) throws org.apache.torque.TorqueExceptionIf this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueBasicGroup has previously been saved, it will retrieve related collTorqueBasicUserGroups from storage. If this BaseTorqueBasicGroup 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.
-
getTorqueBasicUserGroups
public List<TorqueBasicUserGroup> getTorqueBasicUserGroups(Connection con) throws org.apache.torque.TorqueExceptionIf this collection has already been initialized, returns the collection. Otherwise returns the results of getTorqueBasicUserGroups(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.
-
getTorqueBasicUserGroups
public List<TorqueBasicUserGroup> getTorqueBasicUserGroups(org.apache.torque.criteria.Criteria criteria, Connection con) throws org.apache.torque.TorqueExceptionIf this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueBasicGroup has previously been saved, it will retrieve the related TorqueBasicUserGroup Objects from storage. If this BaseTorqueBasicGroup 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.
-
getTorqueBasicUserGroupsJoinTorqueBasicUser
protected List<TorqueBasicUserGroup> getTorqueBasicUserGroupsJoinTorqueBasicUser(org.apache.torque.criteria.Criteria criteria) throws org.apache.torque.TorqueExceptionIf this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueBasicGroup 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
-
getTorqueBasicUserGroupsJoinTorqueBasicUser
protected List<TorqueBasicUserGroup> getTorqueBasicUserGroupsJoinTorqueBasicUser(org.apache.torque.criteria.Criteria criteria, Connection connection) throws org.apache.torque.TorqueExceptionIf this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this BaseTorqueBasicGroup is new, it will return an empty collection; or if this BaseTorqueBasicGroup 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:
getTorqueBasicUserGroupsJoinTorqueBasicUserin classTorqueAbstractBasicGroup- Parameters:
criteria- Criteria to define the selection of recordsconnection- a database connection- Returns:
- a list of User/Group relations
- Throws:
org.apache.torque.TorqueException- if any database error occurs
-
save
public void save() throws org.apache.torque.TorqueExceptionStores an object in the database. If the object is new, it is inserted; otherwise an update is performed.- Specified by:
savein interfaceorg.apache.torque.om.Persistent- Throws:
org.apache.torque.TorqueException- if an error occurs during saving.
-
save
Stores an object in the database. If the object is new, it is inserted; otherwise an update is performed.- Specified by:
savein interfaceorg.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
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:
savein interfaceorg.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:
setPrimaryKeyin interfaceorg.apache.torque.om.ObjectModel- Parameters:
key- entityId ObjectKey
-
setPrimaryKey
Set the PrimaryKey using a String.- Specified by:
setPrimaryKeyin interfaceorg.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:
getPrimaryKeyin interfaceorg.apache.torque.om.ObjectModel
-
copy
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
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
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 TorqueBasicGroup copy(boolean deepcopy, Connection con) throws org.apache.torque.TorqueExceptionMakes 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 TorqueBasicGroup copyInto(TorqueBasicGroup copyObj) throws org.apache.torque.TorqueExceptionFills 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 TorqueBasicGroup copyInto(TorqueBasicGroup copyObj, Connection con) throws org.apache.torque.TorqueExceptionFills 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 TorqueBasicGroup copyInto(TorqueBasicGroup copyObj, boolean deepcopy) throws org.apache.torque.TorqueExceptionFills 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 TorqueBasicGroup copyInto(TorqueBasicGroup copyObj, boolean deepcopy, Connection con) throws org.apache.torque.TorqueExceptionFills 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
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.TorqueExceptionRetrieves 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
-
equals
Compares the primary key of this instance with the key of another. -
hashCode
public int hashCode()If the primary key is notnull, return the hashcode of the primary key. Otherwise callsObject.hashCode(). -
valueEquals
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.
-