org.jasig.portal.url
Enum UrlState

java.lang.Object
  java.lang.Enum<UrlState>
      org.jasig.portal.url.UrlState

All Implemented Interfaces:

Serializable, Comparable<UrlState>

public enum UrlState
extends Enum<UrlState>

Represents the rendering state of the portal, all available states should be enumerated here

Version:

$Revision: 19776 $

Author:

Eric Dalquist

Enum Constant Summary

DETACHED
Rendering a single portlet with portal markup but no portal rendered UI

EXCLUSIVE
Rendering a single portlet where the portlet is responsible for all output, binary output is supported.

LEGACY
Used by legacy content that is not using the new portal URL APIs

MAX
Rendering a single portlet with portal provided UI

NORMAL
Rendering with multiple portlets in the view

Method Summary

static UrlState	valueOf(String name) Returns the enum constant of this type with the specified name.
static UrlState[]	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

NORMAL

public static final UrlState NORMAL

Rendering with multiple portlets in the view

MAX

public static final UrlState MAX

Rendering a single portlet with portal provided UI

DETACHED

public static final UrlState DETACHED

Rendering a single portlet with portal markup but no portal rendered UI

EXCLUSIVE

public static final UrlState EXCLUSIVE

Rendering a single portlet where the portlet is responsible for all output, binary output is supported.

LEGACY

public static final UrlState LEGACY

Used by legacy content that is not using the new portal URL APIs

Method Detail

values

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

Returns:

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

valueOf

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