|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
This is an interface which describes what a ScarabUser is...
| 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 |
public static final java.lang.String DELETED
| Method Detail |
public void createNewUser()
throws org.apache.torque.TorqueException,
org.apache.fulcrum.security.util.DataBackendException,
org.apache.fulcrum.security.util.EntityExistsException
org.apache.torque.TorqueException
org.apache.fulcrum.security.util.DataBackendException
org.apache.fulcrum.security.util.EntityExistsException
public java.util.List getEditableModules()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptiongetEditableModules(Module)
public java.util.List getEditableModules(Module currEditModule)
throws org.apache.torque.TorqueException
currEditModule - the module we are currently editing
org.apache.torque.TorqueException
public java.util.List getNonGlobalModules()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public Issue getReportingIssue(java.lang.String key)
throws org.apache.torque.TorqueException
key - a String used as the key to retrieve the issue
Issue value
java.lang.Exception - if an error occurs
org.apache.torque.TorqueException
public java.lang.String setReportingIssue(Issue issue)
throws ScarabException
issue - an Issue to store in the session under a
new key
String value that can be used to retrieve
the issue
ScarabException - if issue is null.
public void setReportingIssue(java.lang.String key,
Issue issue)
key - a String value under which to store the issueissue - an Issue value to store, null removes any
issue already stored under key.
public ReportBridge getCurrentReport(java.lang.String key)
throws org.apache.torque.TorqueException
key - a String used as the key to retrieve the report
Report value
java.lang.Exception - if an error occurs
org.apache.torque.TorqueException
public java.lang.String setCurrentReport(ReportBridge report)
throws ScarabException
report - an ReportBridge to store in the session under a
new key
String value that can be used to retrieve
the report
ScarabException - if report is null.
public void setCurrentReport(java.lang.String key,
ReportBridge report)
key - a String value under which to store the reportreport - an ReportBridge value to store, null removes any
report already stored under key.
public boolean isPasswordExpired()
throws org.apache.torque.TorqueException,
ScarabException
org.apache.torque.TorqueException
ScarabException
public void setPasswordExpire()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public void setPasswordExpire(java.util.Calendar expire)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic java.lang.Integer getUserId()
public void setUserId(java.lang.Integer v)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic org.apache.torque.om.ObjectKey getPrimaryKey()
getPrimaryKey in interface org.apache.torque.om.Persistent
public void setPrimaryKey(org.apache.torque.om.ObjectKey v)
throws org.apache.torque.TorqueException
setPrimaryKey in interface org.apache.torque.om.Persistentorg.apache.torque.TorqueException
public java.util.List getRModuleUserAttributes(Module module,
IssueType issueType)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public RModuleUserAttribute getRModuleUserAttribute(Module module,
Attribute attribute,
IssueType issueType)
throws org.apache.torque.TorqueException,
ScarabException
org.apache.torque.TorqueException
ScarabExceptionpublic java.lang.String getQueryKey()
public void setQueryKey(java.lang.String key)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public boolean hasPermission(java.lang.String permission,
Module module)
permission - a String permission value, which should
be a constant in this interface.module - a Module value
public boolean hasPermission(java.lang.String permission,
java.util.List modules)
public java.util.List getModules()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public java.util.List getModules(boolean showDeletedModules)
throws org.apache.torque.TorqueException
showDeletedModules - show modules which have been marked as deleted
org.apache.torque.TorqueException
public Module[] getModules(java.lang.String permission)
throws org.apache.torque.TorqueException
Module's that where a user has
the specified permission. Does not show deleted modules.
(showDeleted = false)
permission - a String value
Module[] value
org.apache.torque.TorqueException
public Module[] getModules(java.lang.String[] permissions)
throws org.apache.torque.TorqueException
Module's that where a user has
at least one of the permissions given. Does not show deleted modules.
(showDeleted = false)
permissions - a String[] value
Module[] value
org.apache.torque.TorqueException
public Module[] getModules(java.lang.String[] permissions,
boolean showDeleted)
throws org.apache.torque.TorqueException
Module's that where a user has
at least one of the permissions given. Does not show deleted modules.
permissions - a String[] valueshowDeleted - a boolean value
Module[] value
org.apache.torque.TorqueException
public java.util.List getCopyToModules(Module currentModule)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public java.util.List getCopyToModules(Module currentModule,
java.lang.String action)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public java.util.List getCopyToModules(Module currentModule,
java.lang.String action,
java.lang.String searchString)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public boolean hasAnyRoleIn(Module module)
throws org.apache.torque.TorqueException
module - a Module value
boolean value
org.apache.torque.TorqueExceptionpublic java.lang.String getName()
getName in interface org.apache.fulcrum.security.entity.SecurityEntity
public void setEnterIssueRedirect(int templateCode)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public int getEnterIssueRedirect()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public java.lang.String getHomePage()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public java.lang.String getHomePage(Module module)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public void setHomePage(java.lang.String homePage)
throws org.apache.torque.TorqueException,
ScarabException
org.apache.torque.TorqueException
ScarabExceptionpublic java.lang.String getQueryTarget()
public void setSingleIssueTypeQueryTarget(IssueType type,
java.lang.String target)
public java.util.List getMITLists()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public boolean hasAnySearchableRMITs()
throws org.apache.torque.TorqueException,
com.workingdogs.village.DataSetException
org.apache.torque.TorqueException
com.workingdogs.village.DataSetException
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
skipModule - do not include issue types for this module. Useful
for separating the current module.
List value
java.lang.Exception - if an error occurs
org.apache.torque.TorqueException
public java.util.List getUnusedRModuleIssueTypes(Module module)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public java.util.List getAllRModuleIssueTypes(Module module)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public void addRMITsToCurrentMITList(java.util.List rmits)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic MITList getCurrentMITList()
public void setCurrentMITList(MITList list)
public void removeItemsFromCurrentMITList(java.lang.String[] ids)
public java.lang.Object lastEnteredIssueTypeOrTemplate()
public void setLastEnteredIssueType(IssueType type)
public void setLastEnteredTemplate(Issue template)
public java.lang.String getMostRecentQuery()
public void setMostRecentQuery(java.lang.String queryString)
public boolean hasMostRecentQuery()
public java.lang.Object getThreadKey()
public void setThreadKey(java.lang.Integer key)
public java.util.Map getAssociatedUsersMap()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public void setAssociatedUsersMap(java.util.Map associatedUsers)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public java.util.Map getSelectedUsersMap()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public void setSelectedUsersMap(java.util.Map selectedUsers)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic Module getCurrentModule()
public void setCurrentModule(Module v)
public IssueType getCurrentIssueType()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic void setCurrentIssueType(IssueType v)
public RModuleIssueType getCurrentRModuleIssueType()
throws org.apache.torque.TorqueException
org.apache.torque.TorqueException
public void updateIssueListAttributes(java.util.List attributes)
throws org.apache.torque.TorqueException,
org.apache.fulcrum.security.util.TurbineSecurityException
org.apache.torque.TorqueException
org.apache.fulcrum.security.util.TurbineSecurityException
public java.util.List getRoleNames(Module module)
throws org.apache.torque.TorqueException
org.apache.torque.TorqueExceptionpublic void setLocale(java.util.Locale newLocale)
public java.util.Locale getLocale()
public java.util.Locale getPreferredLocale()
public boolean isShowOtherModulesInIssueTypeList()
public void setShowOtherModulesInIssueTypeList(boolean newShowOtherModulesInIssueTypeList)
newShowOtherModulesInIssueTypeList - The new
ShowOtherModulesInIssueTypeList value.public boolean isUserAnonymous()
public java.util.List getAssignIssuesList()
public org.apache.fulcrum.security.util.AccessControlList getACL()
public boolean hasRoleInModule(org.apache.fulcrum.security.entity.Role role,
Module module)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||