org.openmrs.util
Class InputRequiredException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.openmrs.util.InputRequiredException

All Implemented Interfaces:

java.io.Serializable

public class InputRequiredException
extends java.lang.Exception

Used by the DatabaseUpdater to signal that a given update requires input from the user.

Since:

1.5

See Also:

Serialized Form

Nested Class Summary

static class

InputRequiredException.DATATYPE Required input will be in one of these forms

Field Summary

static long

serialVersionUID

Constructor Summary

InputRequiredException(java.util.Map<java.lang.String,InputRequiredException.DATATYPE> requiredInput)
Common constructor taking in a message to give the user some context as to where/why the authentication failed.

Method Summary

java.util.Map<java.lang.String,InputRequiredException.DATATYPE>

getRequiredInput() The user prompts and datatype for each question that the user has to provide input for

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

InputRequiredException

public InputRequiredException(java.util.Map<java.lang.String,InputRequiredException.DATATYPE> requiredInput)

Common constructor taking in a message to give the user some context as to where/why the authentication failed.

Parameters:

requiredInput - a list of questions that need to be answered in the form question, type

Method Detail

getRequiredInput

public java.util.Map<java.lang.String,InputRequiredException.DATATYPE> getRequiredInput()

The user prompts and datatype for each question that the user has to provide input for

Returns:

the requiredInput