org.tigris.scarab.om
Interface Module

All Superinterfaces:

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

All Known Implementing Classes:

AbstractScarabModule, ScarabModule

public interface Module

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

This class describes a Module within the Scarab system

Version:

$Id: Module.java 10257 2006-08-07 22:43:30Z jorgeuriarte $

Author:

Jon S. Stevens

Field Summary

static L10NKey	NAME_DELIMINATOR The deliminator between parent/child Modules This is used to build up the getName() results.
static java.lang.String	NON_USER
static java.lang.Integer	ROOT_ID
static java.lang.String	USER

Method Summary

void	addAttributeOption(IssueType issueType, AttributeOption option)
void	addIssueType(IssueType issueType)
RModuleAttribute	addRModuleAttribute(IssueType issueType, Attribute attribute) Adds module-attribute mapping to module.
RModuleOption	addRModuleOption(IssueType issueType, AttributeOption option) Adds module-attribute-option mapping to module.
boolean	allowsIssues() Determines whether this module accepts issues.
boolean	allowsMultipleVoting() Determines whether this module allows users to vote many times for the same issue.
boolean	allowsNewIssues() Determines whether this module is accepting new issues.
AttributeGroup	createNewGroup(IssueType issueType) Creates new attribute group.
java.util.List	getAllAttributes() Gets a list of all of the Attributes in this module.
java.util.List	getAncestors() Returns this ModuleEntities ancestors in ascending order.
java.lang.String	getArchiveEmail() All emails related to this module will have a copy sent to this address.
java.util.List	getAttributes(org.apache.torque.util.Criteria criteria) gets a list of all of the Attributes in a Module based on the Criteria.
java.util.List	getAttributes(IssueType issueType) Gets a list of attributes for this module with a specific issue type.
java.lang.String	getCode()
java.lang.String	getCommentRenderingEngine() Retruns the currently used rendering engine for comments
java.util.List	getDedupeAttributeGroups(IssueType issueType) List of active dedupe attribute groups associated with this module.
java.util.List	getDedupeAttributeGroups(IssueType issueType, boolean activeOnly) List of attribute groups associated with this module.
java.util.List	getDedupeGroupsWithAttributes(IssueType issueType) This method is used within Wizard1.vm to get a list of attribute groups which are marked as dedupe and have a list of attributes in them.
int	getDedupeSequence(IssueType issueType) Gets the sequence where the dedupe screen fits between groups.
java.util.List	getDefaultRModuleUserAttributes(IssueType issueType) Returns default issue list attributes for this module.
boolean	getDeleted()
java.lang.String	getDescription()
ScarabUser[]	getEligibleIssueReporters()
ScarabUser[]	getEligibleUsers(Attribute attribute)
java.lang.String	getHttpDomain() www.foo.com
Issue	getIssueById(java.lang.String id) Deprecated. use IssueManager.getIssueById(String id, String defaultCode) I think this method should only return issues from this module, but there is only one place in the code where something like that was needed and the check is done there. Its possible we would want to define this method to return issues in children or some other criteria. deprecating for removal until a definite reason for it to exist appears.
org.apache.regexp.REProgram	getIssueRegex() returns a compiled regex that can used to create a new RE for matching some given text.
java.util.List	getIssueTypes()
java.util.List	getIssueTypes(boolean activeOnly)
int	getLastAttribute(IssueType issueType, java.lang.String attributeType)
int	getLastAttributeOption(Attribute attribute, IssueType issueType)
java.util.List	getLeafRModuleOptions(Attribute attribute, IssueType issueType)
java.util.List	getLeafRModuleOptions(Attribute attribute, IssueType issueType, boolean activeOnly)
java.util.Locale	getLocale() The default locale for this module will be used in cases where a response is going to no particular user (a mailing list) or can also be used as a default in cases where a user does not have a preference.
java.lang.Integer	getModuleId()
java.lang.String	getName() This method is only used by the Turbine Group interface.
java.util.List	getNavIssueTypes()
Issue	getNewIssue(IssueType issueType)
java.util.List	getOptionTree(Attribute attribute, IssueType issueType) Gets a list of active RModuleOptions which have had their level within the options for this module set.
java.util.List	getOptionTree(Attribute attribute, IssueType issueType, boolean activeOnly) Gets a list of RModuleOptions which have had their level within the options for this module set.
java.lang.Integer	getOwnerId()
Module	getParent() Same as the getModuleRelatedByParentIdCast(), just a better name.
java.lang.Integer	getParentId()
java.lang.String	getPort() the port number used for the domain
org.apache.torque.om.ObjectKey	getPrimaryKey()
java.lang.Integer	getQaContactId() Deprecated. THESE WILL BE DEPRECATED
java.lang.String	getQueryKey()
java.lang.String	getRealName() This method is only used by the Turbine Group interface.
org.apache.fulcrum.security.entity.Role	getRequiredRole() Returns the required role for *any* access to this module including for requesting roles.
RModuleAttribute	getRModuleAttribute(Attribute attribute, IssueType issueType)
java.util.List	getRModuleAttributes(org.apache.torque.util.Criteria criteria)
java.util.List	getRModuleAttributes(IssueType issueType)
java.util.List	getRModuleAttributes(IssueType issueType, boolean activeOnly)
java.util.List	getRModuleAttributes(IssueType issueType, boolean activeOnly, java.lang.String attributeType)
RModuleIssueType	getRModuleIssueType(IssueType issueType)
java.util.List	getRModuleIssueTypes()
RModuleOption	getRModuleOption(AttributeOption option, IssueType issueType)
java.util.List	getRModuleOptions(Attribute attribute, IssueType issueType)
java.util.List	getRModuleOptions(Attribute attribute, IssueType issueType, boolean activeOnly)
java.util.List	getRModuleOptions(org.apache.torque.util.Criteria crit)
java.util.List	getRoles()
java.util.List	getSavedReports(ScarabUser user) List of saved reports associated with this module and created by the given user.
java.lang.String	getScarabInstanceId() arbitrary value, represents the individual instance on which this module has been created.
java.lang.String	getScheme() the scheme (http|https) used
java.lang.String	getScriptName() the scriptName used: /scarab/issues
java.lang.String[]	getSystemEmail() The default address that is used to fill out either the From or ReplyTo header on emails related to this module.
java.util.List	getTemplateTypes()
java.util.List	getUnapprovedQueries() Returns list of queries needing approval.
java.util.List	getUnapprovedTemplates() Returns list of enter issue templates needing approval.
int	getUnusedVoteCount(ScarabUser user) How many votes does the user have left to cast.
java.lang.String	getUrl()
java.util.List	getUserAttributes(IssueType issueType)
java.util.List	getUserAttributes(IssueType issueType, boolean activeOnly)
java.util.List	getUserPermissions(IssueType issueType)
ScarabUser[]	getUsers(java.util.List permissions) Get a list of ScarabUser's that have any of the given permissions in the given module.
ScarabUser[]	getUsers(java.lang.String permission) Get a list of ScarabUser's that have the given permission in the given module.
ScarabPaginatedList	getUsers(java.lang.String name, java.lang.String username, MITList mitList, int offset, int resultSize, java.lang.String sortColumn, java.lang.String sortPolarity, boolean includeCommitters) Gets users for a given criteria, starting at a particular offset, for a given length, and have at least one permission that is applicable to user attributes active in the given issue type.
java.util.List	getUsers(java.lang.String firstName, java.lang.String lastName, java.lang.String username, java.lang.String email, IssueType issueType) Gets users which match all of the given criteria and have at least one permission that is applicable to user attributes active in the given issue type.
boolean	isEndlessLoop(Module parent) check for endless loops where Module A > Module B > Module A
boolean	isGlobalModule() Returns true if this module is the the top level parent module.
boolean	isInitializing() Returns true if no issue types are associated with this module, or if the module is currently getting its initial values set.
boolean	isIssueReasonRequired() Determines wether a 'reason' is required for every change in the issues of this module.
boolean	isIssueReasonRequiredInherited() Determines if the value of isIssueReasonRequired is due to the configuration of this module or inherited from ancestors or default configuration.
void	setCode(java.lang.String code)
void	setDeleted(boolean b)
void	setDescription(java.lang.String description)
void	setHttpDomain(java.lang.String domain)
void	setModuleId(java.lang.Integer v)
void	setName(java.lang.String name)
void	setOwnerId(java.lang.Integer v)
void	setParent(Module module)
void	setParentId(java.lang.Integer v)
void	setPort(java.lang.String port)
void	setPrimaryKey(org.apache.torque.om.ObjectKey key)
void	setQaContactId(java.lang.Integer v) Deprecated. THESE WILL BE DEPRECATED
void	setRealName(java.lang.String name)
void	setScarabInstanceId(java.lang.String domain)
void	setScheme(java.lang.String scheme)
void	setScriptName(java.lang.String scriptName)
void	setUrl(java.lang.String url)
java.lang.String	toString()

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

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

Field Detail

NAME_DELIMINATOR

public static final L10NKey NAME_DELIMINATOR

The deliminator between parent/child Modules This is used to build up the getName() results.

ROOT_ID

public static final java.lang.Integer ROOT_ID

USER

public static final java.lang.String USER

See Also:

Constant Field Values

NON_USER

public static final java.lang.String NON_USER

See Also:

Constant Field Values

Method Detail

getUsers

public ScarabUser[] getUsers(java.lang.String permission)
                      throws org.apache.torque.TorqueException

Get a list of ScarabUser's that have the given permission in the given module.

Parameters:

permission - a String value

Returns:

ScarabUser[]

Throws:

org.apache.torque.TorqueException

getUsers

public ScarabUser[] getUsers(java.util.List permissions)
                      throws org.apache.torque.TorqueException

Get a list of ScarabUser's that have any of the given permissions in the given module.

Parameters:

permissions - a List value

Returns:

ScarabUser[]

Throws:

org.apache.torque.TorqueException

getUsers

public java.util.List getUsers(java.lang.String firstName,
                               java.lang.String lastName,
                               java.lang.String username,
                               java.lang.String email,
                               IssueType issueType)
                        throws org.apache.torque.TorqueException

Gets users which match all of the given criteria and have at least one permission that is applicable to user attributes active in the given issue type. The String arguments may be null. Implementations are encouraged to include users where the given Strings are contained within respective fields. So firstName=fred would return a user named fredrick.

Throws:

org.apache.torque.TorqueException

getUsers

public ScarabPaginatedList getUsers(java.lang.String name,
                                    java.lang.String username,
                                    MITList mitList,
                                    int offset,
                                    int resultSize,
                                    java.lang.String sortColumn,
                                    java.lang.String sortPolarity,
                                    boolean includeCommitters)
                             throws org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException

Gets users for a given criteria, starting at a particular offset, for a given length, and have at least one permission that is applicable to user attributes active in the given issue type. This method handles the case where limiting the result size is best accomplished by limiting the database transaction size, and not postfiltering the list. This is extremely helpful with large user datasets.

Throws:

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

getName

public java.lang.String getName()

This method is only used by the Turbine Group interface. The implementation of getName() returns a unique name for this Module that is human readable because our implementation of Flux needs it as well as the fact that each Group needs to have a unique name. If you want to get the actual name of the Module, you need to call the getRealName method.

setName

public void setName(java.lang.String name)

getRealName

public java.lang.String getRealName()

This method is only used by the Turbine Group interface. The implementation of getName() returns a unique name for this Module that is human readable because our implementation of Flux needs it as well as the fact that each Group needs to have a unique name. If you want to get the actual name of the Module, you need to call the getRealName method.

setRealName

public void setRealName(java.lang.String name)

getCode

public java.lang.String getCode()

setCode

public void setCode(java.lang.String code)

getHttpDomain

public java.lang.String getHttpDomain()

www.foo.com

setHttpDomain

public void setHttpDomain(java.lang.String domain)

getScarabInstanceId

public java.lang.String getScarabInstanceId()

arbitrary value, represents the individual instance on which this module has been created.

setScarabInstanceId

public void setScarabInstanceId(java.lang.String domain)

getPort

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

the port number used for the domain

Throws:

org.apache.torque.TorqueException

setPort

public void setPort(java.lang.String port)
             throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getScheme

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

the scheme (http|https) used

Throws:

org.apache.torque.TorqueException

setScheme

public void setScheme(java.lang.String scheme)
               throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getScriptName

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

the scriptName used: /scarab/issues

Throws:

org.apache.torque.TorqueException

setScriptName

public void setScriptName(java.lang.String scriptName)
                   throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getPrimaryKey

public org.apache.torque.om.ObjectKey getPrimaryKey()

Specified by:

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

setPrimaryKey

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

Specified by:

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

Throws:

org.apache.torque.TorqueException

getModuleId

public java.lang.Integer getModuleId()

setModuleId

public void setModuleId(java.lang.Integer v)
                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getQaContactId

public java.lang.Integer getQaContactId()

Deprecated. THESE WILL BE DEPRECATED

setQaContactId

public void setQaContactId(java.lang.Integer v)
                    throws org.apache.torque.TorqueException

Deprecated. THESE WILL BE DEPRECATED

Throws:

org.apache.torque.TorqueException

getOwnerId

public java.lang.Integer getOwnerId()

setOwnerId

public void setOwnerId(java.lang.Integer v)
                throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getAttributes

public java.util.List getAttributes(org.apache.torque.util.Criteria criteria)
                             throws org.apache.torque.TorqueException

gets a list of all of the Attributes in a Module based on the Criteria.

Throws:

org.apache.torque.TorqueException

getAttributes

public java.util.List getAttributes(IssueType issueType)
                             throws org.apache.torque.TorqueException

Gets a list of attributes for this module with a specific issue type.

Throws:

org.apache.torque.TorqueException

getAllAttributes

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

Gets a list of all of the Attributes in this module.

Throws:

org.apache.torque.TorqueException

createNewGroup

public AttributeGroup createNewGroup(IssueType issueType)
                              throws org.apache.torque.TorqueException

Creates new attribute group.

Throws:

org.apache.torque.TorqueException

getDedupeGroupsWithAttributes

public java.util.List getDedupeGroupsWithAttributes(IssueType issueType)
                                             throws org.apache.torque.TorqueException

This method is used within Wizard1.vm to get a list of attribute groups which are marked as dedupe and have a list of attributes in them.

Throws:

org.apache.torque.TorqueException

getDedupeAttributeGroups

public java.util.List getDedupeAttributeGroups(IssueType issueType)
                                        throws org.apache.torque.TorqueException

List of active dedupe attribute groups associated with this module.

Throws:

org.apache.torque.TorqueException

getDedupeAttributeGroups

public java.util.List getDedupeAttributeGroups(IssueType issueType,
                                               boolean activeOnly)
                                        throws org.apache.torque.TorqueException

List of attribute groups associated with this module.

Throws:

org.apache.torque.TorqueException

getDedupeSequence

public int getDedupeSequence(IssueType issueType)
                      throws org.apache.torque.TorqueException

Gets the sequence where the dedupe screen fits between groups.

Throws:

org.apache.torque.TorqueException

getRModuleAttributes

public java.util.List getRModuleAttributes(IssueType issueType,
                                           boolean activeOnly,
                                           java.lang.String attributeType)
                                    throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleAttributes

public java.util.List getRModuleAttributes(IssueType issueType,
                                           boolean activeOnly)
                                    throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleAttributes

public java.util.List getRModuleAttributes(IssueType issueType)
                                    throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleAttributes

public java.util.List getRModuleAttributes(org.apache.torque.util.Criteria criteria)
                                    throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getDefaultRModuleUserAttributes

public java.util.List getDefaultRModuleUserAttributes(IssueType issueType)
                                               throws org.apache.torque.TorqueException

Returns default issue list attributes for this module.

Throws:

org.apache.torque.TorqueException

getRModuleAttribute

public RModuleAttribute getRModuleAttribute(Attribute attribute,
                                            IssueType issueType)
                                     throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getLastAttribute

public int getLastAttribute(IssueType issueType,
                            java.lang.String attributeType)
                     throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getLastAttributeOption

public int getLastAttributeOption(Attribute attribute,
                                  IssueType issueType)
                           throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getQueryKey

public java.lang.String getQueryKey()

getDeleted

public boolean getDeleted()

setDeleted

public void setDeleted(boolean b)

getParentId

public java.lang.Integer getParentId()
                              throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

setParentId

public void setParentId(java.lang.Integer v)
                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

setParent

public void setParent(Module module)
               throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getParent

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

Same as the getModuleRelatedByParentIdCast(), just a better name.

Throws:

org.apache.torque.TorqueException

getAncestors

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

Returns this ModuleEntities ancestors in ascending order. It does not return the 0 parent though.

Throws:

org.apache.torque.TorqueException

isEndlessLoop

public boolean isEndlessLoop(Module parent)
                      throws org.apache.torque.TorqueException

check for endless loops where Module A > Module B > Module A

Throws:

org.apache.torque.TorqueException

getNewIssue

public Issue getNewIssue(IssueType issueType)
                  throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleIssueTypes

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

Throws:

org.apache.torque.TorqueException

getRModuleOptions

public java.util.List getRModuleOptions(Attribute attribute,
                                        IssueType issueType)
                                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleOptions

public java.util.List getRModuleOptions(Attribute attribute,
                                        IssueType issueType,
                                        boolean activeOnly)
                                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleOptions

public java.util.List getRModuleOptions(org.apache.torque.util.Criteria crit)
                                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getLeafRModuleOptions

public java.util.List getLeafRModuleOptions(Attribute attribute,
                                            IssueType issueType)
                                     throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getLeafRModuleOptions

public java.util.List getLeafRModuleOptions(Attribute attribute,
                                            IssueType issueType,
                                            boolean activeOnly)
                                     throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleOption

public RModuleOption getRModuleOption(AttributeOption option,
                                      IssueType issueType)
                               throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getEligibleUsers

public ScarabUser[] getEligibleUsers(Attribute attribute)
                              throws org.apache.torque.TorqueException,
                                     ScarabException

Throws:

org.apache.torque.TorqueException

ScarabException

getEligibleIssueReporters

public ScarabUser[] getEligibleIssueReporters()
                                       throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getSavedReports

public java.util.List getSavedReports(ScarabUser user)
                               throws org.apache.torque.TorqueException,
                                      ScarabException

List of saved reports associated with this module and created by the given user.

Parameters:

user - the user

Returns:

a List value

Throws:

org.apache.torque.TorqueException

ScarabException

getUserAttributes

public java.util.List getUserAttributes(IssueType issueType,
                                        boolean activeOnly)
                                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getUserAttributes

public java.util.List getUserAttributes(IssueType issueType)
                                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getUserPermissions

public java.util.List getUserPermissions(IssueType issueType)
                                  throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getRModuleIssueType

public RModuleIssueType getRModuleIssueType(IssueType issueType)
                                     throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

addIssueType

public void addIssueType(IssueType issueType)
                  throws org.apache.torque.TorqueException,
                         ValidationException,
                         com.workingdogs.village.DataSetException,
                         ScarabException

Throws:

org.apache.torque.TorqueException

ValidationException

com.workingdogs.village.DataSetException

ScarabException

addAttributeOption

public void addAttributeOption(IssueType issueType,
                               AttributeOption option)
                        throws org.apache.torque.TorqueException,
                               ScarabException

Throws:

org.apache.torque.TorqueException

ScarabException

addRModuleAttribute

public RModuleAttribute addRModuleAttribute(IssueType issueType,
                                            Attribute attribute)
                                     throws org.apache.torque.TorqueException,
                                            ScarabException

Adds module-attribute mapping to module.

Throws:

org.apache.torque.TorqueException

ScarabException

addRModuleOption

public RModuleOption addRModuleOption(IssueType issueType,
                                      AttributeOption option)
                               throws org.apache.torque.TorqueException

Adds module-attribute-option mapping to module.

Throws:

org.apache.torque.TorqueException

getIssueTypes

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

Throws:

org.apache.torque.TorqueException

getIssueTypes

public java.util.List getIssueTypes(boolean activeOnly)
                             throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getTemplateTypes

public java.util.List getTemplateTypes()
                                throws org.apache.torque.TorqueException,
                                       ScarabException

Throws:

org.apache.torque.TorqueException

ScarabException

getNavIssueTypes

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

Throws:

org.apache.torque.TorqueException

allowsMultipleVoting

public boolean allowsMultipleVoting()

Determines whether this module allows users to vote many times for the same issue. This feature needs schema change to allow a configuration screen. Currently only one vote per issue is supported

Returns:

false

getUnusedVoteCount

public int getUnusedVoteCount(ScarabUser user)

How many votes does the user have left to cast. Currently always returns 1, so a user has unlimited voting rights. Should look to UserVote for the answer when implemented properly.

getUnapprovedQueries

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

Returns list of queries needing approval.

Throws:

org.apache.torque.TorqueException

getUnapprovedTemplates

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

Returns list of enter issue templates needing approval.

Throws:

org.apache.torque.TorqueException

getOptionTree

public java.util.List getOptionTree(Attribute attribute,
                                    IssueType issueType)
                             throws org.apache.torque.TorqueException

Gets a list of active RModuleOptions which have had their level within the options for this module set.

Parameters:

attribute - an Attribute value

Returns:

a List value

Throws:

java.lang.Exception - if an error occurs

org.apache.torque.TorqueException

getOptionTree

public java.util.List getOptionTree(Attribute attribute,
                                    IssueType issueType,
                                    boolean activeOnly)
                             throws org.apache.torque.TorqueException

Gets a list of RModuleOptions which have had their level within the options for this module set.

Parameters:

attribute - an Attribute value

activeOnly - a boolean value

Returns:

a List value

Throws:

java.lang.Exception - if an error occurs

org.apache.torque.TorqueException

getArchiveEmail

public java.lang.String getArchiveEmail()

All emails related to this module will have a copy sent to this address.

getSystemEmail

public java.lang.String[] getSystemEmail()

The default address that is used to fill out either the From or ReplyTo header on emails related to this module. In many cases the From field is taken as the user who acted that resulted in the email, but replies should still go to the central location for the module, so in this address would be used in the ReplyTo field.

Returns:

a String[] of length=2 where the first element is a name such as "Scarab System" and the second is an email address.

isIssueReasonRequired

public boolean isIssueReasonRequired()

Determines wether a 'reason' is required for every change in the issues of this module. This can be both because of the module configuration and the configuration of the first module up the hierarchy that set this option up.

Returns:

isIssueReasonRequiredInherited

public boolean isIssueReasonRequiredInherited()

Determines if the value of isIssueReasonRequired is due to the configuration of this module or inherited from ancestors or default configuration.

Returns:

True if the configuration is inherited.

getRequiredRole

public org.apache.fulcrum.security.entity.Role getRequiredRole()

Returns the required role for *any* access to this module including for requesting roles.

Returns:

allowsNewIssues

public boolean allowsNewIssues()

Determines whether this module is accepting new issues.

getCommentRenderingEngine

public java.lang.String getCommentRenderingEngine()

Retruns the currently used rendering engine for comments

allowsIssues

public boolean allowsIssues()

Determines whether this module accepts issues.

isInitializing

public boolean isInitializing()
                       throws org.apache.torque.TorqueException

Returns true if no issue types are associated with this module, or if the module is currently getting its initial values set.

Throws:

org.apache.torque.TorqueException

isGlobalModule

public boolean isGlobalModule()

Returns true if this module is the the top level parent module.

Returns:

a boolean value

getIssueRegex

public org.apache.regexp.REProgram getIssueRegex()
                                          throws org.apache.torque.TorqueException

returns a compiled regex that can used to create a new RE for matching some given text.

Throws:

org.apache.torque.TorqueException

getIssueById

public Issue getIssueById(java.lang.String id)
                   throws org.apache.torque.TorqueException

Deprecated. use IssueManager.getIssueById(String id, String defaultCode) I think this method should only return issues from this module, but there is only one place in the code where something like that was needed and the check is done there. Its possible we would want to define this method to return issues in children or some other criteria. deprecating for removal until a definite reason for it to exist appears.

This method is useful for getting an issue object by a String id. It has some logic in it for appending the Module Code as well as stripping spaces off the id value using the String.trim() method.

Throws:

org.apache.torque.TorqueException

toString

public java.lang.String toString()

getRoles

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

Throws:

org.apache.torque.TorqueException

getLocale

public java.util.Locale getLocale()

The default locale for this module will be used in cases where a response is going to no particular user (a mailing list) or can also be used as a default in cases where a user does not have a preference.

Returns:

a Locale value