io.javadog.cws.api.common

Enum Action

java.lang.Object

java.lang.Enum<Action>

io.javadog.cws.api.common.Action

All Implemented Interfaces:

Serializable, Comparable<Action>

public enum Action
extends Enum<Action>

When invoking a processing Request to the CWS, it must be with a specific type of Action, which may or may not be allowed.

This enumerated type contain all the allowed Actions, and each Request will allow one or more of these.

Since:

CWS 1.0

Author:

Kim Jensen

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD This Action adds a Trustee to a Circle.
ALTER This Action is used when either altering an Account or a Trustee.
COPY This Action allows someone who have write-access to a Circle, to copy a Data Object to another Circle, where they have write access.
CREATE The Action Create is for creating new records.
DELETE The Action Delete covers removal of records, which is a permanent irreversible Action.
INVALIDATE Invalidating an Account, means that the Account is being made unreadable and it is not possible for Account to be used again.
INVITE For Invitations, which will allow the System Administrator to create new Accounts by issuing a signed invitation.
LOGIN For creating a Session for an existing Account, the Login Action must be used.
LOGOUT When a Session is no longer needed for an Account, the Logout Action must be used.
MOVE This Action allows someone who have write-access to a Circle, to move a Data Object to another Circle, where they have write access.
PROCESS The Action Process covers creating and updating records.
REMOVE This Action allows a Circle or System Administrator to remove a Member from a Circle.
UPDATE The Action Update, is for updating existing records.

Method Summary

Modifier and Type	Method and Description
static Action	valueOf(String name) Returns the enum constant of this type with the specified name.
static Action[]	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

PROCESS

public static final Action PROCESS

The Action Process covers creating and updating records.

CREATE

public static final Action CREATE

The Action Create is for creating new records.

UPDATE

public static final Action UPDATE

The Action Update, is for updating existing records.

INVITE

public static final Action INVITE

For Invitations, which will allow the System Administrator to create new Accounts by issuing a signed invitation.

LOGIN

public static final Action LOGIN

For creating a Session for an existing Account, the Login Action must be used.

LOGOUT

public static final Action LOGOUT

When a Session is no longer needed for an Account, the Logout Action must be used.

DELETE

public static final Action DELETE

The Action Delete covers removal of records, which is a permanent irreversible Action.

ADD

public static final Action ADD

This Action adds a Trustee to a Circle.

COPY

public static final Action COPY

This Action allows someone who have write-access to a Circle, to copy a Data Object to another Circle, where they have write access.

MOVE

public static final Action MOVE

This Action allows someone who have write-access to a Circle, to move a Data Object to another Circle, where they have write access.

ALTER

public static final Action ALTER

This Action is used when either altering an Account or a Trustee. If the request was ProcessMember, then it is possible to change the Role of the Member in the system, i.e. grant or revoke Administrative rights. If the request was ProcessTrustee, then it is possible for a Circle Administrator to change the Trust Level for another Trustee.

Note; it is not possible for a System Administrator to grant someone access to a Circle of Trust, unless the System Administrator is part of the Circle.

INVALIDATE

public static final Action INVALIDATE

Invalidating an Account, means that the Account is being made unreadable and it is not possible for Account to be used again.

REMOVE

public static final Action REMOVE

This Action allows a Circle or System Administrator to remove a Member from a Circle. A Circle Administrator cannot remove themselves from a Circle.

Method Detail

values

public static Action[] 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 (Action c : Action.values())
    System.out.println(c);

Returns:

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

valueOf

public static Action 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