org.kuali.kra.proposaldevelopment.web.struts.action

Class ProposalDevelopmentPermissionsAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.kuali.rice.kns.web.struts.action.KualiAction

org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase

org.kuali.kra.budget.web.struts.action.BudgetParentActionBase

org.kuali.kra.proposaldevelopment.web.struts.action.ProposalDevelopmentAction

org.kuali.kra.proposaldevelopment.web.struts.action.ProposalDevelopmentPermissionsAction

public class ProposalDevelopmentPermissionsAction
extends ProposalDevelopmentAction

The ProposalDevelopmentPermissionsAction responds to user events from the Permissions web page.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.kra.proposaldevelopment.web.struts.action.ProposalDevelopmentAction

ProposalDevelopmentAction.LabelComparator

Field Summary

Fields inherited from class org.kuali.kra.budget.web.struts.action.BudgetParentActionBase

COPY_BUDGET_PERIOD_QUESTION, QUESTION_TEXT, QUESTION_TYPE

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

DOCUMENT_LOAD_COMMANDS

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

FORM_ACTION, FORWARD_NEXT, FORWARD_TEXT_AREA_UPDATE, METHOD_TO_CALL, POST_TEXT_AREA_TO_PARENT, TEXT_AREA_FIELD_ANCHOR, TEXT_AREA_FIELD_LABEL, TEXT_AREA_FIELD_NAME, TEXT_AREA_MAX_LENGTH, TEXT_AREA_READ_ONLY

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, methods, types

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
ProposalDevelopmentPermissionsAction()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addProposalUser(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Add a new Proposal User to the list of users who can access a proposal.
org.apache.struts.action.ActionForward	close(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Close the document and take the user back to the index; only after asking the user if they want to save the document first.
org.apache.struts.action.ActionForward	confirmDeleteProposalUser(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) If the the user confirms that a user must be deleted from the list of proposal users, then do so.
org.apache.struts.action.ActionForward	deleteProposalUser(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete a Proposal User from the list of users who can access a proposal.
org.apache.struts.action.ActionForward	editRoles(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Display the Edit Roles HTML web page.
protected org.kuali.rice.krad.service.KualiRuleService	getKualiRuleService() Get the Kuali Rule Service.
org.apache.struts.action.ActionForward	getPermissionsRoleRights(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get the HTML Page for viewing the Rights (Permissions) for all of the Proposal Roles (Aggregator, Budget Creator, Narrative Writer, and Viewer).
org.apache.struts.action.ActionForward	processAuthorizationViolation(String taskName, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) ProcessDefinitionDefinitionDefinition an Authorization Violation.
org.apache.struts.action.ActionForward	save(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Provide hooks for subclasses to perform additional tasks related to saving the document.
org.apache.struts.action.ActionForward	saveViewers(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Saves new viewers to the list of users who can access a proposal.
org.apache.struts.action.ActionForward	setEditRoles(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Set the roles for a user for a given proposal.

Methods inherited from class org.kuali.kra.proposaldevelopment.web.struts.action.ProposalDevelopmentAction

abstractsAttachments, actions, applyRules, approverView, auditMode, budgetVersions, constructColumnsToAlterLookupMTCs, customData, docHandler, execute, getActionName, getFormProperty, getHierarchyHelper, getKeyPersonnelService, getNotificationService, getPersonEditableService, getProposalComment, getProposalDoc, getProposalPersonCertification, getS2SBudgetCalculatorService, getSponsorService, getUnitRulesMessages, grantsGov, headerTab, hierarchy, initialDocumentSave, initializeProposalUsers, keyPersonnel, loadDocument, loadDocument, loadDocumentInForm, medusa, nullOp, permissions, preSave, printForms, proposal, questions, recall, saveOnClose, setNotificationService, setS2SBudgetCalculatorService, specialReview, streamToResponse, updateNIHDescriptions, updateProposalDocument

Methods inherited from class org.kuali.kra.budget.web.struts.action.BudgetParentActionBase

copyBudget, getFinalBudgetVersion, populateTabState, setBudgetParentStatus, setBudgetStatuses, setFinalBudgetVersion

Methods inherited from class org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase

buildActionUrl, buildForwardUrl, buildParameterizedConfirmationQuestion, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, getValidHeaderString, isAuthorized, performQuestionWithoutInput, populateAuthorizationFields, postDocumentSave, preDocumentSave, releaseLocks, reload, reloadWithoutWarning, returnToSender, route, routeToHoldingPage, routeToHoldingPage, sendAdHocRequests, setupPessimisticLockMessages

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

copy

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

acknowledge, approve, attemptLockRelease, blanketApprove, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, combineAdHocRecipients, complete, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refresh, refreshAdHocRoutingWorkgroupLookups, selectedAttachmentIndex, sendNoteWorkflowNotification, setupDocumentExit, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions, toggleTab

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

addMethodToCallToUncheckedList, defaultDispatch, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProposalDevelopmentPermissionsAction

public ProposalDevelopmentPermissionsAction()

Method Detail

save

public org.apache.struts.action.ActionForward save(org.apache.struts.action.ActionMapping mapping,
                                          org.apache.struts.action.ActionForm form,
                                          javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)
                                            throws Exception

Description copied from class: KraTransactionalDocumentActionBase

Provide hooks for subclasses to perform additional tasks related to saving the document. The optional tasks are: 1. Doing something right before the document is saved. 2. Doing something after the document has been saved for the first time only.

Overrides:

save in class ProposalDevelopmentAction

Throws:

Exception

See Also:

org.kuali.core.web.struts.action.KualiDocumentActionBase#save(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

close

public org.apache.struts.action.ActionForward close(org.apache.struts.action.ActionMapping mapping,
                                           org.apache.struts.action.ActionForm form,
                                           javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
                                             throws Exception

Close the document and take the user back to the index; only after asking the user if they want to save the document first. Only users who have the "canSave()" permission are given this option.

Overrides:

close in class ProposalDevelopmentAction

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

getPermissionsRoleRights

public org.apache.struts.action.ActionForward getPermissionsRoleRights(org.apache.struts.action.ActionMapping mapping,
                                                              org.apache.struts.action.ActionForm form,
                                                              javax.servlet.http.HttpServletRequest request,
                                                              javax.servlet.http.HttpServletResponse response)
                                                                throws Exception

Get the HTML Page for viewing the Rights (Permissions) for all of the Proposal Roles (Aggregator, Budget Creator, Narrative Writer, and Viewer).

Parameters:

mapping - the mapping associated with this action.

form - the Proposal Development form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the THTML page to display

Throws:

Exception

addProposalUser

public org.apache.struts.action.ActionForward addProposalUser(org.apache.struts.action.ActionMapping mapping,
                                                     org.apache.struts.action.ActionForm form,
                                                     javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)
                                                       throws Exception

Add a new Proposal User to the list of users who can access a proposal. The user may be assigned any of the roles or the special unassigned role.

Parameters:

mapping - the mapping associated with this action.

form - the Proposal Development form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception

deleteProposalUser

public org.apache.struts.action.ActionForward deleteProposalUser(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

Delete a Proposal User from the list of users who can access a proposal.

Parameters:

mapping - the mapping associated with this action.

form - the Proposal Development form.

request - the HTTP request

response - the HTTP response

Returns:

the next HTML page to display

Throws:

Exception

confirmDeleteProposalUser

public org.apache.struts.action.ActionForward confirmDeleteProposalUser(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

If the the user confirms that a user must be deleted from the list of proposal users, then do so.

Parameters:

mapping - the mapping associated with this action.

form - the Proposal Development form.

request - the HTTP request

response - the HTTP response

Returns:

the Permissions web page

Throws:

Exception

editRoles

public org.apache.struts.action.ActionForward editRoles(org.apache.struts.action.ActionMapping mapping,
                                               org.apache.struts.action.ActionForm form,
                                               javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
                                                 throws Exception

Display the Edit Roles HTML web page. When the "edit role" button is pressed, the Edit Roles web page is displayed. The roles that the user is assigned to can then be modified.

Parameters:

mapping - the mapping associated with this action.

form - the Proposal Development form.

request - the HTTP request

response - the HTTP response

Returns:

the EDIT ROLES HTML page

Throws:

Exception

setEditRoles

public org.apache.struts.action.ActionForward setEditRoles(org.apache.struts.action.ActionMapping mapping,
                                                  org.apache.struts.action.ActionForm form,
                                                  javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response)
                                                    throws Exception

Set the roles for a user for a given proposal. The setEditRoles() method works in conjunction with the above editRoles() method. The editRoles() method causes the Edit Roles web page to be displayed. The setEditRoles() is invoked when the user clicks on the save button. Note that the Edit Roles BO created in editRoles() is retrieved in setEditRoles() to determine the user and what the new roles should be.

Parameters:

mapping - the mapping associated with this action.

form - the Proposal Development form.

request - the HTTP request

response - the HTTP response

Returns:

the next web page to display

Throws:

Exception

processAuthorizationViolation

public org.apache.struts.action.ActionForward processAuthorizationViolation(String taskName,
                                                                   org.apache.struts.action.ActionMapping mapping,
                                                                   org.apache.struts.action.ActionForm form,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response)
                                                                     throws Exception

Description copied from class: KraTransactionalDocumentActionBase

ProcessDefinitionDefinitionDefinition an Authorization Violation.

Overrides:

processAuthorizationViolation in class KraTransactionalDocumentActionBase

mapping - the Action Mapping

form - the form

request - the HTTP request

response - the HTTP response

Returns:

the next action to go to

Throws:

Exception

See Also:

KraTransactionalDocumentActionBase.processAuthorizationViolation(java.lang.String, org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getKualiRuleService

protected org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()

Get the Kuali Rule Service.

Overrides:

getKualiRuleService in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Returns:

the Kuali Rule Service

saveViewers

public org.apache.struts.action.ActionForward saveViewers(org.apache.struts.action.ActionMapping mapping,
                                                 org.apache.struts.action.ActionForm form,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response)
                                                   throws Exception

Saves new viewers to the list of users who can access a proposal.

Parameters:

mapping - the mapping associated with this action.

form - the Proposal Development form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception