org.tigris.scarab.om
Class Query

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseQuery
          org.tigris.scarab.om.Query

All Implemented Interfaces:

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

public class Query

extends BaseQuery

implements org.apache.torque.om.Persistent

This class manages the Query table.

Version:

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

Author:

John McNally

See Also:

Serialized Form

Field Summary

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

collRQueryUsers

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

NEW_ID

Constructor Summary

Query()

Method Summary

void	approve(ScarabUser user, boolean approved) Checks permission and approves or rejects query.
boolean	canDelete(ScarabUser user)
boolean	canEdit(ScarabUser user)
void	copyQuery(ScarabUser user) Checks if user has permission to delete query.
void	delete(ScarabUser user) Checks if user has permission to delete query.
static Query	getInstance() A new Query object
MITList	getMITList() Returns the associated MITList object.
Module	getModule() Module getter.
RQueryUser	getRQueryUser(ScarabUser user) Gets RQueryUser object for this query and user.
ScarabModule	getScarabModule() Throws UnsupportedOperationException.
ScarabUser	getScarabUser() Get the value of scarabUser.
boolean	saveAndSendEmail(ScarabUser user, Module module, org.apache.turbine.TemplateContext context) Either returns true, if no email problem occured, or throws an appropriate Exception.
void	setModule(Module me) Use this instead of setScarabModule.
void	setScarabModule(ScarabModule module) Throws UnsupportedOperationException.
void	setScarabUser(ScarabUser v) Set the value of scarabUser.
void	subscribe(ScarabUser user, java.lang.Integer frequencyId) Subscribes user to query.
void	unSubscribe(ScarabUser user) Unsubscribes user from query.

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

addRQueryUser, copy, copyInto, getApproved, getByName, getByPeerName, getByPosition, getCreatedDate, getDeleted, getDescription, getFieldNames, getFrequency, getFrequency, getHomePage, getIssueType, getIssueType, getIssueTypeId, getListId, getMITList, getModule, getModuleId, getName, getOrder, getPeer, getPrimaryKey, getQueryId, getQueryKey, getRQueryUsers, getRQueryUsers, getRQueryUsers, getRQueryUsers, getRQueryUsersJoinFrequency, getRQueryUsersJoinQuery, getRQueryUsersJoinScarabUserImpl, getScarabUser, getScope, getScope, getScopeId, getSubscriptionFrequencyId, getUserId, getValue, initRQueryUsers, isCacheOnSave, save, save, save, setApproved, setCreatedDate, setDeleted, setDescription, setFrequency, setFrequencyKey, setHomePage, setIssueType, setIssueTypeId, setIssueTypeKey, setListId, setMITList, setMITListKey, setModuleId, setModuleKey, setName, setOrder, setPrimaryKey, setPrimaryKey, setQueryId, setQueryKey, setScarabUserKey, setScope, setScopeId, setScopeKey, setSubscriptionFrequencyId, setUserId, setValue, 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

Query

public Query()

Method Detail

getScarabUser

public ScarabUser getScarabUser()
                         throws org.apache.torque.TorqueException

Get the value of scarabUser.

Overrides:

getScarabUser in class BaseQuery

Returns:

value of scarabUser.

Throws:

org.apache.torque.TorqueException

setScarabUser

public void setScarabUser(ScarabUser v)
                   throws org.apache.torque.TorqueException

Set the value of scarabUser.

Overrides:

setScarabUser in class BaseQuery

Parameters:

v - Value to assign to scarabUser.

Throws:

org.apache.torque.TorqueException

getScarabModule

public ScarabModule getScarabModule()

Throws UnsupportedOperationException. Use getModule() instead.

Returns:

a ScarabModule value

setScarabModule

public void setScarabModule(ScarabModule module)

Throws UnsupportedOperationException. Use setModule(Module) instead.

setModule

public void setModule(Module me)
               throws org.apache.torque.TorqueException

Use this instead of setScarabModule. Note: module cannot be new.

Overrides:

setModule in class BaseQuery

Parameters:

me - Module

Throws:

org.apache.torque.TorqueException

getModule

public Module getModule()
                 throws org.apache.torque.TorqueException

Module getter. Use this method instead of getScarabModule().

Overrides:

getModule in class BaseQuery

Returns:

a Module value

Throws:

org.apache.torque.TorqueException

getInstance

public static Query getInstance()

A new Query object

canDelete

public boolean canDelete(ScarabUser user)
                  throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

canEdit

public boolean canEdit(ScarabUser user)
                throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

saveAndSendEmail

public boolean saveAndSendEmail(ScarabUser user,
                                Module module,
                                org.apache.turbine.TemplateContext context)
                         throws org.apache.torque.TorqueException,
                                ScarabException

Either returns true, if no email problem occured, or throws an appropriate Exception. Note: If an email exception occured, the query is still saved.

Parameters:

user -

module -

context -

Returns:

Throws:

org.apache.torque.TorqueException

ScarabException

getMITList

public MITList getMITList()
                   throws org.apache.torque.TorqueException

Description copied from class: BaseQuery

Returns the associated MITList object. If it was not retrieved before, the object is retrieved from the database

Overrides:

getMITList in class BaseQuery

Returns:

the associated MITList object

Throws:

org.apache.torque.TorqueException

subscribe

public void subscribe(ScarabUser user,
                      java.lang.Integer frequencyId)
               throws org.apache.torque.TorqueException

Subscribes user to query.

Throws:

org.apache.torque.TorqueException

unSubscribe

public void unSubscribe(ScarabUser user)
                 throws org.apache.torque.TorqueException

Unsubscribes user from query.

Throws:

org.apache.torque.TorqueException

getRQueryUser

public RQueryUser getRQueryUser(ScarabUser user)
                         throws org.apache.torque.TorqueException

Gets RQueryUser object for this query and user.

Throws:

org.apache.torque.TorqueException

approve

public void approve(ScarabUser user,
                    boolean approved)
             throws org.apache.torque.TorqueException,
                    ScarabException

Checks permission and approves or rejects query. If query is approved, query type set to "module", else set to "personal".

Throws:

org.apache.torque.TorqueException

ScarabException

delete

public void delete(ScarabUser user)
            throws org.apache.torque.TorqueException,
                   ScarabException

Checks if user has permission to delete query. Only the creating user can delete a personal query. Only project owner or admin can delete a project-wide query.

Throws:

org.apache.torque.TorqueException

ScarabException

copyQuery

public void copyQuery(ScarabUser user)
               throws org.apache.torque.TorqueException

Checks if user has permission to delete query. Only the creating user can delete a personal query. Only project owner or admin can delete a project-wide query.

Throws:

org.apache.torque.TorqueException