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

Class KualiInquiryAction

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.KualiInquiryAction

public class KualiInquiryAction
extends KualiAction

This class handles actions for inquiries of business objects.

Field Summary

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
KualiInquiryAction()

Method Summary

Modifier and Type	Method and Description
protected void	checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall) Override this method to provide action-level access controls to the application.
org.apache.struts.action.ActionForward	continueWithInquiry(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	downloadAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Downloads the attachment to the user's browser
org.apache.struts.action.ActionForward	downloadBOAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Downloads the selected attachment to the user's browser
org.apache.struts.action.ActionForward	downloadCustomBOAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Entry point to all actions.
org.apache.struts.action.ActionForward	export(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles exporting the BusinessObject for this Inquiry to XML if it has a custom XML exporter available.
protected String	extractCollectionName(javax.servlet.http.HttpServletRequest request, String methodToCall) Convert a Request into a Map.
protected NoteService	getNoteService()
protected Map<String,String>	getRoleQualification(org.apache.struts.action.ActionForm form, String methodToCall) override this method to add data from the form for role qualification in the authorization check
org.apache.struts.action.ActionForward	hideAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Toggles all tabs to closed
protected void	populateSections(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request, InquiryForm inquiryForm, BusinessObject bo)
protected BusinessObject	retrieveBOFromInquirable(InquiryForm inquiryForm)
org.apache.struts.action.ActionForward	showAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Toggles all tabs to open
org.apache.struts.action.ActionForward	start(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Gets an inquirable impl from the impl service name parameter.
protected void	streamToResponse(byte[] fileContents, String fileName, String fileContentType, javax.servlet.http.HttpServletResponse response) Handy method to stream the byte array to response object
org.apache.struts.action.ActionForward	toggleInactiveRecordDisplay(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Turns on (or off) the inactive record display for a maintenance collection.
org.apache.struts.action.ActionForward	toggleTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Toggles the tab state in the ui

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

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, doProcessingAfterPost, findMethodToCall, getApplicationBaseUrl, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getSelectedLine, getTabToToggle, headerTab, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, refresh, 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

KualiInquiryAction

public KualiInquiryAction()

Method Detail

checkAuthorization

protected void checkAuthorization(org.apache.struts.action.ActionForm form,
                                  String methodToCall)
                           throws AuthorizationException

Description copied from class: KualiAction

Override this method to provide action-level access controls to the application.

Overrides:

checkAuthorization in class KualiAction

Throws:

AuthorizationException

getRoleQualification

protected Map<String,String> getRoleQualification(org.apache.struts.action.ActionForm form,
                                                  String methodToCall)

Description copied from class: KualiAction

override this method to add data from the form for role qualification in the authorization check

Overrides:

getRoleQualification in class KualiAction

execute

public org.apache.struts.action.ActionForward execute(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: KualiAction

Entry point to all actions. NOTE: No need to hook into execute for handling framework setup anymore. Just implement the methodToCall for the framework setup, Constants.METHOD_REQUEST_PARAMETER will contain the full parameter, which can be sub stringed for getting framework parameters.

Overrides:

execute in class KualiAction

Throws:

Exception

See Also:

Action.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

start

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

Gets an inquirable impl from the impl service name parameter. Then calls lookup service to retrieve the record from the key/value parameters. Finally gets a list of Rows from the inquirable

Throws:

Exception

downloadAttachment

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

Downloads the attachment to the user's browser

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

downloadCustomBOAttachment

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

Throws:

Exception

downloadBOAttachment

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

Downloads the selected attachment to the user's browser

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

continueWithInquiry

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

Throws:

Exception

toggleInactiveRecordDisplay

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

Turns on (or off) the inactive record display for a maintenance collection.

Throws:

Exception

toggleTab

public org.apache.struts.action.ActionForward toggleTab(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: KualiAction

Toggles the tab state in the ui

Overrides:

toggleTab in class KualiAction

Returns:

Throws:

Exception

hideAllTabs

public org.apache.struts.action.ActionForward hideAllTabs(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: KualiAction

Toggles all tabs to closed

Overrides:

hideAllTabs in class KualiAction

Returns:

Throws:

Exception

See Also:

org.kuali.rice.krad.web.struts.action.KualiAction#hideAllTabs(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

showAllTabs

public org.apache.struts.action.ActionForward showAllTabs(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: KualiAction

Toggles all tabs to open

Overrides:

showAllTabs in class KualiAction

Returns:

Throws:

Exception

See Also:

org.kuali.rice.krad.web.struts.action.KualiAction#showAllTabs(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

export

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

Handles exporting the BusinessObject for this Inquiry to XML if it has a custom XML exporter available.

Throws:

Exception

extractCollectionName

protected String extractCollectionName(javax.servlet.http.HttpServletRequest request,
                                       String methodToCall)

Convert a Request into a Map. Technically, Request parameters do not neatly translate into a Map of Strings, because a given parameter may legally appear more than once (so a Map of String[] would be more accurate.) This method should be safe for business objects, but may not be reliable for more general uses.

retrieveBOFromInquirable

protected BusinessObject retrieveBOFromInquirable(InquiryForm inquiryForm)

populateSections

protected void populateSections(org.apache.struts.action.ActionMapping mapping,
                                javax.servlet.http.HttpServletRequest request,
                                InquiryForm inquiryForm,
                                BusinessObject bo)

streamToResponse

protected void streamToResponse(byte[] fileContents,
                                String fileName,
                                String fileContentType,
                                javax.servlet.http.HttpServletResponse response)
                         throws Exception

Handy method to stream the byte array to response object

Parameters:

attachmentDataSource -

response -

Throws:

Exception

getNoteService

protected NoteService getNoteService()