org.tigris.scarab.om
Class Depend

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseDepend
          org.tigris.scarab.om.Depend

All Implemented Interfaces:

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

public class Depend

extends BaseDepend

implements org.apache.torque.om.Persistent

This class represents a Dependency object from the SCARAB_DEPEND table.

Version:

$Id: Depend.java 9977 2005-12-09 00:40:59Z hair $

Author:

John McNally, Jon S. Stevens, Elicia David

See Also:

Serialized Form

Field Summary

Fields inherited from class org.tigris.scarab.om.BaseDepend

collActivitys

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

NEW_ID

Constructor Summary

Depend()

Method Summary

void	exchangeRoles() Exchange Observer and Observed roles...
java.lang.String	getAction(java.util.Locale locale) Returns phrase describing this dependency's type.
Module	getDefaultModule() Returns default module.
java.lang.String	getDescription() Gets the description of the message given by the user for the reason for this dependency.
Attachment	getDescriptionAsAttachment(ScarabUser user, Issue issue) Gets the description of the message given by the user for the reason for this dependency.
static Depend	getInstance() Deprecated. See DependManager.getInstance()
java.lang.String	getObserverUniqueId() Getter method to get observerId as a String
boolean	getSelected() Get the selection state (typically the state of a checkbox).
void	setDefaultModule(Module me) Sets default module.
void	setDependType(java.lang.String type)
void	setDescription(java.lang.String description) Sets the description of the message given by the user for the reason for this dependency.
void	setObserverUniqueId(java.lang.String uniqueId) Setter method which takes a String - the unique id.
void	setProperties(Depend depend) Copies the properties from the passed in object onto this object.
void	setSelected(boolean theSelectState) Set the selection state.

Methods inherited from class org.tigris.scarab.om.BaseDepend

addActivity, copy, copyInto, getActivitys, getActivitys, getActivitys, getActivitys, getActivitysJoinActivitySet, getActivitysJoinAttachment, getActivitysJoinAttribute, getActivitysJoinAttributeOptionRelatedByNewOptionId, getActivitysJoinAttributeOptionRelatedByOldOptionId, getActivitysJoinDepend, getActivitysJoinIssue, getActivitysJoinScarabUserImplRelatedByNewUserId, getActivitysJoinScarabUserImplRelatedByOldUserId, getByName, getByPeerName, getByPosition, getDeleted, getDependId, getDependType, getDependType, getFieldNames, getIssueRelatedByObservedId, getIssueRelatedByObservedId, getIssueRelatedByObserverId, getIssueRelatedByObserverId, getObservedId, getObserverId, getPeer, getPrimaryKey, getQueryKey, getTypeId, initActivitys, isCacheOnSave, save, save, save, setDeleted, setDependId, setDependType, setDependTypeKey, setIssueRelatedByObservedId, setIssueRelatedByObservedIdKey, setIssueRelatedByObserverId, setIssueRelatedByObserverIdKey, setObservedId, setObserverId, setPrimaryKey, setPrimaryKey, setQueryKey, setTypeId, 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

Methods inherited from interface org.apache.torque.om.Persistent

getPrimaryKey, isModified, isNew, save, save, save, setModified, setNew, setPrimaryKey, setPrimaryKey

Constructor Detail

Depend

public Depend()

Method Detail

getSelected

public boolean getSelected()

Get the selection state (typically the state of a checkbox).

Returns:

setSelected

public void setSelected(boolean theSelectState)

Set the selection state. Used via the Frontend, typically contains the state of a checkbox.

Parameters:

theSelectState -

getInstance

public static Depend getInstance()
                          throws org.apache.torque.TorqueException

Deprecated. See DependManager.getInstance()

A new Depend object

Throws:

org.apache.torque.TorqueException

setDefaultModule

public void setDefaultModule(Module me)

Sets default module.

getDefaultModule

public Module getDefaultModule()

Returns default module.

getDescriptionAsAttachment

public Attachment getDescriptionAsAttachment(ScarabUser user,
                                             Issue issue)
                                      throws org.apache.torque.TorqueException

Gets the description of the message given by the user for the reason for this dependency. Can be null. Saves the attachment to the database if there is data to be saved.

Throws:

org.apache.torque.TorqueException

getDescription

public java.lang.String getDescription()

Gets the description of the message given by the user for the reason for this dependency. Can be null.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the message given by the user for the reason for this dependency. Can be null.

getObserverUniqueId

public java.lang.String getObserverUniqueId()
                                     throws org.apache.torque.TorqueException

Getter method to get observerId as a String

Throws:

org.apache.torque.TorqueException

setDependType

public void setDependType(java.lang.String type)
                   throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

setObserverUniqueId

public void setObserverUniqueId(java.lang.String uniqueId)
                         throws org.apache.torque.TorqueException,
                                ScarabException

Setter method which takes a String - the unique id.

Throws:

org.apache.torque.TorqueException

ScarabException

setProperties

public void setProperties(Depend depend)
                   throws org.apache.torque.TorqueException

Copies the properties from the passed in object onto this object.

Throws:

org.apache.torque.TorqueException

getAction

public java.lang.String getAction(java.util.Locale locale)

Returns phrase describing this dependency's type.

exchangeRoles

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

Exchange Observer and Observed roles...

Throws:

org.apache.torque.TorqueException