org.kuali.kfs.module.bc.document.web.struts
Class DetailSalarySettingForm

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.kfs.module.bc.document.web.struts.BudgetExpansionForm
                  org.kuali.kfs.module.bc.document.web.struts.SalarySettingBaseForm
                      org.kuali.kfs.module.bc.document.web.struts.DetailSalarySettingForm

All Implemented Interfaces:

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

Direct Known Subclasses:

IncumbentSalarySettingForm, PositionSalarySettingForm

public abstract class DetailSalarySettingForm
extends SalarySettingBaseForm

the base struts form for the detail salary setting: by position or by incumbent

See Also:

Serialized Form

Field Summary

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

DetailSalarySettingForm()
Constructs a DetailSalarySettingForm.java.

Method Summary

boolean	acquirePositionAndFundingLocks(org.kuali.rice.kns.util.MessageMap errorMap) acquire position and funding locks for all appointment fundings
boolean	acquirePositionAndFundingLocks(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) acquire position and funding locks for the given appointment funding
boolean	acquireTransactionLocks(org.kuali.rice.kns.util.MessageMap messageMap) acquire transaction locks for the savable appointment fundings
PendingBudgetConstructionAppointmentFunding	createNewAppointmentFundingLine() sets the default fields not setable by the user for added lines and any other required initialization
List<PendingBudgetConstructionAppointmentFunding>	getActiveFundingLines() determine whether there is any active funding line in the given savable appointment funding lines
static List<String>	getComparableFields() get the names of comparable fields that are considered to determine a single account, that is, the fundings are considered being assocated with the given account if they have the same values of the fields as specified.
String	getEmplid() Gets the emplid attribute.
PendingBudgetConstructionAppointmentFunding	getNewBCAFLine() Gets the newBCAFLine attribute.
String	getPositionNumber() Gets the positionNumber attribute.
List<PendingBudgetConstructionAppointmentFunding>	getReleasableAppointmentFundings() get the appointment fundings for which the position or funding locks can be released
List<PendingBudgetConstructionAppointmentFunding>	getSavableAppointmentFundings() get the appointment fundings that can be saved
boolean	isAddLine() Gets the addLine attribute.
String	name() Gets the name attribute.
void	pickAppointmentFundingsForSingleAccount() pick up the appointment fundings belonging to the specified account from a collection of fundings that are associated with a position/incumbent
void	populate(javax.servlet.http.HttpServletRequest request)
void	populateBCAFLines() refresh the the appointment funding lines and make them have connections with associated objects
void	refreshBCAFLine(PendingBudgetConstructionAppointmentFunding appointmentFunding) Populates the dependent fields of objects contained within the BCAF line
void	releasePositionAndFundingLocks() release all position and funding locks acquired in current action by the current user
void	releaseTransactionLocks() release all the transaction locks acquired in current action by the current user
void	setAddLine(boolean addLine) Sets the addLine attribute value.
void	setEmplid(String emplid) Sets the emplid attribute value.
void	setName(String name) Sets the name attribute value.
void	setNewBCAFLine(PendingBudgetConstructionAppointmentFunding newBCAFLine) Sets the newBCAFLine attribute value.
void	setPositionNumber(String positionNumber) Sets the positionNumber attribute value.
boolean	shouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request)
boolean	updateAccessMode(org.kuali.rice.kns.util.MessageMap errorMap) update the access modes of all appointment fundings
boolean	updateAccessMode(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) update the access mode of the given appointment funding

Methods inherited from class org.kuali.kfs.module.bc.document.web.struts.SalarySettingBaseForm

applyDefaultReasonAmountIfEmpty, getAccountNumber, getAdjustmentAmount, getAdjustmentMeasurement, getAppointmentFundings, getAppointmentRequestedAmountTotal, getAppointmentRequestedCsfAmountTotal, getAppointmentRequestedCsfFteQuantityTotal, getAppointmentRequestedCsfStandardHoursTotal, getAppointmentRequestedCsfTimePercentTotal, getAppointmentRequestedFteQuantityTotal, getAppointmentRequestedStandardHoursTotal, getAppointmentRequestedTimePercentTotal, getChartOfAccountsCode, getCsfAmountTotal, getCsfFullTimeEmploymentQuantityTotal, getCsfStandardHoursTotal, getCsfTimePercentTotal, getDocumentNumber, getEffectivePendingBudgetConstructionAppointmentFunding, getFinancialBalanceTypeCode, getFinancialObjectCode, getFinancialObjectTypeCode, getFinancialSubObjectCode, getKeyMapOfSalarySettingItem, getPercentChangeTotal, getPerson, getRefreshCallerName, getSalarySettingFieldsHolder, getSubAccountNumber, isBudgetByAccountMode, isHideAdjustmentMeasurement, isHideDetails, isPayrollIncumbentFeedIndictor, isPayrollPositionFeedIndicator, isSalarySettingClosed, isSingleAccountMode, isViewOnlyEntry, postProcessBCAFLines, setAccountNumber, setAdjustmentAmount, setAdjustmentMeasurement, setBudgetByAccountMode, setChartOfAccountsCode, setDocumentNumber, setFinancialBalanceTypeCode, setFinancialObjectCode, setFinancialObjectTypeCode, setFinancialSubObjectCode, setHideAdjustmentMeasurement, setHideDetails, setSalarySettingClosed, setSingleAccountMode, setSubAccountNumber

Methods inherited from class org.kuali.kfs.module.bc.document.web.struts.BudgetExpansionForm

addMessage, getBackLocation, getCallBackErrors, getCallBackMessages, getDocumentActions, getEditingMode, getMessages, getReturnAnchor, getReturnFormKey, getUniversityFiscalYear, isEditAllowed, isLostSession, isMainWindow, isSystemViewOnly, setBackLocation, setDocumentActions, setEditingMode, setLostSession, setMainWindow, setMessages, setReturnAnchor, setReturnFormKey, setUniversityFiscalYear

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

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

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

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, customInitMaxUploadSizes, 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, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

DetailSalarySettingForm

public DetailSalarySettingForm()

Constructs a DetailSalarySettingForm.java.

Method Detail

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

See Also:

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

populateBCAFLines

public void populateBCAFLines()

Description copied from class: SalarySettingBaseForm

refresh the the appointment funding lines and make them have connections with associated objects

Overrides:

populateBCAFLines in class SalarySettingBaseForm

See Also:

SalarySettingBaseForm.populateBCAFLines()

refreshBCAFLine

public void refreshBCAFLine(PendingBudgetConstructionAppointmentFunding appointmentFunding)

Description copied from class: SalarySettingBaseForm

Populates the dependent fields of objects contained within the BCAF line

Overrides:

refreshBCAFLine in class SalarySettingBaseForm

See Also:

SalarySettingBaseForm.refreshBCAFLine(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding)

acquirePositionAndFundingLocks

public boolean acquirePositionAndFundingLocks(org.kuali.rice.kns.util.MessageMap errorMap)

acquire position and funding locks for all appointment fundings

acquirePositionAndFundingLocks

public boolean acquirePositionAndFundingLocks(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                              org.kuali.rice.kns.util.MessageMap errorMap)

acquire position and funding locks for the given appointment funding

Parameters:

appointmentFunding - the given appointment funding

Returns:

true if the position and funding locks for the given appointment funding are acquired successfully, otherwise, false

updateAccessMode

public boolean updateAccessMode(org.kuali.rice.kns.util.MessageMap errorMap)

update the access modes of all appointment fundings

updateAccessMode

public boolean updateAccessMode(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                org.kuali.rice.kns.util.MessageMap errorMap)

update the access mode of the given appointment funding

Parameters:

appointmentFunding - the given appointment funding

Returns:

true if the access mode of the given appointment funding are updated successfully, otherwise, false

acquireTransactionLocks

public boolean acquireTransactionLocks(org.kuali.rice.kns.util.MessageMap messageMap)

acquire transaction locks for the savable appointment fundings

Returns:

true if the transaction locks for all savable appointment fundings are acquired successfully, otherwise, false

releasePositionAndFundingLocks

public void releasePositionAndFundingLocks()

release all position and funding locks acquired in current action by the current user

releaseTransactionLocks

public void releaseTransactionLocks()

release all the transaction locks acquired in current action by the current user

getSavableAppointmentFundings

public List<PendingBudgetConstructionAppointmentFunding> getSavableAppointmentFundings()

get the appointment fundings that can be saved

getReleasableAppointmentFundings

public List<PendingBudgetConstructionAppointmentFunding> getReleasableAppointmentFundings()

get the appointment fundings for which the position or funding locks can be released

getActiveFundingLines

public List<PendingBudgetConstructionAppointmentFunding> getActiveFundingLines()

determine whether there is any active funding line in the given savable appointment funding lines

createNewAppointmentFundingLine

public PendingBudgetConstructionAppointmentFunding createNewAppointmentFundingLine()

sets the default fields not setable by the user for added lines and any other required initialization

Parameters:

appointmentFunding - the given appointment funding line

pickAppointmentFundingsForSingleAccount

public void pickAppointmentFundingsForSingleAccount()

pick up the appointment fundings belonging to the specified account from a collection of fundings that are associated with a position/incumbent

getComparableFields

public static List<String> getComparableFields()

get the names of comparable fields that are considered to determine a single account, that is, the fundings are considered being assocated with the given account if they have the same values of the fields as specified.

getNewBCAFLine

public PendingBudgetConstructionAppointmentFunding getNewBCAFLine()

Gets the newBCAFLine attribute.

Returns:

Returns the newBCAFLine.

setNewBCAFLine

public void setNewBCAFLine(PendingBudgetConstructionAppointmentFunding newBCAFLine)

Sets the newBCAFLine attribute value.

Parameters:

newBCAFLine - The newBCAFLine to set.

getEmplid

public String getEmplid()

Gets the emplid attribute.

Returns:

Returns the emplid.

setEmplid

public void setEmplid(String emplid)

Sets the emplid attribute value.

Parameters:

emplid - The emplid to set.

isAddLine

public boolean isAddLine()

Gets the addLine attribute.

Returns:

Returns the addLine.

setAddLine

public void setAddLine(boolean addLine)

Sets the addLine attribute value.

Parameters:

addLine - The addLine to set.

getPositionNumber

public String getPositionNumber()

Gets the positionNumber attribute.

Returns:

Returns the positionNumber.

setPositionNumber

public void setPositionNumber(String positionNumber)

Sets the positionNumber attribute value.

Parameters:

positionNumber - The positionNumber to set.

name

public String name()

Gets the name attribute.

Returns:

Returns the name.

setName

public void setName(String name)

Sets the name attribute value.

Parameters:

name - The name to set.

shouldPropertyBePopulatedInForm

public boolean shouldPropertyBePopulatedInForm(String requestParameterName,
                                               javax.servlet.http.HttpServletRequest request)

Specified by:

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

Overrides:

shouldPropertyBePopulatedInForm in class org.kuali.rice.kns.web.struts.form.KualiForm

See Also:

KualiForm.shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)