Package org.forgerock.openam.authentication.callbacks

Class BooleanAttributeInputCallback

java.lang.Object

org.forgerock.openam.authentication.callbacks.AbstractValidatedCallback

org.forgerock.openam.authentication.callbacks.AttributeInputCallback

org.forgerock.openam.authentication.callbacks.BooleanAttributeInputCallback

All Implemented Interfaces:

Callback

@Supported(scriptingApi=true)
public class BooleanAttributeInputCallback
extends org.forgerock.openam.authentication.callbacks.AttributeInputCallback

Implements a Callback for collection of a single identity object attribute from a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	Builder object for a StringAttributeInputCallback.

Method Summary

Modifier and Type	Method	Description
static BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	builder()	Get a builder for constructing a new BooleanAttributeInputCallback.
String	getName()
String	getPrompt()
Boolean	getValue()
boolean	isEmpty()
boolean	isRequired()
void	setValue(boolean value)	Set the value to be returned by this callback.

Methods inherited from class java.lang.Object

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

Method Details

getValue

@Supported
public Boolean getValue()

setValue

@Supported
public void setValue(boolean value)

Set the value to be returned by this callback.

Parameters:

value - the value collected by this callback

getName

@Supported
public String getName()

getPrompt

@Supported
public String getPrompt()

isRequired

@Supported
public boolean isRequired()

isEmpty

@Supported
public boolean isEmpty()

builder

@Supported
public static BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder builder()

Get a builder for constructing a new BooleanAttributeInputCallback.

Returns:

a new builder