Class ProcessSummaryLine
java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLine
- All Implemented Interfaces:
ProcessSummaryLineInterface
,Serializable
For processes that may show a review invalid input: '&' result screen, this class provides a
standard way to summarize information about the records in the process.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionProcessSummaryLine
(Status status) ProcessSummaryLine
(Status status, Integer count, String message) ProcessSummaryLine
(Status status, Integer count, String message, ArrayList<Serializable> primaryKeys) ProcessSummaryLine
(Status status, String message) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Getter for bulletsOfTextgetCount()
Getter for countGetter for messageGetter for messageSuffixGetter for pluralFutureMessageGetter for pluralPastMessageGetter for primaryKeysGetter for singularFutureMessageGetter for singularPastMessageGetter for statusvoid
void
incrementCount
(int amount) void
incrementCountAndAddPrimaryKey
(Serializable primaryKey) void
pickMessage
(boolean isPast) void
prepareForFrontend
(boolean isForResultScreen) meant to be called by framework, after process is complete, give the summary object a chance to finalize itself before it's sent to a frontend.void
setBulletsOfText
(ArrayList<String> bulletsOfText) Setter for bulletsOfTextvoid
Setter for countvoid
setMessage
(String message) Setter for messagevoid
setMessageSuffix
(String messageSuffix) Setter for messageSuffixvoid
setPluralFutureMessage
(String pluralFutureMessage) Setter for pluralFutureMessagevoid
setPluralPastMessage
(String pluralPastMessage) Setter for pluralPastMessagevoid
setPrimaryKeys
(ArrayList<Serializable> primaryKeys) Setter for primaryKeysvoid
setSingularFutureMessage
(String singularFutureMessage) Setter for singularFutureMessagevoid
setSingularPastMessage
(String singularPastMessage) Setter for singularPastMessagevoid
Setter for statustoString()
withBulletsOfText
(ArrayList<String> bulletsOfText) Fluent setter for bulletsOfTextwithMessageSuffix
(String messageSuffix) Fluent setter for messageSuffixwithPluralFutureMessage
(String pluralFutureMessage) Fluent setter for pluralFutureMessagewithPluralMessage
(String pluralMessage) withPluralPastMessage
(String pluralPastMessage) Fluent setter for pluralPastMessagewithSingularFutureMessage
(String singularFutureMessage) Fluent setter for singularFutureMessagewithSingularMessage
(String singularMessage) withSingularPastMessage
(String singularPastMessage) Fluent setter for singularPastMessage
-
Constructor Details
-
ProcessSummaryLine
public ProcessSummaryLine(Status status, Integer count, String message, ArrayList<Serializable> primaryKeys) -
ProcessSummaryLine
-
ProcessSummaryLine
-
ProcessSummaryLine
-
-
Method Details
-
toString
-
getStatus
Getter for status- Specified by:
getStatus
in interfaceProcessSummaryLineInterface
-
setStatus
Setter for status -
getPrimaryKeys
Getter for primaryKeys -
setPrimaryKeys
Setter for primaryKeys -
getCount
Getter for count -
setCount
Setter for count -
getMessage
Getter for message- Specified by:
getMessage
in interfaceProcessSummaryLineInterface
-
setMessage
Setter for message -
incrementCount
public void incrementCount() -
incrementCount
public void incrementCount(int amount) -
incrementCountAndAddPrimaryKey
-
addSelfToListIfAnyCount
-
getSingularFutureMessage
Getter for singularFutureMessage -
setSingularFutureMessage
Setter for singularFutureMessage -
withSingularFutureMessage
Fluent setter for singularFutureMessage -
getPluralFutureMessage
Getter for pluralFutureMessage -
setPluralFutureMessage
Setter for pluralFutureMessage -
withPluralFutureMessage
Fluent setter for pluralFutureMessage -
getSingularPastMessage
Getter for singularPastMessage -
setSingularPastMessage
Setter for singularPastMessage -
withSingularPastMessage
Fluent setter for singularPastMessage -
getPluralPastMessage
Getter for pluralPastMessage -
setPluralPastMessage
Setter for pluralPastMessage -
withPluralPastMessage
Fluent setter for pluralPastMessage -
pickMessage
public void pickMessage(boolean isPast) -
prepareForFrontend
public void prepareForFrontend(boolean isForResultScreen) Description copied from interface:ProcessSummaryLineInterface
meant to be called by framework, after process is complete, give the summary object a chance to finalize itself before it's sent to a frontend.- Specified by:
prepareForFrontend
in interfaceProcessSummaryLineInterface
-
toLogPair
- Specified by:
toLogPair
in interfaceProcessSummaryLineInterface
-
getMessageSuffix
Getter for messageSuffix -
setMessageSuffix
Setter for messageSuffix -
withMessageSuffix
Fluent setter for messageSuffix -
withSingularMessage
-
withPluralMessage
-
getBulletsOfText
-
setBulletsOfText
-
withBulletsOfText
Fluent setter for bulletsOfText
-