net.bitform.api.options

Interface Option

All Known Implementing Classes:

AnalyzeOption, BasicOption, BooleanOption, DateOption, DirectoryOption, DurationOption, EnumListOption, EnumOption, FileFormatListOption, FileFormatOption, FileListOption, FileOption, FloatOption, HandlerOption, IntegerOption, ObjectListOption, ObjectOption, ScrubOption, SecureOptions.ColorObfuscatedTextRemediationOption, SecureOptions.DecryptionStatusOption, SecureOptions.Fields.Action, SecureOptions.HeadersFootersBehaviorOption, SecureOptions.OutputTypeOption, SecureOptions.ProcessingStatusOption, SecureOptions.Properties.Action, SecureOptions.ToTextEncodingOption, StringListOption, StringOption, TargetOption

public interface Option

Basic interface on which all option types are built.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Gets the string id for this option.
java.lang.String	getLongDescription() Gets a multi-line description for this option
java.lang.String	getName() Gets a short name for this option, suitable for UI elements like list boxes
java.lang.String	getShortDescription() Gets a one line description for this option
int	getUid() Gets the unique integer id for this option.
boolean	isRequest() Is the option usable in a request
boolean	isResponse() Is the option usable in a response

Method Detail

getName

java.lang.String getName()

Gets a short name for this option, suitable for UI elements like list boxes

Returns:

A short name

getId

java.lang.String getId()

Gets the string id for this option. This id is invariant for lifetime of the API and may be used for persisting the option.

Returns:

The id

getUid

int getUid()

Gets the unique integer id for this option. This id is invariant for lifetime of the API and may be used for persisting the option.

Returns:

The id

getShortDescription

java.lang.String getShortDescription()

Gets a one line description for this option

Returns:

Description

getLongDescription

java.lang.String getLongDescription()

Gets a multi-line description for this option

Returns:

Description

isRequest

boolean isRequest()

Is the option usable in a request

Returns:

true if this option is an input option and may be set on a request object.

isResponse

boolean isResponse()

Is the option usable in a response

Returns:

true if this option is an output option and may be retrieved from a response object.