org.gatein.pc.api

Enum PortletStatus

java.lang.Object

java.lang.Enum<PortletStatus>

org.gatein.pc.api.PortletStatus

All Implemented Interfaces:

Serializable, Comparable<PortletStatus>

public enum PortletStatus
extends Enum<PortletStatus>

The status of the relationship of a portlet with an invoker.

Version:

$Revision$

Author:

Julien Viet

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANAGED A portlet is managed by the PortletInvoker when the invoker is able to perform any operation on it.
OFFERED A portlet part of the set of exposed portlets as returned by PortletInvoker.getPortlets().

Method Summary

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

MANAGED

public static final PortletStatus MANAGED

A portlet is managed by the PortletInvoker when the invoker is able to perform any operation on it.

OFFERED

public static final PortletStatus OFFERED

A portlet part of the set of exposed portlets as returned by PortletInvoker.getPortlets().

Method Detail

values

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

Returns:

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

valueOf

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