de.geeksfactory.opacclient.apis

Class OpacApi.MultiStepResult

java.lang.Object

de.geeksfactory.opacclient.apis.OpacApi.MultiStepResult

Direct Known Subclasses:

EbookServiceApi.BookingResult, OpacApi.CancelResult, OpacApi.ProlongAllResult, OpacApi.ProlongResult, OpacApi.ReservationResult

Enclosing interface:

OpacApi

public abstract static class OpacApi.MultiStepResult
extends java.lang.Object

The result of a multi-step-supporting method call. This is a way of implementing an operating which may need an unregular number of steps with user interaction. When the user starts the operation, the method is called. It may return success or error, after which the operation does not continue, but it also may return that it requires user interaction - either a selection or a confirmation. After the user interacted, the same method is being called again, but with other parameters.

Since:

2.0.18

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpacApi.MultiStepResult.Status

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_CONFIRMATION Action type identifier for process confirmation
static int	ACTION_USER Action number to use for custom selection type identifiers.
protected int	actionidentifier
protected java.util.List<java.lang.String[]>	details
protected java.lang.String	message
protected java.util.List<java.util.Map<java.lang.String,java.lang.String>>	selection
protected OpacApi.MultiStepResult.Status	status

Constructor Summary

Constructors

Constructor and Description
MultiStepResult(OpacApi.MultiStepResult.Status status) Create a new Result object holding the return status of the operation.
MultiStepResult(OpacApi.MultiStepResult.Status status, java.lang.String message) Create a new Result object holding the return status of the operation and a message

Method Summary

Modifier and Type	Method and Description
int	getActionIdentifier() Identifier for the type of user selection if getStatus() is SELECTION_NEEDED.
java.util.List<java.lang.String[]>	getDetails() If getStatus() is CONFIRMATION_NEEDED, this gives you more information to display to the user.
java.lang.String	getMessage()
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getSelection() Get values the user should select one of if getStatus() is SELECTION_NEEDED.
OpacApi.MultiStepResult.Status	getStatus() Get the return status of the operation.
void	setActionIdentifier(int actionidentifier) Set identifier for the type of user selection if getStatus() is SELECTION_NEEDED.
void	setDetails(java.util.List<java.lang.String[]> details) Set details the user should confirm if getStatus() is CONFIRMATION_NEEDED.
void	setMessage(java.lang.String message) Set an optional message, e.g. to explain an error status code
void	setSelection(java.util.List<java.util.Map<java.lang.String,java.lang.String>> selection) Set values the user should select one of if getStatus() is set to SELECTION_NEEDED.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_CONFIRMATION

public static final int ACTION_CONFIRMATION

Action type identifier for process confirmation

See Also:

Constant Field Values

ACTION_USER

public static final int ACTION_USER

Action number to use for custom selection type identifiers.

See Also:

Constant Field Values

status

protected OpacApi.MultiStepResult.Status status

selection

protected java.util.List<java.util.Map<java.lang.String,java.lang.String>> selection

details

protected java.util.List<java.lang.String[]> details

actionidentifier

protected int actionidentifier

message

protected java.lang.String message

Constructor Detail

MultiStepResult

public MultiStepResult(OpacApi.MultiStepResult.Status status)

Create a new Result object holding the return status of the operation.

Parameters:

status - The return status

See Also:

getStatus()

MultiStepResult

public MultiStepResult(OpacApi.MultiStepResult.Status status,
                       java.lang.String message)

Create a new Result object holding the return status of the operation and a message

Parameters:

status - The return status

message - A message

See Also:

getStatus()

Method Detail

getStatus

public OpacApi.MultiStepResult.Status getStatus()

Get the return status of the operation. Can be OK if the operation was successful, ERROR if the operation failed, SELECTION_NEEDED if the user should select one of the options presented in getSelection() or CONFIRMATION_NEEDED if the user should confirm the details returned by getDetails. .

getActionIdentifier

public int getActionIdentifier()

Identifier for the type of user selection if getStatus() is SELECTION_NEEDED.

Returns:

One of the ACTION_ constants or a number above ACTION_USER.

setActionIdentifier

public void setActionIdentifier(int actionidentifier)

Set identifier for the type of user selection if getStatus() is SELECTION_NEEDED.

Parameters:

actionidentifier - One of the ACTION_ constants or a number above ACTION_USER.

getSelection

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getSelection()

Get values the user should select one of if getStatus() is SELECTION_NEEDED.

Returns:

A list of maps with the keys 'key' and 'value', where 'key' is what is to be returned back to reservation() and the value is what is to be displayed to the user.

setSelection

public void setSelection(java.util.List<java.util.Map<java.lang.String,java.lang.String>> selection)

Set values the user should select one of if getStatus() is set to SELECTION_NEEDED.

Parameters:

selection - Store with key-value-tuples where the key is what is to be returned back to reservation() and the value is what is to be displayed to the user.

getDetails

public java.util.List<java.lang.String[]> getDetails()

If getStatus() is CONFIRMATION_NEEDED, this gives you more information to display to the user. This is a list of of unknown length. Every list entry is an array of strings that of size one or two (which can vary between the elements of the list). If the size of such an array A is two, then A[0] contains a description of A[1], e.g. A = {"Fee", "2 EUR"} or A = {"Pickup location", "Central library"}. If the size is only one, it is a general message to be shown, e.g. {"This action will cost 2 EUR."}.

Returns:

A list of String[] entries, as described above.

setDetails

public void setDetails(java.util.List<java.lang.String[]> details)

Set details the user should confirm if getStatus() is CONFIRMATION_NEEDED.

Parameters:

details - List containing reservation details. See getDetails() for what this means.

getMessage

public java.lang.String getMessage()

Returns:

A optional message, e.g. to explain an error status code

setMessage

public void setMessage(java.lang.String message)

Set an optional message, e.g. to explain an error status code