org.apache.jetspeed.om.dbregistry
Class BasePortletParameter

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PortletParameter

public abstract class BasePortletParameter

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 PortletParameter

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BasePortletParameter()

Method Summary

org.apache.jetspeed.om.dbregistry.PortletParameter	copy() Makes a copy of this object.
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	getCachedonname() Get the Cachedonname
boolean	getCachedonvalue() Get the Cachedonvalue
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
org.apache.jetspeed.om.dbregistry.PortletParameterPeer	getPeer() returns a peer instance associated with this om.
org.apache.jetspeed.om.dbregistry.PortletDbEntry	getPortletDbEntry()
long	getPortletId() Get the PortletId
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	getValue() Get the Value
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	setCachedonname(boolean v) Set the value of Cachedonname
void	setCachedonvalue(boolean v) Set the value of Cachedonvalue
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	setPortletDbEntry(org.apache.jetspeed.om.dbregistry.PortletDbEntry v) Declares an association between this object and a PortletDbEntry object
void	setPortletDbEntryKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setPortletId(long v) Set the value of PortletId
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	setValue(java.lang.String v) Set the value of Value

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

Constructor Detail

BasePortletParameter

public BasePortletParameter()

Method Detail

getId

public long getId()

Get the Id

Returns:

long

setId

public void setId(long v)

Set the value of Id

getName

public java.lang.String getName()

Get the Name

Returns:

String

setName

public void setName(java.lang.String v)

Set the value of Name

getValue

public java.lang.String getValue()

Get the Value

Returns:

String

setValue

public void setValue(java.lang.String v)

Set the value of Value

getType

public java.lang.String getType()

Get the Type

Returns:

String

setType

public void setType(java.lang.String v)

Set the value of Type

getHidden

public boolean getHidden()

Get the Hidden

Returns:

boolean

setHidden

public void setHidden(boolean v)

Set the value of Hidden

getRole

public java.lang.String getRole()

Get the Role

Returns:

String

setRole

public void setRole(java.lang.String v)

Set the value of Role

getCachedonvalue

public boolean getCachedonvalue()

Get the Cachedonvalue

Returns:

boolean

setCachedonvalue

public void setCachedonvalue(boolean v)

Set the value of Cachedonvalue

getCachedonname

public boolean getCachedonname()

Get the Cachedonname

Returns:

boolean

setCachedonname

public void setCachedonname(boolean v)

Set the value of Cachedonname

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

getPortletId

public long getPortletId()

Get the PortletId

Returns:

long

setPortletId

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

Set the value of PortletId

org.apache.torque.TorqueException

getSecurityRef

public java.lang.String getSecurityRef()

Get the SecurityRef

Returns:

String

setSecurityRef

public void setSecurityRef(java.lang.String v)

Set the value of SecurityRef

setPortletDbEntry

public void setPortletDbEntry(org.apache.jetspeed.om.dbregistry.PortletDbEntry v)
                       throws org.apache.torque.TorqueException

Declares an association between this object and a PortletDbEntry object

org.apache.torque.TorqueException

getPortletDbEntry

public org.apache.jetspeed.om.dbregistry.PortletDbEntry getPortletDbEntry()
                                                                   throws org.apache.torque.TorqueException

org.apache.torque.TorqueException

setPortletDbEntryKey

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

Provides convenient way to set a relationship based on a ObjectKey. e.g. bar.setFooKey(foo.getPrimaryKey())

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)

Set the PrimaryKey using ObjectKey.

Specified by:

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

Overrides:

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

setPrimaryKey

public void setPrimaryKey(java.lang.String key)

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

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.PortletParameter 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.PortletParameterPeer 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.