org.kuali.kfs.module.bc.report
Class ReportControlListBuildHelper

java.lang.Object
  org.kuali.kfs.module.bc.report.ReportControlListBuildHelper

All Implemented Interfaces:

Serializable

public class ReportControlListBuildHelper
extends Object
implements Serializable

Holds information on the current build configuration of the report control list table, and a requested configuration.

See Also:

Serialized Form

Nested Class Summary

class

ReportControlListBuildHelper.BuildState Represents a build configuration for the control list.

Constructor Summary

ReportControlListBuildHelper()
Constructs a ReportControlListBuildHelper.java.

Method Summary

void	addBuildRequest(String pointOfView, Collection<BudgetConstructionPullup> selectedOrganizations, BCConstants.Report.BuildMode buildMode) Helper method to add a requestState
ReportControlListBuildHelper.BuildState	getCurrentState() Gets the currentState attribute.
ReportControlListBuildHelper.BuildState	getRequestedState() Gets the requestedState attribute.
boolean	isBuildNeeded() Determines whether a build is needed based on the current and requested states
boolean	isForceRebuild() Gets the forceRebuild attribute.
void	requestBuildComplete() Called when the control list has been built that satisfies the requested state.
void	setCurrentState(ReportControlListBuildHelper.BuildState currentState) Sets the currentState attribute value.
void	setForceRebuild(boolean forceRebuild) Sets the forceRebuild attribute value.
void	setRequestedState(ReportControlListBuildHelper.BuildState requestedState) Sets the requestedState attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportControlListBuildHelper

public ReportControlListBuildHelper()

Constructs a ReportControlListBuildHelper.java.

Method Detail

isBuildNeeded

public boolean isBuildNeeded()

Determines whether a build is needed based on the current and requested states

Returns:

true if build is needed, false otherwise

addBuildRequest

public void addBuildRequest(String pointOfView,
                            Collection<BudgetConstructionPullup> selectedOrganizations,
                            BCConstants.Report.BuildMode buildMode)

Helper method to add a requestState

Parameters:

pointOfView - - request point of view

selectedOrganizations - - organizations selected for the report

buildMode - - mode in which the control list should be build

See Also:

BCConstants.Report.BuildMode

requestBuildComplete

public void requestBuildComplete()

Called when the control list has been built that satisfies the requested state. Will set current state to the requested state then empty the requested state.

getCurrentState

public ReportControlListBuildHelper.BuildState getCurrentState()

Gets the currentState attribute.

Returns:

Returns the currentState.

setCurrentState

public void setCurrentState(ReportControlListBuildHelper.BuildState currentState)

Sets the currentState attribute value.

Parameters:

currentState - The currentState to set.

getRequestedState

public ReportControlListBuildHelper.BuildState getRequestedState()

Gets the requestedState attribute.

Returns:

Returns the requestedState.

setRequestedState

public void setRequestedState(ReportControlListBuildHelper.BuildState requestedState)

Sets the requestedState attribute value.

Parameters:

requestedState - The requestedState to set.

isForceRebuild

public boolean isForceRebuild()

Gets the forceRebuild attribute.

Returns:

Returns the forceRebuild.

setForceRebuild

public void setForceRebuild(boolean forceRebuild)

Sets the forceRebuild attribute value.

Parameters:

forceRebuild - The forceRebuild to set.