Java Doc for ScarabUser.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 .ScarabUser

All known Subclasses:   org.tigris.scarab.om .ScarabUserImpl,
ScarabUser
public interface ScarabUser extends User,Persistent(Code)
This is an interface which describes what a ScarabUser is...
author:
   Jon S. Stevens
version:
   $Id: ScarabUser.java 10285 2006-09-08 16:48:22Z jorgeuriarte $

Field Summary
public static String DELETED


Method Summary
void addRMITsToCurrentMITList(List rmits)

void createNewUser()
     This method is responsible for creating a new user.
public AccessControlList getACL()

public List getAllRModuleIssueTypes(Module module)
     returns a list of RModuleIssueTypes for the given module.
public List getAssignIssuesList()

Map getAssociatedUsersMap()

List getCopyToModules(Module currentModule)

List getCopyToModules(Module currentModule, String action)

List getCopyToModules(Module currentModule, String action, String searchString)

IssueType getCurrentIssueType()
     The current issue type which represents the issue type selected by the user within a request.
MITList getCurrentMITList()

Module getCurrentModule()
     The current module which represents the module selected by the user within a request.
RModuleIssueType getCurrentRModuleIssueType()
     The current RModuleIssueType which represents the module and issue type selected by the user within a request.
ReportBridge getCurrentReport(String key)
     Gets an report stored in the temp hash under key.
List getEditableModules()
     Gets all modules the user has permissions to edit.
List getEditableModules(Module currEditModule)
     Gets all modules the user has permissions to edit.
int getEnterIssueRedirect()
     Returns integer representing user preference for Which screen to return to after entering an issue.
String getHomePage()
     The template/tab to show for the home page using the current module.
String getHomePage(Module module)
     The template/tab to show for the home page in the given module.
Locale getLocale()
     Get the user's current locale.
List getMITLists()

List getModules()

List getModules(boolean showDeletedModules)
     Gets all modules which are currently associated with this user.
Module[] getModules(String permission)
     Get a list of Module's that where a user has the specified permission.
Module[] getModules(String[] permissions)
     Get a list of Module's that where a user has at least one of the permissions given.
Module[] getModules(String[] permissions, boolean showDeleted)
     Get a list of Module's that where a user has at least one of the permissions given.
String getMostRecentQuery()
     The most recent query entered.
String getName()
     The user's full name.
List getNonGlobalModules()
     Gets all modules the user is associated to, except the Global one.
Locale getPreferredLocale()
     Get the user's preferred locale.
ObjectKey getPrimaryKey()

String getQueryKey()

public String getQueryTarget()
     The template to show if the user is going to start a new query. if the user has not selected a set of issue types it will return IssueTypeList.vm.
RModuleUserAttribute getRModuleUserAttribute(Module module, Attribute attribute, IssueType issueType)
     Returns an RModuleUserAttribute object.
List getRModuleUserAttributes(Module module, IssueType issueType)
     Returns list of RModuleUserAttribute objects for this User and Module -- the attributes the user has selected To appear on the IssueList for this module.
Issue getReportingIssue(String key)
     Gets an issue stored in the temp hash under key.
List getRoleNames(Module module)

List getSearchableRMITs(String searchField, String searchString, String sortColumn, String sortPolarity, Module skipModule)
     Returns a List of RModuleIssueTypes for which the user has the permission to search for issues.
Map getSelectedUsersMap()

Object getThreadKey()
     key used to keep concurrent activities by the same user from overwriting each others state.
public List getUnusedRModuleIssueTypes(Module module)
     returns a list of RModuleIssueTypes for the given module, excluding any that that have a corresponding MITListItem in the CurrentMITList.
Integer getUserId()

boolean hasAnyRoleIn(Module module)
     Determine whether the user has any role in the given module.
public boolean hasAnySearchableRMITs()
     Checks if the user can search for issues of at least one issue type in one module.
boolean hasMostRecentQuery()

boolean hasPermission(String permission, Module module)
     Returns true if this user has the given permission within the given module, false otherwise.
boolean hasPermission(String permission, List modules)
     Returns true if this user has the given permission within all the given modules, false otherwise.
public boolean hasRoleInModule(Role role, Module module)

boolean isPasswordExpired()

public boolean isShowOtherModulesInIssueTypeList()
     Get the ShowOtherModulesInIssueTypeList value.
public boolean isUserAnonymous()
     Returns true if the user is the one set in scarab.anonymous.username, and false otherwise.
Object lastEnteredIssueTypeOrTemplate()

void removeItemsFromCurrentMITList(String[] ids)

void setAssociatedUsersMap(Map associatedUsers)

void setCurrentIssueType(IssueType v)
     The current issue type which represents the issue type selected by the user within a request.
void setCurrentMITList(MITList list)

void setCurrentModule(Module v)
     The current module which represents the module selected by the user within a request.
String setCurrentReport(ReportBridge report)
     Places an report into the session that can be retrieved using the key that is returned from the method.
void setCurrentReport(String key, ReportBridge report)
     Places an report into the session under the given key.
void setEnterIssueRedirect(int templateCode)
     Sets integer representing user preference for Which screen to return to after entering an issue.
void setHomePage(String homePage)
     The template/tab to show for the home page.
void setLastEnteredIssueType(IssueType type)

void setLastEnteredTemplate(Issue template)

void setLocale(Locale newLocale)
     Set the user's locale to a new value.
void setMostRecentQuery(String queryString)
     The most recent query entered.
void setPasswordExpire()

void setPasswordExpire(Calendar expire)

void setPrimaryKey(ObjectKey v)

void setQueryKey(String key)

String setReportingIssue(Issue issue)
     Places an issue into the session that can be retrieved using the key that is returned from the method.
void setReportingIssue(String key, Issue issue)
     Places an issue into the session under the given key.
void setSelectedUsersMap(Map selectedUsers)

public void setShowOtherModulesInIssueTypeList(boolean newShowOtherModulesInIssueTypeList)
     Set the ShowOtherModulesInIssueTypeList value.
public void setSingleIssueTypeQueryTarget(IssueType type, String target)
     Setup the users preference when entering a query for the given issue type.
void setThreadKey(Integer key)
     key used to keep concurrent activities by the same user from overwriting each others state.
void setUserId(Integer v)

void updateIssueListAttributes(List attributes)
     Updates the attributes shown in IssueList.vm Removes any saved preferences for the current mit list or current module and issue type.

Field Detail
DELETED
public static String DELETED(Code)

Method Detail
addRMITsToCurrentMITList
void addRMITsToCurrentMITList(List rmits) throws TorqueException(Code)

createNewUser
void createNewUser() throws TorqueException, DataBackendException, EntityExistsException(Code)
This method is responsible for creating a new user. It will throw an exception if there is any sort of error (such as a duplicate login id) and place the error message into e.getMessage(). This also creates a uniqueid and places it into this object in the perm table under the Visitor.CONFIRM_VALUE key. It will use the current instance of this object as the basis to create the new User.

getACL
public AccessControlList getACL()(Code)

getAllRModuleIssueTypes
public List getAllRModuleIssueTypes(Module module) throws TorqueException(Code)
returns a list of RModuleIssueTypes for the given module.

getAssignIssuesList
public List getAssignIssuesList()(Code)

getAssociatedUsersMap
Map getAssociatedUsersMap() throws TorqueException(Code)
Get the working list of associated users For the AssignIssue screen

getCopyToModules
List getCopyToModules(Module currentModule) throws TorqueException(Code)

getCopyToModules
List getCopyToModules(Module currentModule, String action) throws TorqueException(Code)

getCopyToModules
List getCopyToModules(Module currentModule, String action, String searchString) throws TorqueException(Code)

getCurrentIssueType
IssueType getCurrentIssueType() throws TorqueException(Code)
The current issue type which represents the issue type selected by the user within a request.

getCurrentMITList
MITList getCurrentMITList()(Code)

getCurrentModule
Module getCurrentModule()(Code)
The current module which represents the module selected by the user within a request.

getCurrentRModuleIssueType
RModuleIssueType getCurrentRModuleIssueType() throws TorqueException(Code)
The current RModuleIssueType which represents the module and issue type selected by the user within a request.

getCurrentReport
ReportBridge getCurrentReport(String key) throws TorqueException(Code)
Gets an report stored in the temp hash under key.
Parameters:
  key - a String used as the key to retrieve the report an Report value
exception:
  Exception - if an error occurs

getEditableModules
List getEditableModules() throws TorqueException(Code)
Gets all modules the user has permissions to edit. The default is to not show global modules if you have the permission to edit it.
See Also:   ScarabUser.getEditableModules(Module)

getEditableModules
List getEditableModules(Module currEditModule) throws TorqueException(Code)
Gets all modules the user has permissions to edit.
Parameters:
  currEditModule - the module we are currently editing

getEnterIssueRedirect
int getEnterIssueRedirect() throws TorqueException(Code)
Returns integer representing user preference for Which screen to return to after entering an issue.

getHomePage
String getHomePage() throws TorqueException(Code)
The template/tab to show for the home page using the current module.

getHomePage
String getHomePage(Module module) throws TorqueException(Code)
The template/tab to show for the home page in the given module.

getLocale
Locale getLocale()(Code)
Get the user's current locale.

getMITLists
List getMITLists() throws TorqueException(Code)

getModules
List getModules() throws TorqueException(Code)
Gets all modules which are currently associated with this user (relationship has not been deleted.)

getModules
List getModules(boolean showDeletedModules) throws TorqueException(Code)
Gets all modules which are currently associated with this user.
Parameters:
  showDeletedModules - show modules which have been marked as deleted

getModules
Module[] getModules(String permission) throws TorqueException(Code)
Get a list of Module's that where a user has the specified permission. Does not show deleted modules. (showDeleted = false)
Parameters:
  permission - a String value a Module[] value

getModules
Module[] getModules(String[] permissions) throws TorqueException(Code)
Get a list of Module's that where a user has at least one of the permissions given. Does not show deleted modules. (showDeleted = false)
Parameters:
  permissions - a String[] value a Module[] value

getModules
Module[] getModules(String[] permissions, boolean showDeleted) throws TorqueException(Code)
Get a list of Module's that where a user has at least one of the permissions given. Does not show deleted modules.
Parameters:
  permissions - a String[] value
Parameters:
  showDeleted - a boolean value a Module[] value

getMostRecentQuery
String getMostRecentQuery()(Code)
The most recent query entered. This method has the effect of loading the MITList used for the query (if one exists) as the CurrentMITList so it should only be called if the query is to be used. Use @see #hasMostRecentQuery() to determine existence.

getName
String getName()(Code)
The user's full name.

getNonGlobalModules
List getNonGlobalModules() throws TorqueException(Code)
Gets all modules the user is associated to, except the Global one.
throws:
  TorqueException -

getPreferredLocale
Locale getPreferredLocale()(Code)
Get the user's preferred locale.

getPrimaryKey
ObjectKey getPrimaryKey()(Code)

getQueryKey
String getQueryKey()(Code)
Implementation of the Retrievable interface because this object is used with Intake

getQueryTarget
public String getQueryTarget()(Code)
The template to show if the user is going to start a new query. if the user has not selected a set of issue types it will return IssueTypeList.vm. If a list is already selected, then it will go to AdvancedQuery.vm unless the list is only one issue type and the user has last selected Custom query for that issue type.

getRModuleUserAttribute
RModuleUserAttribute getRModuleUserAttribute(Module module, Attribute attribute, IssueType issueType) throws TorqueException, ScarabException(Code)
Returns an RModuleUserAttribute object.

getRModuleUserAttributes
List getRModuleUserAttributes(Module module, IssueType issueType) throws TorqueException(Code)
Returns list of RModuleUserAttribute objects for this User and Module -- the attributes the user has selected To appear on the IssueList for this module.

getReportingIssue
Issue getReportingIssue(String key) throws TorqueException(Code)
Gets an issue stored in the temp hash under key.
Parameters:
  key - a String used as the key to retrieve the issue an Issue value
exception:
  Exception - if an error occurs

getRoleNames
List getRoleNames(Module module) throws TorqueException(Code)

getSearchableRMITs
List getSearchableRMITs(String searchField, String searchString, String sortColumn, String sortPolarity, Module skipModule) throws TorqueException(Code)
Returns a List of RModuleIssueTypes for which the user has the permission to search for issues.
Parameters:
  skipModule - do not include issue types for this module. Usefulfor separating the current module. a List value
exception:
  Exception - if an error occurs

getSelectedUsersMap
Map getSelectedUsersMap() throws TorqueException(Code)
Get the working list of associated users For the AssignIssue screen

getThreadKey
Object getThreadKey()(Code)
key used to keep concurrent activities by the same user from overwriting each others state.

getUnusedRModuleIssueTypes
public List getUnusedRModuleIssueTypes(Module module) throws TorqueException(Code)
returns a list of RModuleIssueTypes for the given module, excluding any that that have a corresponding MITListItem in the CurrentMITList.

getUserId
Integer getUserId()(Code)

hasAnyRoleIn
boolean hasAnyRoleIn(Module module) throws TorqueException(Code)
Determine whether the user has any role in the given module. This only checks roles directly in this module, not in the "Global" module.
Parameters:
  module - a Module value a boolean value

hasAnySearchableRMITs
public boolean hasAnySearchableRMITs() throws TorqueException, DataSetException(Code)
Checks if the user can search for issues of at least one issue type in one module.

hasMostRecentQuery
boolean hasMostRecentQuery()(Code)
Check if the user has a previous query

hasPermission
boolean hasPermission(String permission, Module module)(Code)
Returns true if this user has the given permission within the given module, false otherwise.
Parameters:
  permission - a String permission value, which shouldbe a constant in this interface.
Parameters:
  module - a Module value true if the permission exists for the user within thegiven module, false otherwise

hasPermission
boolean hasPermission(String permission, List modules)(Code)
Returns true if this user has the given permission within all the given modules, false otherwise. If the list is null or empty

hasRoleInModule
public boolean hasRoleInModule(Role role, Module module)(Code)

isPasswordExpired
boolean isPasswordExpired() throws TorqueException, ScarabException(Code)
Used for the password management features

isShowOtherModulesInIssueTypeList
public boolean isShowOtherModulesInIssueTypeList()(Code)
Get the ShowOtherModulesInIssueTypeList value. toggle switch for show/hide the cross module section of the issue type selection widget. the ShowOtherModulesInIssueTypeList value.

isUserAnonymous
public boolean isUserAnonymous()(Code)
Returns true if the user is the one set in scarab.anonymous.username, and false otherwise.

lastEnteredIssueTypeOrTemplate
Object lastEnteredIssueTypeOrTemplate()(Code)

removeItemsFromCurrentMITList
void removeItemsFromCurrentMITList(String[] ids)(Code)

setAssociatedUsersMap
void setAssociatedUsersMap(Map associatedUsers) throws TorqueException(Code)
Set the working list of associated users For the AssignIssue screen

setCurrentIssueType
void setCurrentIssueType(IssueType v)(Code)
The current issue type which represents the issue type selected by the user within a request.

setCurrentMITList
void setCurrentMITList(MITList list)(Code)

setCurrentModule
void setCurrentModule(Module v)(Code)
The current module which represents the module selected by the user within a request.

setCurrentReport
String setCurrentReport(ReportBridge report) throws ScarabException(Code)
Places an report into the session that can be retrieved using the key that is returned from the method.
Parameters:
  report - an ReportBridge to store in the session under a new key a String value that can be used to retrieve the report
exception:
  ScarabException - if report is null.

setCurrentReport
void setCurrentReport(String key, ReportBridge report)(Code)
Places an report into the session under the given key. If another report was already using that key, it will be overwritten. Giving a null report removes any report stored using key. This method is primarily used to remove the report from storage. Inserting a new report would be most likely done with setCurrentReport(ReportBridge report).
Parameters:
  key - a String value under which to store the report
Parameters:
  report - an ReportBridge value to store, null removes any report already stored under key.

setEnterIssueRedirect
void setEnterIssueRedirect(int templateCode) throws TorqueException(Code)
Sets integer representing user preference for Which screen to return to after entering an issue.

setHomePage
void setHomePage(String homePage) throws TorqueException, ScarabException(Code)
The template/tab to show for the home page.

setLastEnteredIssueType
void setLastEnteredIssueType(IssueType type)(Code)

setLastEnteredTemplate
void setLastEnteredTemplate(Issue template)(Code)

setLocale
void setLocale(Locale newLocale)(Code)
Set the user's locale to a new value.

setMostRecentQuery
void setMostRecentQuery(String queryString)(Code)
The most recent query entered.

setPasswordExpire
void setPasswordExpire() throws TorqueException(Code)
Used for the password management features

setPasswordExpire
void setPasswordExpire(Calendar expire) throws TorqueException(Code)
Used for the password management features

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

setQueryKey
void setQueryKey(String key) throws TorqueException(Code)
Implementation of the Retrievable interface because this object is used with Intake

setReportingIssue
String setReportingIssue(Issue issue) throws ScarabException(Code)
Places an issue into the session that can be retrieved using the key that is returned from the method.
Parameters:
  issue - an Issue to store in the session under a new key a String value that can be used to retrieve the issue
exception:
  ScarabException - if issue is null.

setReportingIssue
void setReportingIssue(String key, Issue issue)(Code)
Places an issue into the session under the given key. If another issue was already using that key, it will be overwritten. Giving a null issue removes any issue stored using key. This method is primarily used to remove the issue from storage. Inserting a new issue would be most likely done with setReportingIssue(Issue issue).
Parameters:
  key - a String value under which to store the issue
Parameters:
  issue - an Issue value to store, null removes any issue already stored under key.

setSelectedUsersMap
void setSelectedUsersMap(Map selectedUsers) throws TorqueException(Code)
Set the working list of associated users For the AssignIssue screen

setShowOtherModulesInIssueTypeList
public void setShowOtherModulesInIssueTypeList(boolean newShowOtherModulesInIssueTypeList)(Code)
Set the ShowOtherModulesInIssueTypeList value. toggle switch for show/hide the cross module section of the issue type selection widget.
Parameters:
  newShowOtherModulesInIssueTypeList - The new ShowOtherModulesInIssueTypeList value.

setSingleIssueTypeQueryTarget
public void setSingleIssueTypeQueryTarget(IssueType type, String target)(Code)
Setup the users preference when entering a query for the given issue type. Valid values of target are AdvancedQuery.vm and Search.vm (Custom query).

setThreadKey
void setThreadKey(Integer key)(Code)
key used to keep concurrent activities by the same user from overwriting each others state.

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

updateIssueListAttributes
void updateIssueListAttributes(List attributes) throws TorqueException, TurbineSecurityException(Code)
Updates the attributes shown in IssueList.vm Removes any saved preferences for the current mit list or current module and issue type. And replaces them with the attributes given. The order of the attributes is preserved.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.