org.apache.isis.core.metamodel.consent

Enum InteractionContextType

java.lang.Object

java.lang.Enum<InteractionContextType>

org.apache.isis.core.metamodel.consent.InteractionContextType

All Implemented Interfaces:

Serializable, Comparable<InteractionContextType>

public enum InteractionContextType
extends Enum<InteractionContextType>

Powertype for the InteractionContext hierarchy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION_INVOKE Invoking (or attempting to invoke) an action.
ACTION_PROPOSED_ARGUMENT Whether this particular proposed argument for an action invocation is valid (or if it is in fact invalid).
ACTION_USABLE Whether the action of the object is usable (or has been disabled).
ACTION_VISIBLE Whether the action of the object is visible (or has been hidden).
COLLECTION_ADD_TO Adding to (or attempting to add to) a collection.
COLLECTION_READ Reading the contents of the collection.
COLLECTION_REMOVE_FROM Removing from (or attempting to remove from) a collection.
COLLECTION_USABLE Determining whether the collection of the object is either readable or modifiable (or has been disabled).
COLLECTION_VISIBLE Determining whether the collection of the object is visible (or has been hidden).
OBJECT_TITLE Accessing the object's title.
OBJECT_VALIDATE Persisting the object.
PARSE_VALUE Parsing a value (could be an property or an action argument).
PROPERTY_MODIFY Modifying (or attempting to modify) the value of a property.
PROPERTY_READ Reading the current value of the property of the object.
PROPERTY_USABLE Determining whether the property of the object is either readable or modifiable (or has been disabled).
PROPERTY_VISIBLE Determining whether the property of the object is visible (or has been hidden).

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
static InteractionContextType	valueOf(String name) Returns the enum constant of this type with the specified name.
static InteractionContextType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OBJECT_VALIDATE

public static final InteractionContextType OBJECT_VALIDATE

Persisting the object.

OBJECT_TITLE

public static final InteractionContextType OBJECT_TITLE

Accessing the object's title.

PROPERTY_VISIBLE

public static final InteractionContextType PROPERTY_VISIBLE

Determining whether the property of the object is visible (or has been hidden).

PROPERTY_USABLE

public static final InteractionContextType PROPERTY_USABLE

Determining whether the property of the object is either readable or modifiable (or has been disabled).

PROPERTY_READ

public static final InteractionContextType PROPERTY_READ

Reading the current value of the property of the object.

PROPERTY_MODIFY

public static final InteractionContextType PROPERTY_MODIFY

Modifying (or attempting to modify) the value of a property.

COLLECTION_VISIBLE

public static final InteractionContextType COLLECTION_VISIBLE

Determining whether the collection of the object is visible (or has been hidden).

COLLECTION_USABLE

public static final InteractionContextType COLLECTION_USABLE

Determining whether the collection of the object is either readable or modifiable (or has been disabled).

COLLECTION_READ

public static final InteractionContextType COLLECTION_READ

Reading the contents of the collection.

COLLECTION_ADD_TO

public static final InteractionContextType COLLECTION_ADD_TO

Adding to (or attempting to add to) a collection.

COLLECTION_REMOVE_FROM

public static final InteractionContextType COLLECTION_REMOVE_FROM

Removing from (or attempting to remove from) a collection.

ACTION_VISIBLE

public static final InteractionContextType ACTION_VISIBLE

Whether the action of the object is visible (or has been hidden).

ACTION_USABLE

public static final InteractionContextType ACTION_USABLE

Whether the action of the object is usable (or has been disabled).

ACTION_PROPOSED_ARGUMENT

public static final InteractionContextType ACTION_PROPOSED_ARGUMENT

Whether this particular proposed argument for an action invocation is valid (or if it is in fact invalid).

For example, ensuring that a regular expression match or number range is correct.

ACTION_INVOKE

public static final InteractionContextType ACTION_INVOKE

Invoking (or attempting to invoke) an action.

Even if each of the proposed arguments are valid, it may not be possible to invoke the action if there the arguments together are invalid (for example, startDate > endDate).

PARSE_VALUE

public static final InteractionContextType PARSE_VALUE

Parsing a value (could be an property or an action argument).

Method Detail

values

public static InteractionContextType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InteractionContextType c : InteractionContextType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InteractionContextType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDescription

public String getDescription()