Package org.silverpeas.components.suggestionbox.control

# Enum Class SuggestionBoxWebController.ViewContext

java.lang.Object
java.lang.Enum<SuggestionBoxWebController.ViewContext>
org.silverpeas.components.suggestionbox.control.SuggestionBoxWebController.ViewContext

All Implemented Interfaces:
  `Serializable`, `Comparable<SuggestionBoxWebController.ViewContext>`, `Constable`

Enclosing class:
  SuggestionBoxWebController

public static enum SuggestionBoxWebController.ViewContext extends Enum<SuggestionBoxWebController.ViewContext>
A context on the viewing of suggestions. It is used to parametrize the rendering of the suggestions in a JSP.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `AllSuggestions`
  The suggestions to render are all the suggestions in a suggestion box the user can see.
  `MySuggestions`
  The suggestions to render are the suggestions of the current user.
  `PublishedSuggestions`
  The suggestions to render are the suggestions published in a suggestion box.
  `SuggestionsInValidation`
  The suggestions to render are the suggestion awaiting a validation.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static SuggestionBoxWebController.ViewContext`
  `fromIdentifier(String identifier)`
  `static SuggestionBoxWebController.ViewContext`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static SuggestionBoxWebController.ViewContext[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

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

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### AllSuggestions

    public static final SuggestionBoxWebController.ViewContext AllSuggestions
    The suggestions to render are all the suggestions in a suggestion box the user can see.

  - ### PublishedSuggestions

    public static final SuggestionBoxWebController.ViewContext PublishedSuggestions
    The suggestions to render are the suggestions published in a suggestion box.

  - ### SuggestionsInValidation

    public static final SuggestionBoxWebController.ViewContext SuggestionsInValidation
    The suggestions to render are the suggestion awaiting a validation. It can comprise also the suggestions that were refused by a moderator (a publisher).

  - ### MySuggestions

    public static final SuggestionBoxWebController.ViewContext MySuggestions
    The suggestions to render are the suggestions of the current user.

- ## Method Details

  - ### values

    public static SuggestionBoxWebController.ViewContext[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static SuggestionBoxWebController.ViewContext valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### fromIdentifier

    public static SuggestionBoxWebController.ViewContext fromIdentifier(String identifier)