Java Doc for Module.java in » Issue-Tracking » scarab-0.21 » org » tigris » scarab » om » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Issue Tracking » scarab 0.21 » org.tigris.scarab.om

Source Cross Reference Class Diagram Java Document (Java Doc)

org.tigris.scarab.om .Module

All known Subclasses:   org.tigris.scarab.om .ScarabModule,  org.tigris.scarab.om .AbstractScarabModule,
Module
public interface Module extends Serializable,Persistent(Code)
This class describes a Module within the Scarab system
author:
   Jon S. Stevens
version:
   $Id: Module.java 10198 2006-07-03 23:33:30Z dabbous $

Field Summary
final L10NKey NAME_DELIMINATOR
     The deliminator between parent/child Modules This is used to build up the getName() results.
final String NON_USER

final Integer ROOT_ID

final 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.
List getAllAttributes()
     Gets a list of all of the Attributes in this module.
List getAncestors()
     Returns this ModuleEntities ancestors in ascending order.
String getArchiveEmail()
     All emails related to this module will have a copy sent to this address.
List getAttributes(Criteria criteria)
     gets a list of all of the Attributes in a Module based on the Criteria.
List getAttributes(IssueType issueType)
     Gets a list of attributes for this module with a specific issue type.
String getCode()

String getCommentRenderingEngine()

List getDedupeAttributeGroups(IssueType issueType)
     List of active dedupe attribute groups associated with this module.
List getDedupeAttributeGroups(IssueType issueType, boolean activeOnly)
     List of attribute groups associated with this module.
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.
List getDefaultRModuleUserAttributes(IssueType issueType)
     Returns default issue list attributes for this module.
boolean getDeleted()

String getDescription()

ScarabUser[] getEligibleIssueReporters()

ScarabUser[] getEligibleUsers(Attribute attribute)

String getHttpDomain()

Issue getIssueById(String id)
     This method is useful for getting an issue object by a String id.
REProgram getIssueRegex()
     returns a compiled regex that can used to create a new RE for matching some given text.
List getIssueTypes()

List getIssueTypes(boolean activeOnly)

int getLastAttribute(IssueType issueType, String attributeType)

int getLastAttributeOption(Attribute attribute, IssueType issueType)

List getLeafRModuleOptions(Attribute attribute, IssueType issueType)

List getLeafRModuleOptions(Attribute attribute, IssueType issueType, boolean activeOnly)

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.
Integer getModuleId()

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.
List getNavIssueTypes()

Issue getNewIssue(IssueType issueType)

List getOptionTree(Attribute attribute, IssueType issueType)
     Gets a list of active RModuleOptions which have had their level within the options for this module set.
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.
Integer getOwnerId()

Module getParent()
     Same as the getModuleRelatedByParentIdCast(), just a better name.
Integer getParentId()

String getPort()

ObjectKey getPrimaryKey()

Integer getQaContactId()

String getQueryKey()

RModuleAttribute getRModuleAttribute(Attribute attribute, IssueType issueType)

List getRModuleAttributes(IssueType issueType, boolean activeOnly, String attributeType)

List getRModuleAttributes(IssueType issueType, boolean activeOnly)

List getRModuleAttributes(IssueType issueType)

List getRModuleAttributes(Criteria criteria)

RModuleIssueType getRModuleIssueType(IssueType issueType)

List getRModuleIssueTypes()

RModuleOption getRModuleOption(AttributeOption option, IssueType issueType)

List getRModuleOptions(Attribute attribute, IssueType issueType)

List getRModuleOptions(Attribute attribute, IssueType issueType, boolean activeOnly)

List getRModuleOptions(Criteria crit)

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.
public Role getRequiredRole()
     Returns the required role for *any* access to this module including for requesting roles.
List getRoles()

List getSavedReports(ScarabUser user)
     List of saved reports associated with this module and created by the given user.
String getScarabInstanceId()
     arbitrary value, represents the individual instance on which this module has been created.
String getScheme()

String getScriptName()

String[] getSystemEmail()
     The default address that is used to fill out either the From or ReplyTo header on emails related to this module.
List getTemplateTypes()

List getUnapprovedQueries()
     Returns list of queries needing approval.
List getUnapprovedTemplates()
     Returns list of enter issue templates needing approval.
int getUnusedVoteCount(ScarabUser user)
     How many votes does the user have left to cast.
String getUrl()

List getUserAttributes(IssueType issueType, boolean activeOnly)

List getUserAttributes(IssueType issueType)

List getUserPermissions(IssueType issueType)

ScarabUser[] getUsers(String permission)
     Get a list of ScarabUser's that have the given permission in the given module.
ScarabUser[] getUsers(List permissions)
     Get a list of ScarabUser's that have any of the given permissions in the given module.
List getUsers(String firstName, String lastName, String username, 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.
ScarabPaginatedList getUsers(String name, String username, MITList mitList, int offset, int resultSize, String sortColumn, 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.
boolean isEndlessLoop(Module parent)

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(String code)

void setDeleted(boolean b)

void setDescription(String description)

void setHttpDomain(String domain)

void setModuleId(Integer v)

void setName(String name)

void setOwnerId(Integer v)

void setParent(Module module)

void setParentId(Integer v)

void setPort(String port)

void setPrimaryKey(ObjectKey key)

void setQaContactId(Integer v)

void setRealName(String name)

void setScarabInstanceId(String domain)

void setScheme(String scheme)

void setScriptName(String scriptName)

void setUrl(String url)

String toString()


Field Detail
NAME_DELIMINATOR
final L10NKey NAME_DELIMINATOR(Code)
The deliminator between parent/child Modules This is used to build up the getName() results.

NON_USER
final String NON_USER(Code)

ROOT_ID
final Integer ROOT_ID(Code)

USER
final String USER(Code)

Method Detail
addAttributeOption
void addAttributeOption(IssueType issueType, AttributeOption option) throws TorqueException, ScarabException(Code)

addIssueType
void addIssueType(IssueType issueType) throws TorqueException, ValidationException, DataSetException, ScarabException(Code)

addRModuleAttribute
RModuleAttribute addRModuleAttribute(IssueType issueType, Attribute attribute) throws TorqueException, ScarabException(Code)
Adds module-attribute mapping to module.

addRModuleOption
RModuleOption addRModuleOption(IssueType issueType, AttributeOption option) throws TorqueException(Code)
Adds module-attribute-option mapping to module.

allowsIssues
boolean allowsIssues()(Code)
Determines whether this module accepts issues.

allowsMultipleVoting
boolean allowsMultipleVoting()(Code)
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 false

allowsNewIssues
boolean allowsNewIssues()(Code)
Determines whether this module is accepting new issues.

createNewGroup
AttributeGroup createNewGroup(IssueType issueType) throws TorqueException(Code)
Creates new attribute group.

getAllAttributes
List getAllAttributes() throws TorqueException(Code)
Gets a list of all of the Attributes in this module.

getAncestors
List getAncestors() throws TorqueException(Code)
Returns this ModuleEntities ancestors in ascending order. It does not return the 0 parent though.

getArchiveEmail
String getArchiveEmail()(Code)
All emails related to this module will have a copy sent to this address.

getAttributes
List getAttributes(Criteria criteria) throws TorqueException(Code)
gets a list of all of the Attributes in a Module based on the Criteria.

getAttributes
List getAttributes(IssueType issueType) throws TorqueException(Code)
Gets a list of attributes for this module with a specific issue type.

getCode
String getCode()(Code)

getCommentRenderingEngine
String getCommentRenderingEngine()(Code)
Retruns the currently used rendering engine for comments

getDedupeAttributeGroups
List getDedupeAttributeGroups(IssueType issueType) throws TorqueException(Code)
List of active dedupe attribute groups associated with this module.

getDedupeAttributeGroups
List getDedupeAttributeGroups(IssueType issueType, boolean activeOnly) throws TorqueException(Code)
List of attribute groups associated with this module.

getDedupeGroupsWithAttributes
List getDedupeGroupsWithAttributes(IssueType issueType) throws TorqueException(Code)
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.

getDedupeSequence
int getDedupeSequence(IssueType issueType) throws TorqueException(Code)
Gets the sequence where the dedupe screen fits between groups.

getDefaultRModuleUserAttributes
List getDefaultRModuleUserAttributes(IssueType issueType) throws TorqueException(Code)
Returns default issue list attributes for this module.

getDeleted
boolean getDeleted()(Code)

getDescription
String getDescription()(Code)

getEligibleIssueReporters
ScarabUser[] getEligibleIssueReporters() throws TorqueException(Code)

getEligibleUsers
ScarabUser[] getEligibleUsers(Attribute attribute) throws TorqueException, ScarabException(Code)

getHttpDomain
String getHttpDomain()(Code)
www.foo.com

getIssueById
Issue getIssueById(String id) throws TorqueException(Code)
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.

getIssueRegex
REProgram getIssueRegex() throws TorqueException(Code)
returns a compiled regex that can used to create a new RE for matching some given text.

getIssueTypes
List getIssueTypes() throws TorqueException(Code)

getIssueTypes
List getIssueTypes(boolean activeOnly) throws TorqueException(Code)

getLastAttribute
int getLastAttribute(IssueType issueType, String attributeType) throws TorqueException(Code)

getLastAttributeOption
int getLastAttributeOption(Attribute attribute, IssueType issueType) throws TorqueException(Code)

getLeafRModuleOptions
List getLeafRModuleOptions(Attribute attribute, IssueType issueType) throws TorqueException(Code)

getLeafRModuleOptions
List getLeafRModuleOptions(Attribute attribute, IssueType issueType, boolean activeOnly) throws TorqueException(Code)

getLocale
Locale getLocale()(Code)
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. a Locale value

getModuleId
Integer getModuleId()(Code)

getName
String getName()(Code)
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.

getNavIssueTypes
List getNavIssueTypes() throws TorqueException(Code)

getNewIssue
Issue getNewIssue(IssueType issueType) throws TorqueException(Code)

getOptionTree
List getOptionTree(Attribute attribute, IssueType issueType) throws TorqueException(Code)
Gets a list of active RModuleOptions which have had their level within the options for this module set.
Parameters:
  attribute - an Attribute value a List value
exception:
  Exception - if an error occurs

getOptionTree
List getOptionTree(Attribute attribute, IssueType issueType, boolean activeOnly) throws TorqueException(Code)
Gets a list of RModuleOptions which have had their level within the options for this module set.
Parameters:
  attribute - an Attribute value
Parameters:
  activeOnly - a boolean value a List value
exception:
  Exception - if an error occurs

getOwnerId
Integer getOwnerId()(Code)

getParent
Module getParent() throws TorqueException(Code)
Same as the getModuleRelatedByParentIdCast(), just a better name.

getParentId
Integer getParentId() throws TorqueException(Code)

getPort
String getPort() throws TorqueException(Code)
the port number used for the domain

getPrimaryKey
ObjectKey getPrimaryKey()(Code)

getQaContactId
Integer getQaContactId()(Code)

getQueryKey
String getQueryKey()(Code)

getRModuleAttribute
RModuleAttribute getRModuleAttribute(Attribute attribute, IssueType issueType) throws TorqueException(Code)

getRModuleAttributes
List getRModuleAttributes(IssueType issueType, boolean activeOnly, String attributeType) throws TorqueException(Code)

getRModuleAttributes
List getRModuleAttributes(IssueType issueType, boolean activeOnly) throws TorqueException(Code)

getRModuleAttributes
List getRModuleAttributes(IssueType issueType) throws TorqueException(Code)

getRModuleAttributes
List getRModuleAttributes(Criteria criteria) throws TorqueException(Code)

getRModuleIssueType
RModuleIssueType getRModuleIssueType(IssueType issueType) throws TorqueException(Code)

getRModuleIssueTypes
List getRModuleIssueTypes() throws TorqueException(Code)

getRModuleOption
RModuleOption getRModuleOption(AttributeOption option, IssueType issueType) throws TorqueException(Code)

getRModuleOptions
List getRModuleOptions(Attribute attribute, IssueType issueType) throws TorqueException(Code)

getRModuleOptions
List getRModuleOptions(Attribute attribute, IssueType issueType, boolean activeOnly) throws TorqueException(Code)

getRModuleOptions
List getRModuleOptions(Criteria crit) throws TorqueException(Code)

getRealName
String getRealName()(Code)
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.

getRequiredRole
public Role getRequiredRole()(Code)
Returns the required role for *any* access to this module including for requesting roles.

getRoles
List getRoles() throws TorqueException(Code)

getSavedReports
List getSavedReports(ScarabUser user) throws TorqueException, ScarabException(Code)
List of saved reports associated with this module and created by the given user.
Parameters:
  user - the user a List value

getScarabInstanceId
String getScarabInstanceId()(Code)
arbitrary value, represents the individual instance on which this module has been created.

getScheme
String getScheme() throws TorqueException(Code)
the scheme (http|https) used

getScriptName
String getScriptName() throws TorqueException(Code)
the scriptName used: /scarab/issues

getSystemEmail
String[] getSystemEmail()(Code)
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. a String[] of length=2 where the first elementis a name such as "Scarab System" and the second is an email address.

getTemplateTypes
List getTemplateTypes() throws TorqueException, ScarabException(Code)

getUnapprovedQueries
List getUnapprovedQueries() throws TorqueException(Code)
Returns list of queries needing approval.

getUnapprovedTemplates
List getUnapprovedTemplates() throws TorqueException(Code)
Returns list of enter issue templates needing approval.

getUnusedVoteCount
int getUnusedVoteCount(ScarabUser user)(Code)
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.

getUrl
String getUrl()(Code)

getUserAttributes
List getUserAttributes(IssueType issueType, boolean activeOnly) throws TorqueException(Code)

getUserAttributes
List getUserAttributes(IssueType issueType) throws TorqueException(Code)

getUserPermissions
List getUserPermissions(IssueType issueType) throws TorqueException(Code)

getUsers
ScarabUser[] getUsers(String permission) throws TorqueException(Code)
Get a list of ScarabUser's that have the given permission in the given module.
Parameters:
  permission - a String value ScarabUser[]

getUsers
ScarabUser[] getUsers(List permissions) throws TorqueException(Code)
Get a list of ScarabUser's that have any of the given permissions in the given module.
Parameters:
  permissions - a List value ScarabUser[]

getUsers
List getUsers(String firstName, String lastName, String username, String email, IssueType issueType) throws TorqueException(Code)
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.

getUsers
ScarabPaginatedList getUsers(String name, String username, MITList mitList, int offset, int resultSize, String sortColumn, String sortPolarity, boolean includeCommitters) throws TorqueException, DataSetException(Code)
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.

isEndlessLoop
boolean isEndlessLoop(Module parent) throws TorqueException(Code)
check for endless loops where Module A > Module B > Module A

isGlobalModule
boolean isGlobalModule()(Code)
Returns true if this module is the the top level parent module. a boolean value

isInitializing
boolean isInitializing() throws TorqueException(Code)
Returns true if no issue types are associated with this module, or if the module is currently getting its initial values set.

isIssueReasonRequired
boolean isIssueReasonRequired()(Code)
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.

isIssueReasonRequiredInherited
boolean isIssueReasonRequiredInherited()(Code)
Determines if the value of isIssueReasonRequired is due to the configuration of this module or inherited from ancestors or default configuration. True if the configuration is inherited.

setCode
void setCode(String code)(Code)

setDeleted
void setDeleted(boolean b)(Code)

setDescription
void setDescription(String description)(Code)

setHttpDomain
void setHttpDomain(String domain)(Code)

setModuleId
void setModuleId(Integer v) throws TorqueException(Code)

setName
void setName(String name)(Code)

setOwnerId
void setOwnerId(Integer v) throws TorqueException(Code)

setParent
void setParent(Module module) throws TorqueException(Code)

setParentId
void setParentId(Integer v) throws TorqueException(Code)

setPort
void setPort(String port) throws TorqueException(Code)

setPrimaryKey
void setPrimaryKey(ObjectKey key) throws TorqueException(Code)

setQaContactId
void setQaContactId(Integer v) throws TorqueException(Code)

setRealName
void setRealName(String name)(Code)

setScarabInstanceId
void setScarabInstanceId(String domain)(Code)

setScheme
void setScheme(String scheme) throws TorqueException(Code)

setScriptName
void setScriptName(String scriptName) throws TorqueException(Code)

setUrl
void setUrl(String url)(Code)

toString
String toString()(Code)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.