CAction (josef 3.2.5 API)

java.lang.Object
- java.lang.Enum<CAction>
- - org.josef.web.jsf.CAction

All Implemented Interfaces:

Serializable, Comparable<CAction>
```
public enum CAction
extends Enum<CAction>
```
Enumeration of Common Actions.
As of JSF 1.2 it is possible to return an enumerated constant instead of a String. Returning an enumerated constant is preferred over returning a String constant.
When you update this class you may also want to update ActionBean.

Version:

1.0 $Revision: 5773 $

Author:

Kees Schotanus

See Also:

ActionBean

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORT` Abort.
`ADD` Add.
`ADD_ALL` Add all.
`ADD_SELECTED` Add selected.
`APPLY` Apply.
`BACK` Back.
`CANCEL` Cancel.
`CLEAR` Clear.
`CLOSE` Close.
`CONTINUE` Continue.
`COPY` Copy.
`CREATE` Create.
`DELETE` Delete.
`EDIT` Edit.
`FAILURE` Failure.
`FORWARD` Forward.
`IGNORE` Ignore.
`LOGIN` Login.
`LOGOUT` Logout.
`NEW` New.
`NEXT` Next.
`NO` No.
`OK` Ok.
`OPEN` Open.
`PREVIOUS` Previous.
`REMOVE` Remove.
`REMOVE_ALL` Remove all.
`REMOVE_SELECTED` Remove selected.
`RESET` Reset.
`RESTORE` Restore.
`SAVE` Save.
`SEARCH` Search.
`SELECT` Select.
`SUBMIT` Submit.
`SUCCESS` Success.
`YES` Yes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CAction`	`getAction(String name)` Gets the enumerated CAction that corresponds with the supplied name.
`String`	`toString()` Creates a String representation of this enumeration, suitable for using in designing the flow of JSF pages.
`static CAction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CAction[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ABORT
```
public static final CAction ABORT
```
    Abort.
  - ADD
```
public static final CAction ADD
```
    Add.
  - ADD_ALL
```
public static final CAction ADD_ALL
```
    Add all.
  - ADD_SELECTED
```
public static final CAction ADD_SELECTED
```
    Add selected.
  - APPLY
```
public static final CAction APPLY
```
    Apply.
  - BACK
```
public static final CAction BACK
```
    Back.
  - CANCEL
```
public static final CAction CANCEL
```
    Cancel.
  - CLEAR
```
public static final CAction CLEAR
```
    Clear.
  - CLOSE
```
public static final CAction CLOSE
```
    Close.
  - CONTINUE
```
public static final CAction CONTINUE
```
    Continue.
  - COPY
```
public static final CAction COPY
```
    Copy.
  - CREATE
```
public static final CAction CREATE
```
    Create.
  - DELETE
```
public static final CAction DELETE
```
    Delete.
  - EDIT
```
public static final CAction EDIT
```
    Edit.
  - FAILURE
```
public static final CAction FAILURE
```
    Failure.
  - FORWARD
```
public static final CAction FORWARD
```
    Forward.
  - IGNORE
```
public static final CAction IGNORE
```
    Ignore.
  - LOGIN
```
public static final CAction LOGIN
```
    Login.
  - LOGOUT
```
public static final CAction LOGOUT
```
    Logout.
  - NEW
```
public static final CAction NEW
```
    New.
  - NEXT
```
public static final CAction NEXT
```
    Next.
  - NO
```
public static final CAction NO
```
    No.
  - OK
```
public static final CAction OK
```
    Ok.
  - OPEN
```
public static final CAction OPEN
```
    Open.
  - PREVIOUS
```
public static final CAction PREVIOUS
```
    Previous.
  - REMOVE
```
public static final CAction REMOVE
```
    Remove.
  - REMOVE_ALL
```
public static final CAction REMOVE_ALL
```
    Remove all.
  - REMOVE_SELECTED
```
public static final CAction REMOVE_SELECTED
```
    Remove selected.
  - RESET
```
public static final CAction RESET
```
    Reset.
  - RESTORE
```
public static final CAction RESTORE
```
    Restore.
  - SAVE
```
public static final CAction SAVE
```
    Save.
  - SEARCH
```
public static final CAction SEARCH
```
    Search.
  - SELECT
```
public static final CAction SELECT
```
    Select.
  - SUBMIT
```
public static final CAction SUBMIT
```
    Submit.
  - SUCCESS
```
public static final CAction SUCCESS
```
    Success.
  - YES
```
public static final CAction YES
```
    Yes.
- Method Detail
  - values
```
public static CAction[] 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 (CAction c : CAction.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CAction 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
  - toString
```
public String toString()
```
    Creates a String representation of this enumeration, suitable for using in designing the flow of JSF pages.
    When this enumeration contains no underscores then the lower case name of this enumeration is returned. When this enumeration does contain underscores, a camel case String is returned. For example: For the enum ADD_PARTY, addParty is returned.
    
    Overrides:
    
    toString in class Enum<CAction>
    
    Returns:
    
    String representation of this enumeration, either lower case or camel case when this enumeration contains underscores.
  - getAction
```
public static CAction getAction(String name)
```
    Gets the enumerated CAction that corresponds with the supplied name.
    For example: CAction action = CAction.getAction("login");
    
    Parameters:
    
    name - Name of the enumerated CAction to get.
    The name should equal the result of one of the CAction's toString() method.
    
    Returns:
    
    The enumerated CAction that corresponds with the supplied name.
    
    Throws:
    
    NullPointerException - When the supplied name is null.
    
    IllegalArgumentException - When the supplied name does not correspond with an existing enumerated CAction.

Enum CAction

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ABORT

ADD

ADD_ALL

ADD_SELECTED

APPLY

BACK

CANCEL

CLEAR

CLOSE

CONTINUE

COPY

CREATE

DELETE

EDIT

FAILURE

FORWARD

IGNORE

LOGIN

LOGOUT

NEW

NEXT

NO

OK

OPEN

PREVIOUS

REMOVE

REMOVE_ALL

REMOVE_SELECTED

RESET

RESTORE

SAVE

SEARCH

SELECT

SUBMIT

SUCCESS

YES

Method Detail

values

valueOf

toString

getAction