org.kuali.kfs.module.ec.document.web.struts
Class EffortCertificationForm

java.lang.Object
  org.apache.struts.action.ActionForm
      org.kuali.rice.kns.web.struts.pojo.PojoFormBase
          org.kuali.rice.kns.web.struts.form.KualiForm
              org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase
                  org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase
                      org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase
                          org.kuali.kfs.module.ec.document.web.struts.EffortCertificationForm

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.web.struts.pojo.PojoForm

Direct Known Subclasses:

CertificationRecreateForm, CertificationReportForm

public class EffortCertificationForm
extends FinancialSystemTransactionalDocumentFormBase

Action form for Effort Certification Document.

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger	LOG
protected EffortCertificationDetail	newDetailLine

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

forcedReadOnlyFields

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.pojo.PojoFormBase

requiredNonEditableProperties

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

multipartRequestHandler, servlet

Constructor Summary

EffortCertificationForm()
Constructs a EffortCertificationForm.java.

Method Summary

static String	buildAccountInfo(Account account) build the descriptive information of the given account.
EffortCertificationDetail	createNewDetailLine() initialize a new detail line
protected String	getCompleteURL(String baseURL) append the extract query string into the given base URL
List<String>	getCustomizedInquirableFieldNames() get the inquirable field names that need to be handled specially
protected org.kuali.rice.kns.lookup.HtmlData	getCustomizedInquiryUrl(EffortCertificationDetail detailLine, String attributeName) get the inquiry URL for the specified attribute
protected String	getDefaultDocumentTypeName()
List<Map<String,org.kuali.rice.kns.lookup.HtmlData>>	getDetailLineFieldInquiryUrl() Gets the inquiryUrl attribute.
protected List<Map<String,org.kuali.rice.kns.lookup.HtmlData>>	getDetailLineFieldInquiryUrl(List<EffortCertificationDetail> detailLines) Gets the inquiryUrl attribute.
List<EffortCertificationDetail>	getDetailLines() Gets the detailLines attribute.
EffortCertificationDocument	getEffortCertificationDocument() Gets the effortCertificationDocument attribute.
protected EffortPositionDataDetailsInquirableImpl	getEffortPositionDataDetailsInquirableImpl() get the EffortPositionDataDetailsInquirableImpl implmentation
List<Map<String,String>>	getFieldInfo() Gets the fieldInfo attribute.
protected List<Map<String,String>>	getFieldInfo(List<EffortCertificationDetail> detailLines) Gets the fieldInfo attribute.
protected org.kuali.rice.kns.inquiry.Inquirable	getInquirable() get the inquirable implmentation
List<String>	getInquirableFieldNames() Gets the inquirableFieldNames attribute.
EffortCertificationDetail	getNewDetailLine()
Map<String,String>	getNoninquirableFieldValues() Gets the inquirableFieldNames attribute.
protected org.kuali.rice.kns.bo.BusinessObjectRelationship	getPrimitiveBusinessObjectRelationship(Map<String,org.kuali.rice.kns.bo.BusinessObjectRelationship> relationshipMetadata) pick up the primitive relationship for an attribute from a set of relationships.
Map<String,org.kuali.rice.kns.bo.BusinessObjectRelationship>	getRelationshipMetadata() get the relationship metadata for the detail line fields
static String	loadAccountInfo(String chartOfAccountsCode, String accountNumber) load the descriptive information of the given account.
void	populate(javax.servlet.http.HttpServletRequest request)
void	setNewDetailLine(EffortCertificationDetail newDetailLine) Sets the new detail line

Methods inherited from class org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

extendDocInfoToThreeColumns, generateErrorCorrectionButton, getExtraButtons, populateHeaderFields

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populateEmptyMultiSelect, populateFalseCheckboxes, populationSpecialEmptyFields, setForcedReadOnlyFields, shouldMethodToCallParameterBeUsed

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getErrorMapFromPreviousRequest, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getStandardHeaderFields, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isSuppressAllButtons, isUserDocumentInitiator, reset, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setErrorMapFromPreviousRequest, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates

Methods inherited from class org.kuali.rice.kns.web.struts.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

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

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

newDetailLine

protected EffortCertificationDetail newDetailLine

Constructor Detail

EffortCertificationForm

public EffortCertificationForm()

Constructs a EffortCertificationForm.java.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

createNewDetailLine

public EffortCertificationDetail createNewDetailLine()

initialize a new detail line

Returns:

the initialized detail line

getNewDetailLine

public EffortCertificationDetail getNewDetailLine()

Returns:

new detail line

setNewDetailLine

public void setNewDetailLine(EffortCertificationDetail newDetailLine)

Sets the new detail line

Parameters:

newDetailLine -

getEffortCertificationDocument

public EffortCertificationDocument getEffortCertificationDocument()

Gets the effortCertificationDocument attribute.

Returns:

Returns the effortCertificationDocument.

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Specified by:

populate in interface org.kuali.rice.kns.web.struts.pojo.PojoForm

Overrides:

populate in class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

See Also:

KualiDocumentFormBase.populate(javax.servlet.http.HttpServletRequest)

getDetailLines

public List<EffortCertificationDetail> getDetailLines()

Gets the detailLines attribute.

Returns:

Returns the detailLines.

getRelationshipMetadata

public Map<String,org.kuali.rice.kns.bo.BusinessObjectRelationship> getRelationshipMetadata()

get the relationship metadata for the detail line fields

Returns:

the relationship metadata for the detail line fields

getDetailLineFieldInquiryUrl

public List<Map<String,org.kuali.rice.kns.lookup.HtmlData>> getDetailLineFieldInquiryUrl()

Gets the inquiryUrl attribute.

Returns:

Returns the inquiryUrl for the detail lines in the document.

getFieldInfo

public List<Map<String,String>> getFieldInfo()

Gets the fieldInfo attribute.

Returns:

Returns the fieldInfo.

getPrimitiveBusinessObjectRelationship

protected org.kuali.rice.kns.bo.BusinessObjectRelationship getPrimitiveBusinessObjectRelationship(Map<String,org.kuali.rice.kns.bo.BusinessObjectRelationship> relationshipMetadata)

pick up the primitive relationship for an attribute from a set of relationships. Generally, the primitive relationship is that has the minimum number of primary keys.

Parameters:

relationshipMetadata - the relationship metadata that contains the primitive relationship

Returns:

the primitive relationship for an attribute from a set of relationships.

getDetailLineFieldInquiryUrl

protected List<Map<String,org.kuali.rice.kns.lookup.HtmlData>> getDetailLineFieldInquiryUrl(List<EffortCertificationDetail> detailLines)

Gets the inquiryUrl attribute.

Returns:

Returns the inquiryUrl for the detail lines in the document.

getCustomizedInquiryUrl

protected org.kuali.rice.kns.lookup.HtmlData getCustomizedInquiryUrl(EffortCertificationDetail detailLine,
                                                                     String attributeName)

get the inquiry URL for the specified attribute

Parameters:

detailLine - the detail line containing the given attribute

attributeName - the specified attribute name

Returns:

the inquiry URL for the specified attribute

getNoninquirableFieldValues

public Map<String,String> getNoninquirableFieldValues()

Gets the inquirableFieldNames attribute.

Returns:

Returns the inquirableFieldNames.

getInquirableFieldNames

public List<String> getInquirableFieldNames()

Gets the inquirableFieldNames attribute.

Returns:

Returns the inquirableFieldNames.

getCustomizedInquirableFieldNames

public List<String> getCustomizedInquirableFieldNames()

get the inquirable field names that need to be handled specially

Returns:

the inquirable field names that need to be handled specially

getCompleteURL

protected String getCompleteURL(String baseURL)

append the extract query string into the given base URL

Parameters:

baseURL - the given base URL. If the parameter is blank, the base URL won't be changed

Returns:

the complete URL built from the given base URL and extra query strings

getFieldInfo

protected List<Map<String,String>> getFieldInfo(List<EffortCertificationDetail> detailLines)

Gets the fieldInfo attribute.

Returns:

Returns the fieldInfo.

getInquirable

protected org.kuali.rice.kns.inquiry.Inquirable getInquirable()

get the inquirable implmentation

Returns:

the inquirable implmentation

getEffortPositionDataDetailsInquirableImpl

protected EffortPositionDataDetailsInquirableImpl getEffortPositionDataDetailsInquirableImpl()

get the EffortPositionDataDetailsInquirableImpl implmentation

Returns:

the EffortPositionDataDetailsInquirableImpl implmentation

buildAccountInfo

public static String buildAccountInfo(Account account)

build the descriptive information of the given account. The information includes account name and project director's name if any

Parameters:

chartOfAccountsCode - the given chart of accounts code

accountNumber - the given account number

Returns:

the descriptive information of the given account

loadAccountInfo

public static String loadAccountInfo(String chartOfAccountsCode,
                                     String accountNumber)

load the descriptive information of the given account. This method is used by DWR.

Parameters:

chartOfAccountsCode - the given chart of accounts code

accountNumber - the given account number

Returns:

the descriptive information of the given account