Package org.forgerock.openam.authentication.callbacks

Class TermsAndConditionsCallback

java.lang.Object

org.forgerock.openam.authentication.callbacks.TermsAndConditionsCallback

All Implemented Interfaces:

Callback

@Supported
public class TermsAndConditionsCallback
extends Object
implements Callback

A callback to collect a user's acceptance of the configured Terms & Conditions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TermsAndConditionsCallback.Builder	A builder for TermsAndConditionsCallback.

Method Summary

Modifier and Type	Method	Description
static TermsAndConditionsCallback.Builder	builder()	Get a builder for constructing a new TermsAndConditionsCallback.
boolean	getAccept()	Retrieve the acceptance.
String	getCreateDate()	The create date of the Terms & Conditions.
String	getTerms()	Retrieve the Terms & Conditions.
String	getVersion()	Retrieves the version.
void	setAccept(boolean accept)	Sets whether the Terms have been accepted.

Methods inherited from class java.lang.Object

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

Method Details

getTerms

@Supported
public String getTerms()

Retrieve the Terms & Conditions.

Returns:

the Terms & Conditions

getVersion

@Supported
public String getVersion()

Retrieves the version.

Returns:

the version

getCreateDate

@Supported
public String getCreateDate()

The create date of the Terms & Conditions.

Returns:

the create date.

setAccept

@Supported
public void setAccept(boolean accept)

Sets whether the Terms have been accepted.

Parameters:

accept - boolean representing the acceptance of the terms.

getAccept

@Supported
public boolean getAccept()

Retrieve the acceptance.

Returns:

the acceptance of the Terms & Conditions.

builder

@Supported
public static TermsAndConditionsCallback.Builder builder()

Get a builder for constructing a new TermsAndConditionsCallback.

Returns:

a new builder