org.apache.isis.core.metamodel.consent

Interface Consent

All Known Implementing Classes:

Allow, ConsentAbstract, Veto

public interface Consent

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Description of the interaction that this consent represents.
InteractionResult	getInteractionResult() The InteractionResult that created this Consent.
String	getReason() Why consent is being vetoed.
boolean	isAllowed() Returns true if this object is giving permission.
boolean	isVetoed() Returns true if this object is NOT giving permission.
Consent	setDescription(String description) Allows the description of the interaction to which this consent relates to be specified or refined.

Method Detail

isAllowed

boolean isAllowed()

Returns true if this object is giving permission.

isVetoed

boolean isVetoed()

Returns true if this object is NOT giving permission.

getReason

String getReason()

Why consent is being vetoed.

Will be non-null and non-empty if vetoed. Will be null (not the empty string) if this is consent is is allowed.

Will correspond to the reason in the contained InteractionResult (if one was specified).

getDescription

String getDescription()

Description of the interaction that this consent represents.

May be null.

setDescription

Consent setDescription(String description)

Allows the description of the interaction to which this consent relates to be specified or refined.

Parameters:

description -

Returns:

this consent

getInteractionResult

InteractionResult getInteractionResult()

The InteractionResult that created this Consent.

Returns:

- may be null if created as a legacy Consent.