Class AbstractActionResource.ActionResultBeanBuilder

java.lang.Object

ch.tocco.nice2.rest.action.spi.AbstractActionResource.ActionResultBeanBuilder

Enclosing class:

AbstractActionResource

public class AbstractActionResource.ActionResultBeanBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
ActionResultBeanBuilder(boolean success)

Method Summary

Modifier and Type	Method	Description
AbstractActionResource.ActionResultBeanBuilder	addDownloadUrl(String downloadUrl, String filename)	this method can be used to add a download url and the resulting filename.
AbstractActionResource.ActionResultBeanBuilder	addOutputJob(Entity outputJob)
AbstractActionResource.ActionResultBeanBuilder	addParam(String key, Object value)
AbstractActionResource.ActionResultBeanBuilder	addResultEntity(Entity entity)
AbstractActionResource.ActionResultBeanBuilder	addResultEntityId(SimpleEntityId entityId)
AbstractActionResource.ActionResultBean	build()
AbstractActionResource.ActionResultBeanBuilder	clearSelection()
List<ResultBean.EntityId>	getResultEntityIds()
AbstractActionResource.ActionResultBeanBuilder	message(TextMessage textMessage)
AbstractActionResource.ActionResultBeanBuilder	message(String textResourceKey)
AbstractActionResource.ActionResultBeanBuilder	messageFormatted(String message)
AbstractActionResource.ActionResultBeanBuilder	reloadDetail()	This reloadDetail flag is normally not necessary as the list/detail, where the action is called, is automatically reloaded.
AbstractActionResource.ActionResultBeanBuilder	selectionDeleted()
AbstractActionResource.ActionResultBeanBuilder	skipReloadingDetail()	in some widgets (e.g.

Methods inherited from class Object

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

Constructor Details

ActionResultBeanBuilder

public ActionResultBeanBuilder(boolean success)

Method Details

message

public AbstractActionResource.ActionResultBeanBuilder message(String textResourceKey)

message

public AbstractActionResource.ActionResultBeanBuilder message(TextMessage textMessage)

messageFormatted

public AbstractActionResource.ActionResultBeanBuilder messageFormatted(String message)

addParam

public AbstractActionResource.ActionResultBeanBuilder addParam(String key,
 Object value)

addDownloadUrl

public AbstractActionResource.ActionResultBeanBuilder addDownloadUrl(String downloadUrl,
 String filename)

this method can be used to add a download url and the resulting filename. in the frontend the download url is called (with the same body as the action request). the response file is named as the passed filename

addResultEntity

public AbstractActionResource.ActionResultBeanBuilder addResultEntity(Entity entity)

addResultEntityId

public AbstractActionResource.ActionResultBeanBuilder addResultEntityId(SimpleEntityId entityId)

addOutputJob

public AbstractActionResource.ActionResultBeanBuilder addOutputJob(Entity outputJob)

clearSelection

public AbstractActionResource.ActionResultBeanBuilder clearSelection()

selectionDeleted

public AbstractActionResource.ActionResultBeanBuilder selectionDeleted()

reloadDetail

public AbstractActionResource.ActionResultBeanBuilder reloadDetail()

This reloadDetail flag is normally not necessary as the list/detail, where the action is called, is automatically reloaded. However, if the action is on a sub-table and the entity of the detail is changed the reloadDetail flag should be used to force reload the detail.

skipReloadingDetail

public AbstractActionResource.ActionResultBeanBuilder skipReloadingDetail()

in some widgets (e.g. stint-auction) after executing the action, the user no longer has access to the entity (rendered in the detail). normally we would just navigate back to the list. however the widget shows a success page and hides the entity browser. With this flag we just tell the frontend to not reload the detail.

build

public AbstractActionResource.ActionResultBean build()

getResultEntityIds

public List<ResultBean.EntityId> getResultEntityIds()