Package name.matthewgreet.strutscommons.action

Class AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M extends Serializable,K extends Serializable,T extends Serializable>

java.lang.Object

name.matthewgreet.strutscommons.action.AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>

Enclosing class:

AbstractFindListMultiModeActionSupport<M extends Serializable,K extends Serializable,T extends Serializable,F extends Form>

public static class AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M extends Serializable,K extends Serializable,T extends Serializable>
extends Object

Constructor Summary

Constructors

Constructor	Description
FindListMultiModeResponse()	Constructor for failure to create a finder Command or list rejected.

Method Summary

Modifier and Type	Method	Description
void	addErrorMessage(String text)	Convenience function to add error message.
void	addInfoMessage(String text)	Convenience function to add info message.
Collection<String>	getErrors()	Returns error messages to display.
String	getFailureResultName()	Action result name to use if response is failure.
List<T>	getFullList()	Returns full list or base record list that's already been found for full list or base record pagination mode, or null otherwise.
ListFinder<M,T>	getFullListFinderCommand()	Returns full list finder or base record list finder Command object for full list or base record pagination mode.
List<K>	getIdList()	Returns id list that's already been found for page by ids pagination mode, or null otherwise.
IdListFinder<M,K>	getIdListFinderCommand()	Returns id list finder for page by ids pagination mode.
Integer	getListSize()	Returns list size that's already been found for page by index pagination mode, or null otherwise.
ListSizeFinder<M>	getListSizeFinderCommand()	Returns list size finder for page by index pagination mode.
Collection<String>	getMessages()	Returns info messages to display.
PageByIndexRangeFinder<M,T>	getPageByIndexRangeFinder()	Returns page by index finder for page by index pagination mode.
ListCache.PaginationMode	getPaginationMode()	Returns pagination mode.
boolean	getRejected()	Indicates creating the finder Command failed or, if it was retrieved, the list was rejected.
String	getSuccessResultName()	Action result name to use if response is success.
String	getSuccessSingleForwardName()	Action result name to use if response is success, useSuccessSingle is true, and search result contains just one result.
boolean	getUseSuccessSingle()	If true and search result has just one entry, uses successSingleForwardName Action result.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeFailureResponse(String message)	Returns response for a failure to create a finder Command or list was rejected.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessBaseRecordListResponse(ListFinder<M,T> finderCommand)	Returns response for a successfully created base record list finder Command.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessBaseRecordListWithResultsResponse(ListFinder<M,T> finderCommand, List<T> resultList)	Returns response for a successfully created base record list finder Command with results already found.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessFullListResponse(ListFinder<M,T> finderCommand)	Returns response for a successfully created full list finder Command.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessFullListWithResultsResponse(ListFinder<M,T> finderCommand, List<T> resultList)	Returns response for a successfully created full list finder Command with results already found.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessIdListResponse(IdListFinder<M,K> finderCommand)	Returns response for a successfully created id list finder Command.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessIdListWithResultsResponse(IdListFinder<M,K> finderCommand, List<K> idList)	Returns response for a successfully created id list finder Command with results already found.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessIndexListResponse(ListSizeFinder<M> listSizeFinderCommand, PageByIndexRangeFinder<M,T> pageByIndexFinderCommand)	Returns response for a successfully created index list finder Command and page by index Command.
static <M extends Serializable, K extends Serializable, T extends Serializable> AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T>	makeSuccessIndexListWithResultsResponse(ListSizeFinder<M> listSizeFinderCommand, PageByIndexRangeFinder<M,T> pageByIndexFinderCommand, int listSize)	Returns response for a successfully created index list finder Command and page by index Command.
void	setErrors(Collection<String> errors)
void	setFailureResultName(String value)
void	setFullList(List<T> fullList)
void	setFullListFinderCommand(ListFinder<M,T> fullListFinderCommand)
void	setIdList(List<K> idList)
void	setIdListFinderCommand(IdListFinder<M,K> idListFinderCommand)
void	setListSize(Integer listSize)
void	setListSizeFinderCommand(ListSizeFinder<M> listSizeFinderCommand)
void	setMessages(Collection<String> messages)
void	setPageByIndexRangeFinder(PageByIndexRangeFinder<M,T> pageByIndexRangeFinder)
void	setPaginationMode(ListCache.PaginationMode paginationMode)
void	setRejected(boolean rejected)
void	setSuccessResultName(String value)
void	setSuccessSingleForwardName(String successSingleForwardName)
void	setUseSuccessSingle(boolean useSuccessSingle)

Methods inherited from class java.lang.Object

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

Constructor Details

FindListMultiModeResponse

public FindListMultiModeResponse()

Constructor for failure to create a finder Command or list rejected.

Method Details

makeFailureResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeFailureResponse(String message)

Returns response for a failure to create a finder Command or list was rejected.

makeSuccessBaseRecordListResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessBaseRecordListResponse(ListFinder<M,T> finderCommand)

Returns response for a successfully created base record list finder Command.

makeSuccessBaseRecordListWithResultsResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessBaseRecordListWithResultsResponse(ListFinder<M,T> finderCommand,
 List<T> resultList)

Returns response for a successfully created base record list finder Command with results already found.

makeSuccessFullListResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessFullListResponse(ListFinder<M,T> finderCommand)

Returns response for a successfully created full list finder Command.

makeSuccessFullListWithResultsResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessFullListWithResultsResponse(ListFinder<M,T> finderCommand,
 List<T> resultList)

Returns response for a successfully created full list finder Command with results already found.

makeSuccessIdListResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessIdListResponse(IdListFinder<M,K> finderCommand)

Returns response for a successfully created id list finder Command.

makeSuccessIdListWithResultsResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessIdListWithResultsResponse(IdListFinder<M,K> finderCommand,
 List<K> idList)

Returns response for a successfully created id list finder Command with results already found.

makeSuccessIndexListResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessIndexListResponse(ListSizeFinder<M> listSizeFinderCommand,
 PageByIndexRangeFinder<M,T> pageByIndexFinderCommand)

Returns response for a successfully created index list finder Command and page by index Command.

makeSuccessIndexListWithResultsResponse

public static <M extends Serializable,
K extends Serializable,
T extends Serializable>
AbstractFindListMultiModeActionSupport.FindListMultiModeResponse<M,K,T> makeSuccessIndexListWithResultsResponse(ListSizeFinder<M> listSizeFinderCommand,
 PageByIndexRangeFinder<M,T> pageByIndexFinderCommand,
 int listSize)

Returns response for a successfully created index list finder Command and page by index Command.

getRejected

public boolean getRejected()

Indicates creating the finder Command failed or, if it was retrieved, the list was rejected. If set, template base class uses action result named by getFailureResultName(), otherwise uses action result named by getSuccessResultName(). Defaults to true.

setRejected

public void setRejected(boolean rejected)

getFailureResultName

public String getFailureResultName()

Action result name to use if response is failure. Defaults to "input".

setFailureResultName

public void setFailureResultName(String value)

getSuccessResultName

public String getSuccessResultName()

Action result name to use if response is success. Defaults to "success".

setSuccessResultName

public void setSuccessResultName(String value)

getSuccessSingleForwardName

public String getSuccessSingleForwardName()

Action result name to use if response is success, useSuccessSingle is true, and search result contains just one result.

setSuccessSingleForwardName

public void setSuccessSingleForwardName(String successSingleForwardName)

getFullListFinderCommand

public ListFinder<M,T> getFullListFinderCommand()

Returns full list finder or base record list finder Command object for full list or base record pagination mode.

setFullListFinderCommand

public void setFullListFinderCommand(ListFinder<M,T> fullListFinderCommand)

getFullList

public List<T> getFullList()

Returns full list or base record list that's already been found for full list or base record pagination mode, or null otherwise.

setFullList

public void setFullList(List<T> fullList)

getIdListFinderCommand

public IdListFinder<M,K> getIdListFinderCommand()

Returns id list finder for page by ids pagination mode.

setIdListFinderCommand

public void setIdListFinderCommand(IdListFinder<M,K> idListFinderCommand)

getIdList

public List<K> getIdList()

Returns id list that's already been found for page by ids pagination mode, or null otherwise.

setIdList

public void setIdList(List<K> idList)

getListSizeFinderCommand

public ListSizeFinder<M> getListSizeFinderCommand()

Returns list size finder for page by index pagination mode. listSizeFinderCommand and pageByIndexRangeFinder are set in pairs.

setListSizeFinderCommand

public void setListSizeFinderCommand(ListSizeFinder<M> listSizeFinderCommand)

getPageByIndexRangeFinder

public PageByIndexRangeFinder<M,T> getPageByIndexRangeFinder()

Returns page by index finder for page by index pagination mode. listSizeFinderCommand and pageByIndexRangeFinder are set in pairs.

setPageByIndexRangeFinder

public void setPageByIndexRangeFinder(PageByIndexRangeFinder<M,T> pageByIndexRangeFinder)

getListSize

public Integer getListSize()

Returns list size that's already been found for page by index pagination mode, or null otherwise.

setListSize

public void setListSize(Integer listSize)

getUseSuccessSingle

public boolean getUseSuccessSingle()

If true and search result has just one entry, uses successSingleForwardName Action result.

setUseSuccessSingle

public void setUseSuccessSingle(boolean useSuccessSingle)

getPaginationMode

public ListCache.PaginationMode getPaginationMode()

Returns pagination mode.

setPaginationMode

public void setPaginationMode(ListCache.PaginationMode paginationMode)

getErrors

public Collection<String> getErrors()

Returns error messages to display.

setErrors

public void setErrors(Collection<String> errors)

getMessages

public Collection<String> getMessages()

Returns info messages to display.

setMessages

public void setMessages(Collection<String> messages)

addErrorMessage

public void addErrorMessage(String text)

Convenience function to add error message.

addInfoMessage

public void addInfoMessage(String text)

Convenience function to add info message.