org.tigris.scarab.om
Class MITListItem

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseMITListItem
          org.tigris.scarab.om.MITListItem

All Implemented Interfaces:

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

public class MITListItem

extends BaseMITListItem

implements org.apache.torque.om.Persistent

A module and an issue type. Wildcards are possible, so that a single MITListItem could represent all the issue types in a module. A single issue type in all modules (that have it defined). Or all modules and issue types.

See Also:

Serialized Form

Field Summary

(package private) static java.lang.Integer

MULTIPLE_KEY

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

NEW_ID

Constructor Summary

MITListItem()

Method Summary

boolean	equals(java.lang.Object obj)
int	getIssueCount(ScarabUser user) The number of active issues of the this issue type within the module.
int	getIssueCount(ScarabUser user, AttributeOption attributeOption) The number of active issues of the this issue type within the module.
java.lang.String	getQueryKey() get an id that differentiates this object from others of its class.
int	hashCode()
boolean	isSingleIssueType()
boolean	isSingleModule()
boolean	isSingleModuleIssueType()
boolean	isUseCurrentModule()
java.lang.String	toString()

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

copy, copyInto, getByName, getByPeerName, getByPosition, getFieldNames, getIssueType, getIssueType, getIssueTypeId, getItemId, getListId, getMITList, getMITList, getModule, getModule, getModuleId, getPeer, getPrimaryKey, isCacheOnSave, save, save, save, setIssueType, setIssueTypeId, setIssueTypeKey, setItemId, setListId, setMITList, setMITListKey, setModule, setModuleId, setModuleKey, setPrimaryKey, setPrimaryKey, setQueryKey

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

equals, getLog, 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

Field Detail

MULTIPLE_KEY

static final java.lang.Integer MULTIPLE_KEY

Constructor Detail

MITListItem

public MITListItem()

Method Detail

getIssueCount

public int getIssueCount(ScarabUser user)
                  throws org.apache.torque.TorqueException,
                         ScarabException

The number of active issues of the this issue type within the module.

Parameters:

user - a ScarabUser value used to determine if a count should be given.

Returns:

an int the number of issues entered for the module unless the user does not have permission to search for issues in the given module, then a value of 0 will be returned. if resource limited, this method will return -1.

Throws:

java.lang.Exception - if an error occurs

org.apache.torque.TorqueException

ScarabException

getIssueCount

public int getIssueCount(ScarabUser user,
                         AttributeOption attributeOption)
                  throws org.apache.torque.TorqueException,
                         ScarabException,
                         com.workingdogs.village.DataSetException

The number of active issues of the this issue type within the module.

Parameters:

user - a ScarabUser value used to determine if a count should be given.

Returns:

an int the number of issues entered for the module unless the user does not have permission to search for issues in the given module, then a value of 0 will be returned. if resource limited, this method will return -1.

Throws:

com.workingdogs.village.DataSetException

java.lang.Exception - if an error occurs

org.apache.torque.TorqueException

ScarabException

isSingleModuleIssueType

public boolean isSingleModuleIssueType()

isSingleModule

public boolean isSingleModule()

isSingleIssueType

public boolean isSingleIssueType()

isUseCurrentModule

public boolean isUseCurrentModule()

getQueryKey

public java.lang.String getQueryKey()

Description copied from class: BaseMITListItem

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

Specified by:

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

Overrides:

getQueryKey in class BaseMITListItem

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object obj)

toString

public java.lang.String toString()

Overrides:

toString in class BaseMITListItem