yakworks.api

Interface Result

All Superinterfaces:

yakworks.i18n.MsgKey, yakworks.i18n.MsgKeyDecorator

All Known Subinterfaces:

Exceptional, Problem

public interface Result
extends yakworks.i18n.MsgKeyDecorator

This is the base result trait for problems and results follows https://datatracker.ietf.org/doc/html/rfc7807 for status and title fields In many cases for parallel processing and batch processing we are spinning through chunks of data. Especially when doing gpars and concurrent processing. Java of course does not allow multi-value returns. On errors and exceptions we don't want to stop or halt the processing. So many methods can catch an exception and return this to contain basic status and a message of what went wrong so we can be report on it, log it, etc and move on to try the next item.

Since:

7.0.8

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getDefaultCode()
default java.lang.Boolean	getOk() success or fail? if ok is true then it still may mean that there are warnings and needs to be looked into
default java.lang.Object	getPayload() the response object value or result of the method/function or process Implementations might choose to ignore this in favor of concrete, typed fields.
default ApiStatus	getStatus() status code, normally an HttpStatus.value()
default java.lang.String	getTitle() A short, human-readable summary of the result type.
static yakworks.api.OkResult	OK()
default void	setPayload(java.lang.Object v)
default void	setStatus(ApiStatus v)
default void	setTitle(java.lang.String title)

Methods inherited from interface yakworks.i18n.MsgKeyDecorator

getArgs, getCode, getMsg, setArgs, setCode, setMsg

Methods inherited from interface yakworks.i18n.MsgKey

empty, getFallbackMessage, of, of, setArgs, setFallbackMessage

Method Detail

getDefaultCode

default java.lang.String getDefaultCode()

getTitle

default java.lang.String getTitle()

A short, human-readable summary of the result type. It SHOULD NOT change from occurrence to occurrence of the result, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). in which case code can be used for lookup and the localization with message.properties

setTitle

default void setTitle(java.lang.String title)

getStatus

default ApiStatus getStatus()

status code, normally an HttpStatus.value()

setStatus

default void setStatus(ApiStatus v)

getPayload

default java.lang.Object getPayload()

the response object value or result of the method/function or process Implementations might choose to ignore this in favor of concrete, typed fields. Or this is generated from the target

setPayload

default void setPayload(java.lang.Object v)

getOk

default java.lang.Boolean getOk()

success or fail? if ok is true then it still may mean that there are warnings and needs to be looked into

OK

static yakworks.api.OkResult OK()