| Method Summary |
|
| public String | convertPath(String path)
Convert paths with slashes to commas. |
| public static MITListItem | convertToMITListItem(RModuleIssueType rmit)
Create a MITListItem from an RModuleIssueType instance. |
| public void | dispose()
Disposes the object after use. |
| public String | formatDate(String value)
Format a date from internal timestamp value to the user's locale format. |
| public int | getAdjustedPageNum()
Checks for a query parameter "oldResultsPerPage" and compares it
to the current "resultsPerPage" parameter. |
| public Object | getAlert()
Retrieves any Alert! message which has been set. |
| public Object | getAlertMessage()
Get any alert message usually set in the action. |
| public List | getAllIssueTemplates(IssueType issueType)
Returns all issue templates that are global,
Plus those that are personal and created by logged-in user. |
| public List | getAllQueries()
Returns all queries that are global,
Plus those that are personal and created by logged-in user. |
| public List | getAllValidIssueListAttributes()
|
| public Attachment | getAttachment()
A Attachment object for use within the Scarab API. |
| public Attribute | getAttribute()
|
| public Attribute | getAttribute(Integer pk)
A Attribute object for use within the Scarab API. |
| public AttributeGroup | getAttributeGroup()
A AttributeGroup object for use within the Scarab API. |
| public AttributeGroup | getAttributeGroup(String key)
Get a AttributeGroup object. |
| public AttributeOption | getAttributeOption()
A Attribute object for use within the Scarab API. |
| public AttributeOption | getAttributeOption(Integer pk)
A Attribute object for use within the Scarab API. |
| public AttributeOption | getAttributeOption(String key)
|
| public List | getAttributeSearchResults()
Return results of attribute search. |
| public String | getAttributeType(int key)
Retrieves an attribute type from request scope. |
| public Calendar | getCalendar()
This is used to get the format for a date in the
Locale sent by the browser. |
| public Intake | getConditionalIntake(String parameter)
|
| public Object | getConfirmMessage()
Get any confirmation message usually set in the action. |
| public IssueType | getCurrentIssueType()
Gets the IssueType associated with the information
passed around in the query string. |
| public Module | getCurrentModule()
Gets the Module associated with the information
passed around in the query string. |
| public IteratorWithSize | getCurrentSearchResults()
Performs search on current query (which is stored in user session). |
| public int | getCurrentSearchResultsSize()
Gets the number of results for the current query. |
| public String | getCurrentTemplate()
|
| public ScarabUser | getCurrentUser()
retrieves the user from the current request. |
| public DateFormat | getDateFormat()
This is used to get the format for a date in the
Locale sent by the browser. |
| public Depend | getDepend()
A Depend object for use within the Scarab API. |
| public String | getEditLink(String link, Query query)
Generates link to the Query Detail page. |
| public String | getExecuteLink(String link, Query query)
Generates link to Issue List page, re-running stored query. |
| public List | getFrequencies()
Get all frequencies. |
| public List | getGlobalQueries()
Returns all queries that are global. |
| public List | getGlobalQueries(Module module)
|
| public List | getGlobalTemplates(IssueType issueType)
Returns templates that are personal and created by logged-in user. |
| public List | getGlobalUserSearch()
When a user searches for other users (in the ManageUserSearch.vm
template for example), the result of this search is stored into
the temporary data for that user. |
| public String | getGlobalUserSearchParam(String name)
Return the parameter used for the user-search (like in the
ManageUserSearch.vm template for example) returned by the
getGlobalUserSearch() method. |
| public Object | getInfoMessage()
Get any informational message usually set in the action. |
| public Issue | getIssue()
Get an Issue object from unique id given either as an intake
field or a request parameter keyed with "id". |
| public Issue | getIssue(String id)
Takes unique id and returns issue. |
| public Issue | getIssueByPk(String key)
The id may only be the issue's primary key. |
| public Issue | getIssueIncludingDeleted(String id)
Returns an issue given its ID, even if it's been
deleted or moved. |
| public List | getIssueListAttributes(boolean validOnly, boolean commonOnly)
|
| public IssueListIterator | getIssueListIterator(IteratorWithSize iterator, int listOffset, int size)
|
| public int | getIssuePosInList()
Returns the issue's position (1-based) in current issue list. |
| public Issue | getIssueTemplate()
An Enter issue template. |
| public Issue | getIssueTemplate(String templateId)
An Enter issue template. |
| public IssueTemplateInfo | getIssueTemplateInfo()
A IssueTemplateInfo object for use within the Scarab API. |
| public IssueType | getIssueType(String key)
Get a specific issue type by key value. |
| public IssueType | getIssueType()
Get an issue type object. |
| public List | getIssues()
Get a list of Issue objects. |
| public List | getIssues(List issueIds)
Get a list of Issue objects from a list of issue IDs. |
| public Object | getLastEnteredIssueTypeOrTemplate()
|
| public MITList | getMITList(List issues)
|
| public Module | getModule()
Get an Module object. |
| public Module | getModule(String key)
Get a specific module by key value. |
| public int | getNbrPages()
Return the number of paginated pages. |
| public AttributeValue | getNewAttributeValue(Attribute attribute, Issue issue)
|
| public IssueSearch | getNewSearch()
Get a new IssueSearch object. |
| public String | getNextEntryTemplate(IssueType issueType)
Looks at the current RModuleIssueType and if it is null,
returns the users home page. |
| public String | getNextIssue()
Returns next issue id in list. |
| public int | getNextPage()
Return the next page in the paginated list. |
| public ScarabPaginatedList | getPaginatedGlobalUsersList(int pageNum, int resultsPerPage, String searchField, String searchCriteria, String sortColumn, String sortPolarity)
|
| public IteratorWithSize | getPaginatedIterator(IteratorWithSize fullList, int pgNbr, int nbrItmsPerPage)
Return a subset of the passed-in list. |
| public List | getPaginatedList(List fullList, int pgNbr, int nbrItmsPerPage)
Return a subset of the passed-in list. |
| public ParentChildAttributeOption | getParentChildAttributeOption()
Gets an instance of a ParentChildAttributeOption from this tool. |
| public IssueSearch | getPopulatedSearch(String query)
Get an IssueSearch object based on a query string. |
| public IssueSearch | getPopulatedSearch()
Get an IssueSearch object based on current query string. |
| public String | getPrevIssue()
Returns previous issue id in list. |
| public int | getPrevPage()
Return the previous page in the paginated list. |
| public List | getPrivateQueries()
Returns queries that are personal and created by logged-in user. |
| public List | getPrivateTemplates(IssueType issueType)
Returns templates that are personal and created by logged-in user. |
| public Query | getQuery()
A Query object for use within the Scarab API. |
| public RModuleAttribute | getRModuleAttribute()
Get an RModuleAttribute object. |
| public RModuleIssueType | getRModuleIssueType(Integer moduleId, Integer issueTypeId)
|
| public List | getRModuleUserAttributes()
First attempts to get the RModuleUserAttributes from the user. |
| public ROptionOption | getROptionOption()
Gets an instance of a ROptionOption from this tool. |
| public ReportBridge | getReport()
|
| public Issue | getReportingIssue()
The issue that is currently being entered. |
| public List | getScopes()
Get all scopes. |
| public Object | getSessionAttribute(String key)
retrieve an attribute value from the current HttpSession. |
| public List | getSortedAttributeOptions()
|
| public List | getSortedAttributeOptionsForRMIT(RModuleIssueType rmit)
Returned all attribute options allowed for every attribute assigned to this
RModuleIssueType. |
| public Transition | getTransition(Integer pk)
|
| public List | getTransitionMatrix(IssueType issueType, Attribute attribute)
Returns the list of transitions allowed for the current user
in the current module/issueType/attribute combination as a displayable
matrix organized in rows and columns.
The returned list contains the matrix rows.
Each row contains a set of OptionValues and OptionConnectors.
An OptionConnector is a hint for a graphical representation and
can be one of:
- SINGLE or "---"
- FIRST or "-+-"
- INTERMEDIATE or " |-"
- LAST or " +-"
- PASSTHROUGH or " | "
A matrix-The may contain null pointers if there is neither an
OptionValue nor an OptionConnector associated to the cell. |
| public List | getTransitions(IssueType issueType, Attribute attribute)
|
| public ScarabUser | getUser()
A User object for use within the Scarab API. |
| public ScarabUser | getUser(Object id)
Return a specific User by ID from within the system. |
| public List | getUserAllQueries()
Returns all queries that are global. |
| public List | getUserAttributes(List issues, boolean activeOnly)
Gets a list of Attributes or the user type that are in common
between the issues in the given list. |
| public ScarabUser | getUserByUserName(String username)
Return a specific User by username. |
| public ScarabPaginatedList | getUserFilteredSearchResults(MITList mitList, int pageNum, int resultsPerPage, String sortColumn, String sortPolarity, boolean includeCommitters)
Full featured, paginated, sorted version for returning results
of a user search. |
| public List | getUserQueries()
Returns queries that are personal and created by logged-in user. |
| public ScarabPaginatedList | getUserSearchResults(MITList mitList, int pageNum, int resultsPerPage, String sortColumn, String sortPolarity, boolean includeCommitters)
Full featured, paginated, sorted method for returning the results
of user search. |
| public List | getValidIssueListAttributes()
|
| public boolean | hasItemsToApprove()
|
| public boolean | hasPermission(String permission)
Determine if the user currently interacting with the scarab
application has a permission within the user's currently
selected module.
Parameters:
permission - a String permission value, which shouldbe a constant in this interface. |
| public boolean | hasPermission(String permission, Module module)
Determine if the user currently interacting with the scarab
application has a permission within a module. |
| public boolean | hasSessionAttribute(String key)
Check whether the current session has an attribute of given key. |
| public void | init(Object data)
|
| public boolean | isAnonymousLoginAllowed()
Returns if the system is configurated to allow anonymous login. |
| public boolean | isDisposed()
Checks whether the object is disposed. |
| public Intake | parseQuery(String query)
Parses query into intake values. |
| public void | recycle()
Recycles the object by removing its disposed flag. |
| public void | refresh()
|
| public String | reportTimer(String mesg)
Useful when performance tuning. |
| public void | resetAssociatedUsers()
|
| public void | resetSelectedUsers()
|
| public void | setAlert(Object message)
Sets the Alert! message for this request. |
| public void | setAlertMessage(Object v)
Set alert message. |
| public void | setAlertMessage(Localizable localizable)
Set alert message using Localizable localizable. |
| public void | setAttachment(Attachment attachment)
|
| public void | setAttribute(Attribute attribute)
A Attribute object for use within the Scarab API. |
| public void | setAttributeOption(AttributeOption option)
A Attribute object for use within the Scarab API. |
| public void | setAttributeType(int key, String type)
Stores in the request scope a type. |
| public void | setConfirmMessage(Object v)
Set confirmation message. |
| public void | setConfirmMessage(Localizable localizable)
Set confirm message using Localizable localizable. |
| public void | setCurrentIssueType(IssueType type)
|
| public void | setCurrentModule(Module me)
|
| public void | setDepend(Depend depend)
A Depend object for use within the Scarab API. |
| public void | setGlobalUserSearch(List users)
Store the search result of other users for later use. |
| public void | setGlobalUserSearchParam(String name, String value)
Set the parameters used to retrieved the users in the List given
to the setGlobalUserSearch(List) method. |
| public void | setInfoMessage(Object v)
Set informational message. |
| public void | setInfoMessage(Localizable localizable)
Set alert message using Localizable localizable. |
| public void | setIssue(Issue issue)
A Issue object for use within the Scarab API. |
| public void | setIssueTemplateInfo(IssueTemplateInfo templateInfo)
A IssueTemplateInfo object for use within the Scarab API. |
| public void | setIssueType(IssueType issuetype)
A IssueType object for use within the Scarab API. |
| public void | setModule(Module module)
A Module object for use within the Scarab API. |
| public void | setParentChildAttributeOption(ParentChildAttributeOption roo)
|
| public void | setQuery(Query query)
A Query object for use within the Scarab API. |
| public void | setROptionOption(ROptionOption roo)
|
| public void | setReport(ReportBridge report)
|
| public void | setReportingIssue(Issue issue)
|
| public boolean | setSessionAttribute(String key, Object value)
Place an attribute value into the current HttpSession. |
| public void | setUser(ScarabUser user)
A User object for use within the Scarab API,
generally not the user who is logged in. |
| public List | sortAttributes(List attList)
Sort attributes on name or description. |
| public List | sortUsers(List userList)
Sort users on name or email. |
| public void | startTimer()
Should be called near the beginning of a template or wherever timing
should start. |
