org.tigris.scarab.om
Interface ScarabUser

All Superinterfaces:
org.apache.torque.om.Persistent, org.apache.fulcrum.security.entity.SecurityEntity, java.io.Serializable, org.apache.fulcrum.security.session.SessionBindingListener, org.apache.fulcrum.security.entity.User
All Known Implementing Classes:
ScarabUserImpl

public interface ScarabUser
extends org.apache.fulcrum.security.entity.User, org.apache.torque.om.Persistent

This is an interface which describes what a ScarabUser is...

Version:
$Id: ScarabUser.java 10273 2006-08-30 22:37:32Z jorgeuriarte $
Author:
Jon S. Stevens

Field Summary
static java.lang.String DELETED
           
 
Fields inherited from interface org.apache.fulcrum.security.entity.User
ACCESS_COUNTER, CONFIRM_DATA, CONFIRM_VALUE, EMAIL, FIRST_NAME, HAS_LOGGED_IN, LAST_LOGIN, LAST_NAME, PASSWORD, SESSION_ACCESS_COUNTER, SESSION_KEY, USERNAME
 
Method Summary
 void addRMITsToCurrentMITList(java.util.List rmits)
           
 void createNewUser()
          This method is responsible for creating a new user.
 org.apache.fulcrum.security.util.AccessControlList getACL()
           
 java.util.List getAllRModuleIssueTypes(Module module)
          returns a list of RModuleIssueTypes for the given module.
 java.util.List getAssignIssuesList()
           
 java.util.Map getAssociatedUsersMap()
          Get the working list of associated users For the AssignIssue screen
 java.util.List getCopyToModules(Module currentModule)
           
 java.util.List getCopyToModules(Module currentModule, java.lang.String action)
           
 java.util.List getCopyToModules(Module currentModule, java.lang.String action, java.lang.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.
 ReportBridge getCurrentReport(java.lang.String key)
          Gets an report stored in the temp hash under key.
 RModuleIssueType getCurrentRModuleIssueType()
          The current RModuleIssueType which represents the module and issue type selected by the user within a request.
 java.util.List getEditableModules()
          Gets all modules the user has permissions to edit.
 java.util.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.
 java.lang.String getHomePage()
          The template/tab to show for the home page using the current module.
 java.lang.String getHomePage(Module module)
          The template/tab to show for the home page in the given module.
 java.util.Locale getLocale()
          Get the user's current locale.
 java.util.List getMITLists()
           
 java.util.List getModules()
          Gets all modules which are currently associated with this user (relationship has not been deleted.)
 java.util.List getModules(boolean showDeletedModules)
          Gets all modules which are currently associated with this user.
 Module[] getModules(java.lang.String permission)
          Get a list of Module's that where a user has the specified permission.
 Module[] getModules(java.lang.String[] permissions)
          Get a list of Module's that where a user has at least one of the permissions given.
 Module[] getModules(java.lang.String[] permissions, boolean showDeleted)
          Get a list of Module's that where a user has at least one of the permissions given.
 java.lang.String getMostRecentQuery()
          The most recent query entered.
 java.lang.String getName()
          The user's full name.
 java.util.List getNonGlobalModules()
          Gets all modules the user is associated to, except the Global one.
 java.util.Locale getPreferredLocale()
          Get the user's preferred locale.
 org.apache.torque.om.ObjectKey getPrimaryKey()
           
 java.lang.String getQueryKey()
          Implementation of the Retrievable interface because this object is used with Intake
 java.lang.String getQueryTarget()
          The template to show if the user is going to start a new query.
 Issue getReportingIssue(java.lang.String key)
          Gets an issue stored in the temp hash under key.
 RModuleUserAttribute getRModuleUserAttribute(Module module, Attribute attribute, IssueType issueType)
          Returns an RModuleUserAttribute object.
 java.util.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.
 java.util.List getRoleNames(Module module)
           
 java.util.List getSearchableRMITs(java.lang.String searchField, java.lang.String searchString, java.lang.String sortColumn, java.lang.String sortPolarity, Module skipModule)
          Returns a List of RModuleIssueTypes for which the user has the permission to search for issues.
 java.util.Map getSelectedUsersMap()
          Get the working list of associated users For the AssignIssue screen
 java.lang.Object getThreadKey()
          key used to keep concurrent activities by the same user from overwriting each others state.
 java.util.List getUnusedRModuleIssueTypes(Module module)
          returns a list of RModuleIssueTypes for the given module, excluding any that that have a corresponding MITListItem in the CurrentMITList.
 java.lang.Integer getUserId()
           
 boolean hasAnyRoleIn(Module module)
          Determine whether the user has any role in the given module.
 boolean hasAnySearchableRMITs()
          Checks if the user can search for issues of at least one issue type in one module.
 boolean hasMostRecentQuery()
          Check if the user has a previous query
 boolean hasPermission(java.lang.String permission, java.util.List modules)
          Returns true if this user has the given permission within all the given modules, false otherwise.
 boolean hasPermission(java.lang.String permission, Module module)
          Returns true if this user has the given permission within the given module, false otherwise.
 boolean hasRoleInModule(org.apache.fulcrum.security.entity.Role role, Module module)
           
 boolean isPasswordExpired()
          Used for the password management features
 boolean isShowOtherModulesInIssueTypeList()
          Get the ShowOtherModulesInIssueTypeList value.
 boolean isUserAnonymous()
          Returns true if the user is the one set in scarab.anonymous.username, and false otherwise.
 java.lang.Object lastEnteredIssueTypeOrTemplate()
           
 void removeItemsFromCurrentMITList(java.lang.String[] ids)
           
 void setAssociatedUsersMap(java.util.Map associatedUsers)
          Set the working list of associated users For the AssignIssue screen
 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.
 java.lang.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(java.lang.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(java.lang.String homePage)
          The template/tab to show for the home page.
 void setLastEnteredIssueType(IssueType type)
           
 void setLastEnteredTemplate(Issue template)
           
 void setLocale(java.util.Locale newLocale)
          Set the user's locale to a new value.
 void setMostRecentQuery(java.lang.String queryString)
          The most recent query entered.
 void setPasswordExpire()
          Used for the password management features
 void setPasswordExpire(java.util.Calendar expire)
          Used for the password management features
 void setPrimaryKey(org.apache.torque.om.ObjectKey v)
           
 void setQueryKey(java.lang.String key)
          Implementation of the Retrievable interface because this object is used with Intake
 java.lang.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(java.lang.String key, Issue issue)
          Places an issue into the session under the given key.
 void setSelectedUsersMap(java.util.Map selectedUsers)
          Set the working list of associated users For the AssignIssue screen
 void setShowOtherModulesInIssueTypeList(boolean newShowOtherModulesInIssueTypeList)
          Set the ShowOtherModulesInIssueTypeList value.
 void setSingleIssueTypeQueryTarget(IssueType type, java.lang.String target)
          Setup the users preference when entering a query for the given issue type.
 void setThreadKey(java.lang.Integer key)
          key used to keep concurrent activities by the same user from overwriting each others state.
 void setUserId(java.lang.Integer v)
           
 void updateIssueListAttributes(java.util.List attributes)
          Updates the attributes shown in IssueList.vm Removes any saved preferences for the current mit list or current module and issue type.
 
Methods inherited from interface org.apache.fulcrum.security.entity.User
getAccessCounter, getAccessCounterForSession, getConfirmed, getCreateDate, getEmail, getFirstName, getLastAccessDate, getLastLogin, getLastName, getPassword, getPerm, getPerm, getPermStorage, getTemp, getTemp, getTempStorage, getUserName, hasLoggedIn, incrementAccessCounter, incrementAccessCounterForSession, isConfirmed, removeTemp, setAccessCounter, setAccessCounterForSession, setConfirmed, setCreateDate, setEmail, setFirstName, setHasLoggedIn, setLastAccessDate, setLastLogin, setLastName, setPassword, setPerm, setPermStorage, setTemp, setTempStorage, setUserName, updateLastLogin
 
Methods inherited from interface org.apache.fulcrum.security.session.SessionBindingListener
valueBound, valueUnbound
 
Methods inherited from interface org.apache.fulcrum.security.entity.SecurityEntity
setName
 
Methods inherited from interface org.apache.torque.om.Persistent
isModified, isNew, save, save, save, setModified, setNew, setPrimaryKey
 

Field Detail

DELETED

public static final java.lang.String DELETED
See Also:
Constant Field Values
Method Detail

createNewUser

public void createNewUser()
                   throws org.apache.torque.TorqueException,
                          org.apache.fulcrum.security.util.DataBackendException,
                          org.apache.fulcrum.security.util.EntityExistsException
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.

Throws:
org.apache.torque.TorqueException
org.apache.fulcrum.security.util.DataBackendException
org.apache.fulcrum.security.util.EntityExistsException

getEditableModules

public java.util.List getEditableModules()
                                  throws org.apache.torque.TorqueException
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.

Throws:
org.apache.torque.TorqueException
See Also:
getEditableModules(Module)

getEditableModules

public java.util.List getEditableModules(Module currEditModule)
                                  throws org.apache.torque.TorqueException
Gets all modules the user has permissions to edit.

Parameters:
currEditModule - the module we are currently editing
Throws:
org.apache.torque.TorqueException

getNonGlobalModules

public java.util.List getNonGlobalModules()
                                   throws org.apache.torque.TorqueException
Gets all modules the user is associated to, except the Global one.

Returns:
Throws:
org.apache.torque.TorqueException

getReportingIssue

public Issue getReportingIssue(java.lang.String key)
                        throws org.apache.torque.TorqueException
Gets an issue stored in the temp hash under key.

Parameters:
key - a String used as the key to retrieve the issue
Returns:
an Issue value
Throws:
java.lang.Exception - if an error occurs
org.apache.torque.TorqueException

setReportingIssue

public java.lang.String setReportingIssue(Issue issue)
                                   throws ScarabException
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
Returns:
a String value that can be used to retrieve the issue
Throws:
ScarabException - if issue is null.

setReportingIssue

public void setReportingIssue(java.lang.String key,
                              Issue issue)
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
issue - an Issue value to store, null removes any issue already stored under key.

getCurrentReport

public ReportBridge getCurrentReport(java.lang.String key)
                              throws org.apache.torque.TorqueException
Gets an report stored in the temp hash under key.

Parameters:
key - a String used as the key to retrieve the report
Returns:
an Report value
Throws:
java.lang.Exception - if an error occurs
org.apache.torque.TorqueException

setCurrentReport

public java.lang.String setCurrentReport(ReportBridge report)
                                  throws ScarabException
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
Returns:
a String value that can be used to retrieve the report
Throws:
ScarabException - if report is null.

setCurrentReport

public void setCurrentReport(java.lang.String key,
                             ReportBridge report)
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
report - an ReportBridge value to store, null removes any report already stored under key.

isPasswordExpired

public boolean isPasswordExpired()
                          throws org.apache.torque.TorqueException,
                                 ScarabException
Used for the password management features

Throws:
org.apache.torque.TorqueException
ScarabException

setPasswordExpire

public void setPasswordExpire()
                       throws org.apache.torque.TorqueException
Used for the password management features

Throws:
org.apache.torque.TorqueException

setPasswordExpire

public void setPasswordExpire(java.util.Calendar expire)
                       throws org.apache.torque.TorqueException
Used for the password management features

Throws:
org.apache.torque.TorqueException

getUserId

public java.lang.Integer getUserId()

setUserId

public void setUserId(java.lang.Integer v)
               throws org.apache.torque.TorqueException
Throws:
org.apache.torque.TorqueException

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 v)
                   throws org.apache.torque.TorqueException
Specified by:
setPrimaryKey in interface org.apache.torque.om.Persistent
Throws:
org.apache.torque.TorqueException

getRModuleUserAttributes

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

Throws:
org.apache.torque.TorqueException

getRModuleUserAttribute

public RModuleUserAttribute getRModuleUserAttribute(Module module,
                                                    Attribute attribute,
                                                    IssueType issueType)
                                             throws org.apache.torque.TorqueException,
                                                    ScarabException
Returns an RModuleUserAttribute object.

Throws:
org.apache.torque.TorqueException
ScarabException

getQueryKey

public java.lang.String getQueryKey()
Implementation of the Retrievable interface because this object is used with Intake


setQueryKey

public void setQueryKey(java.lang.String key)
                 throws org.apache.torque.TorqueException
Implementation of the Retrievable interface because this object is used with Intake

Throws:
org.apache.torque.TorqueException

hasPermission

public boolean hasPermission(java.lang.String permission,
                             Module module)
Returns true if this user has the given permission within the given module, false otherwise.

Parameters:
permission - a String permission value, which should be a constant in this interface.
module - a Module value
Returns:
true if the permission exists for the user within the given module, false otherwise

hasPermission

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


getModules

public java.util.List getModules()
                          throws org.apache.torque.TorqueException
Gets all modules which are currently associated with this user (relationship has not been deleted.)

Throws:
org.apache.torque.TorqueException

getModules

public java.util.List getModules(boolean showDeletedModules)
                          throws org.apache.torque.TorqueException
Gets all modules which are currently associated with this user.

Parameters:
showDeletedModules - show modules which have been marked as deleted
Throws:
org.apache.torque.TorqueException

getModules

public Module[] getModules(java.lang.String permission)
                    throws org.apache.torque.TorqueException
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
Returns:
a Module[] value
Throws:
org.apache.torque.TorqueException

getModules

public Module[] getModules(java.lang.String[] permissions)
                    throws org.apache.torque.TorqueException
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
Returns:
a Module[] value
Throws:
org.apache.torque.TorqueException

getModules

public Module[] getModules(java.lang.String[] permissions,
                           boolean showDeleted)
                    throws org.apache.torque.TorqueException
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
showDeleted - a boolean value
Returns:
a Module[] value
Throws:
org.apache.torque.TorqueException

getCopyToModules

public java.util.List getCopyToModules(Module currentModule)
                                throws org.apache.torque.TorqueException
Throws:
org.apache.torque.TorqueException

getCopyToModules

public java.util.List getCopyToModules(Module currentModule,
                                       java.lang.String action)
                                throws org.apache.torque.TorqueException
Throws:
org.apache.torque.TorqueException

getCopyToModules

public java.util.List getCopyToModules(Module currentModule,
                                       java.lang.String action,
                                       java.lang.String searchString)
                                throws org.apache.torque.TorqueException
Throws:
org.apache.torque.TorqueException

hasAnyRoleIn

public boolean hasAnyRoleIn(Module module)
                     throws org.apache.torque.TorqueException
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
Returns:
a boolean value
Throws:
org.apache.torque.TorqueException

getName

public java.lang.String getName()
The user's full name.

Specified by:
getName in interface org.apache.fulcrum.security.entity.SecurityEntity

setEnterIssueRedirect

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

Throws:
org.apache.torque.TorqueException

getEnterIssueRedirect

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

Throws:
org.apache.torque.TorqueException

getHomePage

public java.lang.String getHomePage()
                             throws org.apache.torque.TorqueException
The template/tab to show for the home page using the current module.

Throws:
org.apache.torque.TorqueException

getHomePage

public java.lang.String getHomePage(Module module)
                             throws org.apache.torque.TorqueException
The template/tab to show for the home page in the given module.

Throws:
org.apache.torque.TorqueException

setHomePage

public void setHomePage(java.lang.String homePage)
                 throws org.apache.torque.TorqueException,
                        ScarabException
The template/tab to show for the home page.

Throws:
org.apache.torque.TorqueException
ScarabException

getQueryTarget

public java.lang.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. 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.


setSingleIssueTypeQueryTarget

public void setSingleIssueTypeQueryTarget(IssueType type,
                                          java.lang.String target)
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).


getMITLists

public java.util.List getMITLists()
                           throws org.apache.torque.TorqueException
Throws:
org.apache.torque.TorqueException

hasAnySearchableRMITs

public boolean hasAnySearchableRMITs()
                              throws org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException
Checks if the user can search for issues of at least one issue type in one module.

Throws:
org.apache.torque.TorqueException
com.workingdogs.village.DataSetException

getSearchableRMITs

public java.util.List getSearchableRMITs(java.lang.String searchField,
                                         java.lang.String searchString,
                                         java.lang.String sortColumn,
                                         java.lang.String sortPolarity,
                                         Module skipModule)
                                  throws org.apache.torque.TorqueException
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. Useful for separating the current module.
Returns:
a List value
Throws:
java.lang.Exception - if an error occurs
org.apache.torque.TorqueException

getUnusedRModuleIssueTypes

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

Throws:
org.apache.torque.TorqueException

getAllRModuleIssueTypes

public java.util.List getAllRModuleIssueTypes(Module module)
                                       throws org.apache.torque.TorqueException
returns a list of RModuleIssueTypes for the given module.

Throws:
org.apache.torque.TorqueException

addRMITsToCurrentMITList

public void addRMITsToCurrentMITList(java.util.List rmits)
                              throws org.apache.torque.TorqueException
Throws:
org.apache.torque.TorqueException

getCurrentMITList

public MITList getCurrentMITList()

setCurrentMITList

public void setCurrentMITList(MITList list)

removeItemsFromCurrentMITList

public void removeItemsFromCurrentMITList(java.lang.String[] ids)

lastEnteredIssueTypeOrTemplate

public java.lang.Object lastEnteredIssueTypeOrTemplate()

setLastEnteredIssueType

public void setLastEnteredIssueType(IssueType type)

setLastEnteredTemplate

public void setLastEnteredTemplate(Issue template)

getMostRecentQuery

public java.lang.String getMostRecentQuery()
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.


setMostRecentQuery

public void setMostRecentQuery(java.lang.String queryString)
The most recent query entered.


hasMostRecentQuery

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


getThreadKey

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


setThreadKey

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


getAssociatedUsersMap

public java.util.Map getAssociatedUsersMap()
                                    throws org.apache.torque.TorqueException
Get the working list of associated users For the AssignIssue screen

Throws:
org.apache.torque.TorqueException

setAssociatedUsersMap

public void setAssociatedUsersMap(java.util.Map associatedUsers)
                           throws org.apache.torque.TorqueException
Set the working list of associated users For the AssignIssue screen

Throws:
org.apache.torque.TorqueException

getSelectedUsersMap

public java.util.Map getSelectedUsersMap()
                                  throws org.apache.torque.TorqueException
Get the working list of associated users For the AssignIssue screen

Throws:
org.apache.torque.TorqueException

setSelectedUsersMap

public void setSelectedUsersMap(java.util.Map selectedUsers)
                         throws org.apache.torque.TorqueException
Set the working list of associated users For the AssignIssue screen

Throws:
org.apache.torque.TorqueException

getCurrentModule

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


setCurrentModule

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


getCurrentIssueType

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

Throws:
org.apache.torque.TorqueException

setCurrentIssueType

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


getCurrentRModuleIssueType

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

Throws:
org.apache.torque.TorqueException

updateIssueListAttributes

public void updateIssueListAttributes(java.util.List attributes)
                               throws org.apache.torque.TorqueException,
                                      org.apache.fulcrum.security.util.TurbineSecurityException
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.

Throws:
org.apache.torque.TorqueException
org.apache.fulcrum.security.util.TurbineSecurityException

getRoleNames

public java.util.List getRoleNames(Module module)
                            throws org.apache.torque.TorqueException
Throws:
org.apache.torque.TorqueException

setLocale

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


getLocale

public java.util.Locale getLocale()
Get the user's current locale.


getPreferredLocale

public java.util.Locale getPreferredLocale()
Get the user's preferred locale.


isShowOtherModulesInIssueTypeList

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

Returns:
the ShowOtherModulesInIssueTypeList value.

setShowOtherModulesInIssueTypeList

public void setShowOtherModulesInIssueTypeList(boolean newShowOtherModulesInIssueTypeList)
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.

isUserAnonymous

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

Returns:

getAssignIssuesList

public java.util.List getAssignIssuesList()

getACL

public org.apache.fulcrum.security.util.AccessControlList getACL()

hasRoleInModule

public boolean hasRoleInModule(org.apache.fulcrum.security.entity.Role role,
                               Module module)


Copyright © 2000-2004 Tigris.org. All Rights Reserved.