org.apache.jetspeed.om.dbregistry
Class BasePortletDbEntry

java.lang.Object
  |
  +--org.apache.torque.om.BaseObject
        |
        +--org.apache.jetspeed.om.dbregistry.BasePortletDbEntry

All Implemented Interfaces:

org.apache.torque.om.Persistent, java.io.Serializable

Direct Known Subclasses:

PortletDbEntry

public abstract class BasePortletDbEntry

extends org.apache.torque.om.BaseObject

This class was autogenerated by Torque on: [Thu Apr 22 23:12:36 EDT 2004] You should not use this class directly. It should not even be extended all references should be to PortletDbEntry

See Also:

Serialized Form

Field Summary

protected java.util.List	collPortletCategorys Collection to store aggregation of collPortletCategorys
protected java.util.List	collPortletMediatypes Collection to store aggregation of collPortletMediatypes
protected java.util.List	collPortletParameters Collection to store aggregation of collPortletParameters

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

NEW_ID

Constructor Summary

BasePortletDbEntry()

Method Summary

void	addPortletCategory(org.apache.jetspeed.om.dbregistry.PortletCategory l) Method called to associate a PortletCategory object to this object through the PortletCategory foreign key attribute
void	addPortletMediatype(org.apache.jetspeed.om.dbregistry.PortletMediatype l) Method called to associate a PortletMediatype object to this object through the PortletMediatype foreign key attribute
void	addPortletParameter(org.apache.jetspeed.om.dbregistry.PortletParameter l) Method called to associate a PortletParameter object to this object through the PortletParameter foreign key attribute
org.apache.jetspeed.om.dbregistry.PortletDbEntry	copy() Makes a copy of this object.
boolean	getApplication() Get the Application
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.
boolean	getCachedonurl() Get the Cachedonurl
java.lang.String	getClassname() Get the Classname
java.lang.String	getDescription() Get the Description
static java.util.List	getFieldNames() Generate a list of field names.
boolean	getHidden() Get the Hidden
long	getId() Get the Id
java.lang.String	getImage() Get the Image
java.lang.String	getName() Get the Name
long	getParentRef() Get the ParentRef
org.apache.jetspeed.om.dbregistry.PortletDbEntryPeer	getPeer() returns a peer instance associated with this om.
java.util.List	getPortletCategorys() If this collection has already been initialized, returns the collection.
java.util.List	getPortletCategorys(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getPortletCategorys(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getPortletCategorys(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	getPortletCategorysJoinPortletDbEntry(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getPortletMediatypes() If this collection has already been initialized, returns the collection.
java.util.List	getPortletMediatypes(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getPortletMediatypes(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getPortletMediatypes(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	getPortletMediatypesJoinMediatype(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	getPortletMediatypesJoinPortletDbEntry(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getPortletParameters() If this collection has already been initialized, returns the collection.
java.util.List	getPortletParameters(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getPortletParameters(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getPortletParameters(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	getPortletParametersJoinPortletDbEntry(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
org.apache.torque.om.ObjectKey	getPrimaryKey() returns an id that differentiates this object from others of its class.
java.lang.String	getRole() Get the Role
java.lang.String	getSecurityRef() Get the SecurityRef
java.lang.String	getTitle() Get the Title
java.lang.String	getType() Get the Type
java.lang.String	getURL() Get the URL
protected void	initPortletCategorys() Temporary storage of collPortletCategorys to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initPortletMediatypes() Temporary storage of collPortletMediatypes to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initPortletParameters() Temporary storage of collPortletParameters 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	setApplication(boolean v) Set the value of Application
void	setCachedonurl(boolean v) Set the value of Cachedonurl
void	setClassname(java.lang.String v) Set the value of Classname
void	setDescription(java.lang.String v) Set the value of Description
void	setHidden(boolean v) Set the value of Hidden
void	setId(long v) Set the value of Id
void	setImage(java.lang.String v) Set the value of Image
void	setName(java.lang.String v) Set the value of Name
void	setParentRef(long v) Set the value of ParentRef
void	setPrimaryKey(org.apache.torque.om.ObjectKey id) Set the PrimaryKey using ObjectKey.
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setRole(java.lang.String v) Set the value of Role
void	setSecurityRef(java.lang.String v) Set the value of SecurityRef
void	setTitle(java.lang.String v) Set the value of Title
void	setType(java.lang.String v) Set the value of Type
void	setURL(java.lang.String v) Set the value of URL

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

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

Methods inherited from class java.lang.Object

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

Field Detail

collPortletCategorys

protected java.util.List collPortletCategorys

Collection to store aggregation of collPortletCategorys

collPortletParameters

protected java.util.List collPortletParameters

Collection to store aggregation of collPortletParameters

collPortletMediatypes

protected java.util.List collPortletMediatypes

Collection to store aggregation of collPortletMediatypes

Constructor Detail

BasePortletDbEntry

public BasePortletDbEntry()

Method Detail

getId

public long getId()

Get the Id

Returns:

long

setId

public void setId(long v)
           throws org.apache.torque.TorqueException

Set the value of Id

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

getHidden

public boolean getHidden()

Get the Hidden

Returns:

boolean

setHidden

public void setHidden(boolean v)

Set the value of Hidden

getClassname

public java.lang.String getClassname()

Get the Classname

Returns:

String

setClassname

public void setClassname(java.lang.String v)

Set the value of Classname

getType

public java.lang.String getType()

Get the Type

Returns:

String

setType

public void setType(java.lang.String v)

Set the value of Type

getApplication

public boolean getApplication()

Get the Application

Returns:

boolean

setApplication

public void setApplication(boolean v)

Set the value of Application

getParentRef

public long getParentRef()

Get the ParentRef

Returns:

long

setParentRef

public void setParentRef(long v)

Set the value of ParentRef

getURL

public java.lang.String getURL()

Get the URL

Returns:

String

setURL

public void setURL(java.lang.String v)

Set the value of URL

getCachedonurl

public boolean getCachedonurl()

Get the Cachedonurl

Returns:

boolean

setCachedonurl

public void setCachedonurl(boolean v)

Set the value of Cachedonurl

getRole

public java.lang.String getRole()

Get the Role

Returns:

String

setRole

public void setRole(java.lang.String v)

Set the value of Role

getTitle

public java.lang.String getTitle()

Get the Title

Returns:

String

setTitle

public void setTitle(java.lang.String v)

Set the value of Title

getDescription

public java.lang.String getDescription()

Get the Description

Returns:

String

setDescription

public void setDescription(java.lang.String v)

Set the value of Description

getImage

public java.lang.String getImage()

Get the Image

Returns:

String

setImage

public void setImage(java.lang.String v)

Set the value of Image

getSecurityRef

public java.lang.String getSecurityRef()

Get the SecurityRef

Returns:

String

setSecurityRef

public void setSecurityRef(java.lang.String v)

Set the value of SecurityRef

initPortletCategorys

protected void initPortletCategorys()

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

addPortletCategory

public void addPortletCategory(org.apache.jetspeed.om.dbregistry.PortletCategory l)
                        throws org.apache.torque.TorqueException

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

org.apache.torque.TorqueException

getPortletCategorys

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

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

org.apache.torque.TorqueException

getPortletCategorys

public java.util.List getPortletCategorys(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 PortletDbEntry has previously been saved, it will retrieve related PortletCategorys from storage. If this PortletDbEntry is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

org.apache.torque.TorqueException

getPortletCategorys

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

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

org.apache.torque.TorqueException

getPortletCategorys

public java.util.List getPortletCategorys(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 PortletDbEntry has previously been saved, it will retrieve related PortletCategorys from storage. If this PortletDbEntry 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

org.apache.torque.TorqueException

getPortletCategorysJoinPortletDbEntry

protected java.util.List getPortletCategorysJoinPortletDbEntry(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 PortletDbEntry is new, it will return an empty collection; or if this PortletDbEntry has previously been saved, it will retrieve related PortletCategorys 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 PortletDbEntry.

org.apache.torque.TorqueException

initPortletParameters

protected void initPortletParameters()

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

addPortletParameter

public void addPortletParameter(org.apache.jetspeed.om.dbregistry.PortletParameter l)
                         throws org.apache.torque.TorqueException

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

org.apache.torque.TorqueException

getPortletParameters

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

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

org.apache.torque.TorqueException

getPortletParameters

public java.util.List getPortletParameters(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 PortletDbEntry has previously been saved, it will retrieve related PortletParameters from storage. If this PortletDbEntry is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

org.apache.torque.TorqueException

getPortletParameters

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

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

org.apache.torque.TorqueException

getPortletParameters

public java.util.List getPortletParameters(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 PortletDbEntry has previously been saved, it will retrieve related PortletParameters from storage. If this PortletDbEntry 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

org.apache.torque.TorqueException

getPortletParametersJoinPortletDbEntry

protected java.util.List getPortletParametersJoinPortletDbEntry(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 PortletDbEntry is new, it will return an empty collection; or if this PortletDbEntry has previously been saved, it will retrieve related PortletParameters 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 PortletDbEntry.

org.apache.torque.TorqueException

initPortletMediatypes

protected void initPortletMediatypes()

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

addPortletMediatype

public void addPortletMediatype(org.apache.jetspeed.om.dbregistry.PortletMediatype l)
                         throws org.apache.torque.TorqueException

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

org.apache.torque.TorqueException

getPortletMediatypes

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

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

org.apache.torque.TorqueException

getPortletMediatypes

public java.util.List getPortletMediatypes(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 PortletDbEntry has previously been saved, it will retrieve related PortletMediatypes from storage. If this PortletDbEntry is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

org.apache.torque.TorqueException

getPortletMediatypes

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

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

org.apache.torque.TorqueException

getPortletMediatypes

public java.util.List getPortletMediatypes(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 PortletDbEntry has previously been saved, it will retrieve related PortletMediatypes from storage. If this PortletDbEntry 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

org.apache.torque.TorqueException

getPortletMediatypesJoinPortletDbEntry

protected java.util.List getPortletMediatypesJoinPortletDbEntry(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 PortletDbEntry is new, it will return an empty collection; or if this PortletDbEntry has previously been saved, it will retrieve related PortletMediatypes 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 PortletDbEntry.

org.apache.torque.TorqueException

getPortletMediatypesJoinMediatype

protected java.util.List getPortletMediatypesJoinMediatype(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 PortletDbEntry is new, it will return an empty collection; or if this PortletDbEntry has previously been saved, it will retrieve related PortletMediatypes 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 PortletDbEntry.

org.apache.torque.TorqueException

getFieldNames

public static java.util.List getFieldNames()

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

Overrides:

getByName in class org.apache.torque.om.BaseObject

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.

Overrides:

getByPeerName in class org.apache.torque.om.BaseObject

getByPosition

public java.lang.Object getByPosition(int pos)

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

Overrides:

getByPosition in class org.apache.torque.om.BaseObject

save

public void save()
          throws java.lang.Exception

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

Specified by:

save in class org.apache.torque.om.BaseObject

java.lang.Exception

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

Specified by:

save in class org.apache.torque.om.BaseObject

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

Specified by:

save in class org.apache.torque.om.BaseObject

org.apache.torque.TorqueException

isCacheOnSave

protected boolean isCacheOnSave()

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

setPrimaryKey

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

Set the PrimaryKey using ObjectKey.

Specified by:

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

Overrides:

setPrimaryKey in class org.apache.torque.om.BaseObject

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

Overrides:

setPrimaryKey in class org.apache.torque.om.BaseObject

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

Overrides:

getPrimaryKey in class org.apache.torque.om.BaseObject

copy

public org.apache.jetspeed.om.dbregistry.PortletDbEntry 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.

org.apache.torque.TorqueException

getPeer

public org.apache.jetspeed.om.dbregistry.PortletDbEntryPeer 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.