| org.kuali.core.web.struts.action.KualiTransactionalDocumentActionBase
 org.kuali.kfs.web.struts.action.KualiAccountingDocumentActionBase
All known Subclasses: org.kuali.module.labor.web.struts.action.ExpenseTransferDocumentActionBase, org.kuali.module.financial.web.struts.action.GeneralErrorCorrectionAction, org.kuali.module.financial.web.struts.action.BudgetAdjustmentAction, org.kuali.module.financial.web.struts.action.AdvanceDepositAction, org.kuali.module.financial.web.struts.action.DisbursementVoucherAction, org.kuali.module.financial.web.struts.action.ProcurementCardAction, org.kuali.module.financial.web.struts.action.TransferOfFundsAction, org.kuali.module.financial.web.struts.action.CreditCardReceiptAction, org.kuali.module.financial.web.struts.action.IndirectCostAdjustmentAction, org.kuali.module.financial.web.struts.action.InternalBillingAction, org.kuali.module.financial.web.struts.action.NonCheckDisbursementAction, org.kuali.module.financial.web.struts.action.CashReceiptAction, org.kuali.module.financial.web.struts.action.DistributionOfIncomeAndExpenseAction, org.kuali.module.financial.web.struts.action.PreEncumbranceAction, org.kuali.module.purap.web.struts.action.PurchasingAccountsPayableActionBase, org.kuali.module.financial.web.struts.action.VoucherAction,
| Method Summary | |
| protected void | clearOverridesThatBecameUnneeded(AccountingLine formLine)
Automatically clears any overrides that have become unneeded. | | public ActionForward | copy(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
| | protected void | createDocument(KualiDocumentFormBase kualiDocumentFormBase)
| | protected void | deleteAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, int deleteIndex)
Deletes the source or target accountingLine with the given index from the given form. | | public ActionForward | deleteSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This method will remove a SourceAccountingLine from a FinancialDocument. | | public ActionForward | deleteTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This method will remove a TargetAccountingLine from a FinancialDocument. | | public ActionForward | execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
| | protected SourceAccountingLine | getSourceAccountingLine(ActionForm form, HttpServletRequest request)
This method is a helper method that will return a source accounting line. | | public ActionForward | hideDetails(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This method is triggered when the user toggles the show/hide button to "hide" thus making the UI render without any of the
accounting line labels/descriptions showing up underneath the values in the UI. | | protected void | insertAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, AccountingLine line)
Adds the given accountingLine to the appropriate form-related datastructures. | | public ActionForward | insertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This action executes an insert of a SourceAccountingLine into a document only after validating the accounting line and
checking any appropriate business rules. | | public ActionForward | insertTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This method will add a TargetAccountingLine to a FinancialDocument. | | protected boolean | isSalesTaxRequired(AccountingDocument financialDocument, AccountingLine accountingLine)
This method checks to see if this doctype needs sales tax If it does then it checks to see if the account and object code
require sales tax If it does then it returns true. | | protected void | loadDocument(KualiDocumentFormBase kualiDocumentFormBase)
| | protected ActionForward | performBalanceInquiryForAccountingLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, AccountingLine line)
This method handles preparing all of the accounting line data so that it can be pushed up to the balance inquiries for
populating the search criteria of each. | | public ActionForward | performBalanceInquiryForSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
Takes care of storing the action form in the User session and forwarding to the balance inquiry report menu action for a
source accounting line. | | public ActionForward | performBalanceInquiryForTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
Takes care of storing the action form in the User session and forwarding to the balance inquiry report menu action for a
target accounting line. | | protected void | processAccountingLineOverrides(KualiAccountingDocumentFormBase transForm)
| | protected void | processAccountingLineOverrides(AccountingLine line)
| | protected void | processAccountingLineOverrides(List accountingLines)
| | public ActionForward | refresh(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
| | protected boolean | revertAccountingLine(KualiAccountingDocumentFormBase transForm, int revertIndex, AccountingLine originalLine, AccountingLine newerLine)
Overwrites field values in the given brokenLine with those in the given originalLine, if the two accountingLines differ. | | public ActionForward | revertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This method will revert a SourceAccountingLine by overwriting its current values with the values in the corresponding
baseline accountingLine. | | public ActionForward | revertTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This method will revert a TargetAccountingLine by overwriting its current values with the values in the corresponding
baseline accountingLine. | | public ActionForward | route(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
| | public ActionForward | save(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
| | public ActionForward | showDetails(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This action changes the value of the hide field in the user interface so that when the page is rendered, the UI knows to show
all of the labels for each of the accounting line values. | | public ActionForward | toggleTab(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
| | protected void | uploadAccountingLines(boolean isSource, ActionForm form)
This method determines whether we are uploading source or target lines, and then calls uploadAccountingLines directly on the
document object. | | public ActionForward | uploadSourceLines(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This action executes a call to upload CSV accounting line values as SourceAccountingLines for a given transactional document. | | public ActionForward | uploadTargetLines(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This action executes a call to upload CSV accounting line values as TargetAccountingLines for a given transactional document. |
| UPDATE_EVENT_ACTIONS | | final protected static Set UPDATE_EVENT_ACTIONS(Code) | | |
| clearOverridesThatBecameUnneeded | | protected void clearOverridesThatBecameUnneeded(AccountingLine formLine)(Code) | | Automatically clears any overrides that have become unneeded. This is for accounting lines that were changed right before
final actions like route. Normally the unneeded overrides are cleared in accountingLineOverrideField.tag instead, but that
requires another form submit. This method shouldn't be called on lines that haven't changed, to avoid automatically changing
read-only lines. This cannot be done in the Rule because Rules cannot change the AccountingLines; they only get a deepCopy.
Parameters:
formLine - |
| copy | | public ActionForward copy(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | Method that will take the current document, copy it, replace all references to doc header id with a new one, clear pending
entries, clear notes, and reset version numbers
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response -
throws:
Exception - |
| deleteAccountingLine | | protected void deleteAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, int deleteIndex)(Code) | | Deletes the source or target accountingLine with the given index from the given form. Assumes that the rule- and form-
validation have already occurred.
Parameters:
isSource -
Parameters:
financialDocumentForm -
Parameters:
deleteIndex - |
| deleteSourceLine | | public ActionForward deleteSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This method will remove a SourceAccountingLine from a FinancialDocument. This assumes that the user presses the delete button
for a specific accounting line on the document and that the document is represented by a FinancialDocumentFormBase.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| deleteTargetLine | | public ActionForward deleteTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This method will remove a TargetAccountingLine from a FinancialDocument. This assumes that the user presses the delete button
for a specific accounting line on the document and that the document is represented by a FinancialDocumentFormBase.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| execute | | public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | Adds check for accountingLine updates, generates and dispatches any events caused by such updates
See Also: org.apache.struts.action.Action.execute(org.apache.struts.action.ActionMappingorg.apache.struts.action.ActionFormjavax.servlet.http.HttpServletRequestjavax.servlet.http.HttpServletResponse) |
| getSourceAccountingLine | | protected SourceAccountingLine getSourceAccountingLine(ActionForm form, HttpServletRequest request)(Code) | | This method is a helper method that will return a source accounting line. The reason we're making it protected in here is so
that we can override this method in some of the modules. PurchasingActionBase is one of the subclasses that will be
overriding this, because in PurchasingActionBase, we'll need to get the source accounting line using both an item index and
an account index.
Parameters:
form -
Parameters:
request -
Parameters:
isSource - |
| hideDetails | | public ActionForward hideDetails(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This method is triggered when the user toggles the show/hide button to "hide" thus making the UI render without any of the
accounting line labels/descriptions showing up underneath the values in the UI.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| insertAccountingLine | | protected void insertAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, AccountingLine line)(Code) | | Adds the given accountingLine to the appropriate form-related datastructures.
Parameters:
isSource -
Parameters:
financialDocumentForm -
Parameters:
line - |
| insertSourceLine | | public ActionForward insertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This action executes an insert of a SourceAccountingLine into a document only after validating the accounting line and
checking any appropriate business rules.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| insertTargetLine | | public ActionForward insertTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This method will add a TargetAccountingLine to a FinancialDocument. This assumes that the user presses the add button for a
specific accounting line on the document and that the document is represented by a FinancialDocumentFormBase. It first
validates the line for data integrity and then checks appropriate business rules.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| isSalesTaxRequired | | protected boolean isSalesTaxRequired(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | This method checks to see if this doctype needs sales tax If it does then it checks to see if the account and object code
require sales tax If it does then it returns true. Note - this is hackish as we shouldn't have to call rules directly from
the action class But we need to in this instance because we are copying the lines before calling rules and need a way to
modify them before they go on
Parameters:
accountingLine - true if sales tax check is needed, false otherwise |
| performBalanceInquiryForAccountingLine | | protected ActionForward performBalanceInquiryForAccountingLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, AccountingLine line)(Code) | | This method handles preparing all of the accounting line data so that it can be pushed up to the balance inquiries for
populating the search criteria of each.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
line - ActionForward |
| performBalanceInquiryForSourceLine | | public ActionForward performBalanceInquiryForSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | Takes care of storing the action form in the User session and forwarding to the balance inquiry report menu action for a
source accounting line.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| performBalanceInquiryForTargetLine | | public ActionForward performBalanceInquiryForTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | Takes care of storing the action form in the User session and forwarding to the balance inquiry report menu action for a
target accounting line.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| processAccountingLineOverrides | | protected void processAccountingLineOverrides(AccountingLine line)(Code) | |
Parameters:
line - |
| processAccountingLineOverrides | | protected void processAccountingLineOverrides(List accountingLines)(Code) | |
Parameters:
accountingLines - |
| revertAccountingLine | | protected boolean revertAccountingLine(KualiAccountingDocumentFormBase transForm, int revertIndex, AccountingLine originalLine, AccountingLine newerLine)(Code) | | Overwrites field values in the given brokenLine with those in the given originalLine, if the two accountingLines differ.
Parameters:
transForm -
Parameters:
revertIndex -
Parameters:
originalLine -
Parameters:
newerLine - true if and only if the brokenLine was actually changed |
| revertSourceLine | | public ActionForward revertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This method will revert a SourceAccountingLine by overwriting its current values with the values in the corresponding
baseline accountingLine. This assumes that the user presses the revert button for a specific accounting line on the document
and that the document is represented by a FinancialDocumentFormBase.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| revertTargetLine | | public ActionForward revertTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This method will revert a TargetAccountingLine by overwriting its current values with the values in the corresponding
baseline accountingLine. This assumes that the user presses the revert button for a specific accounting line on the document
and that the document is represented by a FinancialDocumentFormBase.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| showDetails | | public ActionForward showDetails(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This action changes the value of the hide field in the user interface so that when the page is rendered, the UI knows to show
all of the labels for each of the accounting line values.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
| uploadAccountingLines | | protected void uploadAccountingLines(boolean isSource, ActionForm form) throws FileNotFoundException, IOException(Code) | | This method determines whether we are uploading source or target lines, and then calls uploadAccountingLines directly on the
document object. This method handles retrieving the actual upload file as an input stream into the document.
Parameters:
isSource -
Parameters:
form -
throws:
FileNotFoundException -
throws:
IOException - |
| uploadSourceLines | | public ActionForward uploadSourceLines(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws FileNotFoundException, IOException(Code) | | This action executes a call to upload CSV accounting line values as SourceAccountingLines for a given transactional document.
The "uploadAccountingLines()" method handles the multi-part request.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
FileNotFoundException -
throws:
IOException - |
| uploadTargetLines | | public ActionForward uploadTargetLines(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This action executes a call to upload CSV accounting line values as TargetAccountingLines for a given transactional document.
The "uploadAccountingLines()" method handles the multi-part request.
Parameters:
mapping -
Parameters:
form -
Parameters:
request -
Parameters:
response - ActionForward
throws:
Exception - |
|
|