org.tigris.scarab.om
Class BaseAttachmentType

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseAttachmentType

All Implemented Interfaces:

org.apache.torque.om.Persistent, org.apache.fulcrum.intake.Retrievable, java.io.Serializable

Direct Known Subclasses:

AttachmentType

public abstract class BaseAttachmentType

extends org.apache.torque.om.BaseObject

implements org.apache.fulcrum.intake.Retrievable

You should not use this class directly. It should not even be extended all references should be to AttachmentType

See Also:

Serialized Form

Field Summary

protected java.util.List

collAttachments Collection to store aggregation of collAttachments

Fields inherited from class org.apache.torque.om.BaseObject

NEW_ID

Constructor Summary

BaseAttachmentType()

Method Summary

void	addAttachment(Attachment l) Method called to associate a Attachment object to this object through the Attachment foreign key attribute
AttachmentType	copy() Makes a copy of this object.
protected AttachmentType	copyInto(AttachmentType copyObj)
java.util.List	getAttachments() If this collection has already been initialized, returns the collection.
java.util.List	getAttachments(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getAttachments(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getAttachments(org.apache.torque.util.Criteria criteria, java.sql.Connection con) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getAttachmentsJoinAttachmentType(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getAttachmentsJoinIssue(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getAttachmentsJoinScarabUserImplRelatedByCreatedBy(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getAttachmentsJoinScarabUserImplRelatedByModifiedBy(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.Integer	getAttachmentTypeId() Get the AttachmentTypeId
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPeerName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPosition(int pos) Retrieves a field from the object by Position as specified in the xml schema.
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.String	getName() Get the Name
AttachmentTypePeer	getPeer() 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.
java.lang.String	getQueryKey() get an id that differentiates this object from others of its class.
boolean	getSearchable() Get the Searchable
protected void	initAttachments() Temporary storage of collAttachments to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected boolean	isCacheOnSave() Specify whether to cache the object after saving to the db.
void	save() Stores the object in the database.
void	save(java.sql.Connection con) Stores the object in the database.
void	save(java.lang.String dbName) Stores the object in the database.
void	setAttachmentTypeId(java.lang.Integer v) Set the value of AttachmentTypeId
void	setName(java.lang.String v) Set the value of Name
void	setPrimaryKey(org.apache.torque.om.ObjectKey key) Set the PrimaryKey using ObjectKey.
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setSearchable(boolean v) Set the value of Searchable
java.lang.String	toString()

Methods inherited from class org.apache.torque.om.BaseObject

equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

collAttachments

protected java.util.List collAttachments

Collection to store aggregation of collAttachments

Constructor Detail

BaseAttachmentType

public BaseAttachmentType()

Method Detail

getAttachmentTypeId

public java.lang.Integer getAttachmentTypeId()

Get the AttachmentTypeId

Returns:

Integer

setAttachmentTypeId

public void setAttachmentTypeId(java.lang.Integer v)
                         throws org.apache.torque.TorqueException

Set the value of AttachmentTypeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getName

public java.lang.String getName()

Get the Name

Returns:

String

setName

public void setName(java.lang.String v)

Set the value of Name

Parameters:

v - new value

getSearchable

public boolean getSearchable()

Get the Searchable

Returns:

boolean

setSearchable

public void setSearchable(boolean v)

Set the value of Searchable

Parameters:

v - new value

initAttachments

protected void initAttachments()

Temporary storage of collAttachments to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addAttachment

public void addAttachment(Attachment l)
                   throws org.apache.torque.TorqueException

Method called to associate a Attachment object to this object through the Attachment foreign key attribute

Parameters:

l - Attachment

Throws:

org.apache.torque.TorqueException

getAttachments

public java.util.List getAttachments()
                              throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getAttachments(new Criteria())

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getAttachments

public java.util.List getAttachments(org.apache.torque.util.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 AttachmentType has previously been saved, it will retrieve related Attachments from storage. If this AttachmentType 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

getAttachments

public java.util.List getAttachments(java.sql.Connection con)
                              throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getAttachments(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

Throws:

org.apache.torque.TorqueException

getAttachments

public java.util.List getAttachments(org.apache.torque.util.Criteria criteria,
                                     java.sql.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 AttachmentType has previously been saved, it will retrieve related Attachments from storage. If this AttachmentType 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

Throws:

org.apache.torque.TorqueException

getAttachmentsJoinIssue

protected java.util.List getAttachmentsJoinIssue(org.apache.torque.util.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 AttachmentType is new, it will return an empty collection; or if this AttachmentType has previously been saved, it will retrieve related Attachments from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in AttachmentType.

Throws:

org.apache.torque.TorqueException

getAttachmentsJoinAttachmentType

protected java.util.List getAttachmentsJoinAttachmentType(org.apache.torque.util.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 AttachmentType is new, it will return an empty collection; or if this AttachmentType has previously been saved, it will retrieve related Attachments from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in AttachmentType.

Throws:

org.apache.torque.TorqueException

getAttachmentsJoinScarabUserImplRelatedByCreatedBy

protected java.util.List getAttachmentsJoinScarabUserImplRelatedByCreatedBy(org.apache.torque.util.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 AttachmentType is new, it will return an empty collection; or if this AttachmentType has previously been saved, it will retrieve related Attachments from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in AttachmentType.

Throws:

org.apache.torque.TorqueException

getAttachmentsJoinScarabUserImplRelatedByModifiedBy

protected java.util.List getAttachmentsJoinScarabUserImplRelatedByModifiedBy(org.apache.torque.util.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 AttachmentType is new, it will return an empty collection; or if this AttachmentType has previously been saved, it will retrieve related Attachments from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in AttachmentType.

Throws:

org.apache.torque.TorqueException

getFieldNames

public static java.util.List getFieldNames()

Generate a list of field names.

Returns:

a list of field names

getByName

public java.lang.Object getByName(java.lang.String name)

Retrieves a field from the object by name passed in as a String.

Parameters:

name - field name

Returns:

value

getByPeerName

public java.lang.Object getByPeerName(java.lang.String name)

Retrieves a field from the object by name passed in as a String. The String must be one of the static Strings defined in this Class' Peer.

Parameters:

name - peer name

Returns:

value

getByPosition

public java.lang.Object getByPosition(int pos)

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Parameters:

pos - position in xml schema

Returns:

value

save

public void save()
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.

Specified by:

save in interface org.apache.torque.om.Persistent

Throws:

org.apache.torque.TorqueException

save

public void save(java.lang.String dbName)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. Note: this code is here because the method body is auto-generated conditionally and therefore needs to be in this file instead of in the super class, BaseObject.

Specified by:

save in interface org.apache.torque.om.Persistent

Parameters:

dbName -

Throws:

org.apache.torque.TorqueException

save

public void save(java.sql.Connection con)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; 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 -

Throws:

org.apache.torque.TorqueException

isCacheOnSave

protected boolean isCacheOnSave()

Specify whether to cache the object after saving to the db. This method returns true

setPrimaryKey

public void setPrimaryKey(org.apache.torque.om.ObjectKey key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using ObjectKey.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Parameters:

key - attachmentTypeId ObjectKey

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(java.lang.String key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using a String.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Parameters:

key -

Throws:

org.apache.torque.TorqueException

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.Persistent

getQueryKey

public java.lang.String getQueryKey()

get an id that differentiates this object from others of its class.

Specified by:

getQueryKey in interface org.apache.fulcrum.intake.Retrievable

setQueryKey

public void setQueryKey(java.lang.String key)
                 throws org.apache.torque.TorqueException

set an id that differentiates this object from others of its class.

Specified by:

setQueryKey in interface org.apache.fulcrum.intake.Retrievable

Throws:

org.apache.torque.TorqueException

copy

public AttachmentType 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

copyInto

protected AttachmentType copyInto(AttachmentType copyObj)
                           throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

public AttachmentTypePeer 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.

toString

public java.lang.String toString()