| org.kuali.kfs.web.struts.action.KualiAccountingDocumentActionBase
 org.kuali.module.financial.web.struts.action.VoucherAction
All known Subclasses: org.kuali.module.financial.web.struts.action.JournalVoucherAction, org.kuali.module.financial.web.struts.action.AuxiliaryVoucherAction,
| VoucherAction | | public class VoucherAction extends KualiAccountingDocumentActionBase (Code) | | This class piggy backs on all of the functionality in the KualiTransactionalDocumentActionBase but is necessary for this document
type. Vouchers are unique in that they define several fields that aren't typically used by the other financial transaction
processing eDocs (i.e. external system fields, object type override, credit and debit amounts).
|
| Method Summary | |
| public ActionForward | correct(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
Overrides to call super, and then to repopulate the credit/debit amounts b/c the credit/debit code might change during a
voucher error correction. | | public ActionForward | deleteSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
Overrides parent to remove the associated helper line also, and then it call the parent's implementation. | | public ActionForward | insertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
Overrides parent to first populate the new source line with the correct debit or credit value, then it calls the parent's
implementation. | | protected void | loadDocument(KualiDocumentFormBase kualiDocumentFormBase)
Overrides the parent to make sure that the AV specific accounting line helper forms are properly populated when the document
is first loaded. | | protected void | populateAllVoucherAccountingLineHelpers(VoucherForm voucherForm)
This method builds the corresponding list of voucher acounting line helper objects so that a user can differentiate between
credit and debit fields. | | protected VoucherAccountingLineHelper | populateNewVoucherAccountingLineHelper(VoucherForm voucherForm)
This populates a new helperLine instance with the one that was just added so that the new instance can be added to the
helperLines list. | | protected void | populateSelectedAccountingPeriod(VoucherDocument voucherDocument, VoucherForm voucherForm)
This method parses the accounting period value from the bo and builds the right string to pass to the form object as the
selected value. | | protected VoucherAccountingLineHelper | populateVoucherAccountingLineHelper(VoucherForm voucherForm)
This populates a new helperLine instance with the one that was just added so that the new instance can be added to the
helperLines list. | | protected ActionForward | processRouteOutOfBalanceDocumentConfirmationQuestion(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
This helper method determines from the request object instance whether or not the user has been prompted about the journal
being out of balance. | | protected boolean | revertAccountingLine(KualiAccountingDocumentFormBase transForm, int revertIndex, AccountingLine originalLine, AccountingLine brokenLine)
We want to keep the bad data for the voucher. | | 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. |
| deleteSourceLine | | public ActionForward deleteSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | Overrides parent to remove the associated helper line also, and then it call the parent's implementation.
See Also: org.kuali.module.financial.web.struts.action.KualiFinancialDocumentActionBase.deleteSourceLine(org.apache.struts.action.ActionMappingorg.apache.struts.action.ActionFormjavax.servlet.http.HttpServletRequestjavax.servlet.http.HttpServletResponse) |
| insertSourceLine | | public ActionForward insertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | Overrides parent to first populate the new source line with the correct debit or credit value, then it calls the parent's
implementation.
See Also: org.kuali.module.financial.web.struts.action.KualiFinancialDocumentActionBase.insertSourceLine(org.apache.struts.action.ActionMappingorg.apache.struts.action.ActionFormjavax.servlet.http.HttpServletRequestjavax.servlet.http.HttpServletResponse) |
| populateAllVoucherAccountingLineHelpers | | protected void populateAllVoucherAccountingLineHelpers(VoucherForm voucherForm)(Code) | | This method builds the corresponding list of voucher acounting line helper objects so that a user can differentiate between
credit and debit fields. It does this by iterating over each source accounting line (what the voucher uses) looking at the
debit/credit code and then populateingLineHelpers a corresponding helper form instance with the amount in the appropriate
amount field - credit or debit.
Parameters:
voucherForm - |
| populateNewVoucherAccountingLineHelper | | protected VoucherAccountingLineHelper populateNewVoucherAccountingLineHelper(VoucherForm voucherForm)(Code) | | This populates a new helperLine instance with the one that was just added so that the new instance can be added to the
helperLines list.
Parameters:
voucherForm - voucherAccountingLineHelper |
| populateSelectedAccountingPeriod | | protected void populateSelectedAccountingPeriod(VoucherDocument voucherDocument, VoucherForm voucherForm)(Code) | | This method parses the accounting period value from the bo and builds the right string to pass to the form object as the
selected value.
Parameters:
voucherDocument -
Parameters:
voucherForm - |
| populateVoucherAccountingLineHelper | | protected VoucherAccountingLineHelper populateVoucherAccountingLineHelper(VoucherForm voucherForm)(Code) | | This populates a new helperLine instance with the one that was just added so that the new instance can be added to the
helperLines list.
Parameters:
voucherForm - VoucherAccountingLineHelper |
| processRouteOutOfBalanceDocumentConfirmationQuestion | | protected ActionForward processRouteOutOfBalanceDocumentConfirmationQuestion(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | This helper method determines from the request object instance whether or not the user has been prompted about the journal
being out of balance. If they haven't, then the method will build the appropriate message given the state of the document and
return control to the question component so that the user receives the "yes"/"no" prompt. If the question has been asked, the
we evaluate the user's answer and direct the flow appropriately. If they answer with a "No", then we build out a message
stating that they chose that value and return an ActionForward of a MAPPING_BASIC which keeps them at the same page that they
were on. If they choose "Yes", then we return a null ActionForward, which the calling action method recognizes as a "Yes" and
continues on processing the "Route."
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 - |
| Fields inherited from org.kuali.kfs.web.struts.action.KualiAccountingDocumentActionBase | final protected static Set UPDATE_EVENT_ACTIONS(Code)(Java Doc)
|
| Methods inherited from org.kuali.kfs.web.struts.action.KualiAccountingDocumentActionBase | protected void clearOverridesThatBecameUnneeded(AccountingLine formLine)(Code)(Java Doc)
public ActionForward copy(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected void createDocument(KualiDocumentFormBase kualiDocumentFormBase) throws WorkflowException(Code)(Java Doc)
protected void deleteAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, int deleteIndex)(Code)(Java Doc)
public ActionForward deleteSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward deleteTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected SourceAccountingLine getSourceAccountingLine(ActionForm form, HttpServletRequest request)(Code)(Java Doc)
public ActionForward hideDetails(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected void insertAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, AccountingLine line)(Code)(Java Doc)
public ActionForward insertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward insertTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected boolean isSalesTaxRequired(AccountingDocument financialDocument, AccountingLine accountingLine)(Code)(Java Doc)
protected void loadDocument(KualiDocumentFormBase kualiDocumentFormBase) throws WorkflowException(Code)(Java Doc)
protected ActionForward performBalanceInquiryForAccountingLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, AccountingLine line)(Code)(Java Doc)
public ActionForward performBalanceInquiryForSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward performBalanceInquiryForTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected void processAccountingLineOverrides(KualiAccountingDocumentFormBase transForm)(Code)(Java Doc)
protected void processAccountingLineOverrides(AccountingLine line)(Code)(Java Doc)
protected void processAccountingLineOverrides(List accountingLines)(Code)(Java Doc)
public ActionForward refresh(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected boolean revertAccountingLine(KualiAccountingDocumentFormBase transForm, int revertIndex, AccountingLine originalLine, AccountingLine newerLine)(Code)(Java Doc)
public ActionForward revertSourceLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward revertTargetLine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward route(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward save(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward showDetails(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public ActionForward toggleTab(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected void uploadAccountingLines(boolean isSource, ActionForm form) throws FileNotFoundException, IOException(Code)(Java Doc)
public ActionForward uploadSourceLines(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws FileNotFoundException, IOException(Code)(Java Doc)
public ActionForward uploadTargetLines(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
|
|
|