net.bitform.api.secure

Class SecureOptions.ProcessingStatusOption

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.EnumOption

net.bitform.api.secure.SecureOptions.ProcessingStatusOption

All Implemented Interfaces:

Option

Enclosing class:

SecureOptions

public static class SecureOptions.ProcessingStatusOption
extends EnumOption

Field Summary

Fields

Modifier and Type	Field and Description
static EnumOptionValue	CausedException Processing the document caused an exception
static EnumOptionValue	NotIdentified The document could not be indetified
static EnumOptionValue	NotSupported The document's file format is not supported
static EnumOptionValue	Processed The document was processed successfully
static EnumOptionValue	Timeout Processing the document timed out before it could complete

Method Summary

Modifier and Type	Method and Description
static EnumOptionValue[]	getAll() Get all predefinied Statuss
EnumOptionValue	getDefault() Gets the default value for this option.
EnumOptionValue	mapId(int id) Map a integer id to a value
EnumOptionValue	mapId(java.lang.String id) Map a string id to a value

Methods inherited from class net.bitform.api.options.BasicOption

getId, getLongDescription, getName, getShortDescription, getUid, isRequest, isResponse, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Processed

public static final EnumOptionValue Processed

The document was processed successfully

NotIdentified

public static final EnumOptionValue NotIdentified

The document could not be indetified

NotSupported

public static final EnumOptionValue NotSupported

The document's file format is not supported

CausedException

public static final EnumOptionValue CausedException

Processing the document caused an exception

Timeout

public static final EnumOptionValue Timeout

Processing the document timed out before it could complete

Method Detail

getDefault

public EnumOptionValue getDefault()

Description copied from class: EnumOption

Gets the default value for this option.

Overrides:

getDefault in class EnumOption

Returns:

Default value

getAll

public static EnumOptionValue[] getAll()

Get all predefinied Statuss

Returns:

array containing all possible Statuss

mapId

public EnumOptionValue mapId(int id)

Description copied from class: EnumOption

Map a integer id to a value

Specified by:

mapId in class EnumOption

Parameters:

id - The integer id of a value for this enum

Returns:

The value or null if the id cannot be mapped

mapId

public EnumOptionValue mapId(java.lang.String id)

Description copied from class: EnumOption

Map a string id to a value

Specified by:

mapId in class EnumOption

Parameters:

id - The sting id of a value for this enum

Returns:

The value or null if the id cannot be mapped