com.ibm.portal.resolver.service
Enum PortletPocService.URI_SCOPE

java.lang.Object
  extended by java.lang.Enum<PortletPocService.URI_SCOPE>
      extended by com.ibm.portal.resolver.service.PortletPocService.URI_SCOPE
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PortletPocService.URI_SCOPE>
Enclosing interface:
PortletPocService

public static enum PortletPocService.URI_SCOPE
extends java.lang.Enum<PortletPocService.URI_SCOPE>

Constants that define the scope of the portlet URI

Since:
6.1.0.3

Enum Constant Summary
PORTLET_DEFINITION
          the URI targets the portlet definition
PORTLET_ENTITY
          the URI targets the portlet entity
PORTLET_WINDOW
          the URI targets the portlet window
SERVLET_DEFINITION
          the URI targets the servlet definition
 
Method Summary
 ObjectType getType()
          Returns the ObjectType that matches the scope
static PortletPocService.URI_SCOPE valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PortletPocService.URI_SCOPE[] 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

PORTLET_DEFINITION

public static final PortletPocService.URI_SCOPE PORTLET_DEFINITION
the URI targets the portlet definition


PORTLET_ENTITY

public static final PortletPocService.URI_SCOPE PORTLET_ENTITY
the URI targets the portlet entity


PORTLET_WINDOW

public static final PortletPocService.URI_SCOPE PORTLET_WINDOW
the URI targets the portlet window


SERVLET_DEFINITION

public static final PortletPocService.URI_SCOPE SERVLET_DEFINITION
the URI targets the servlet definition

Method Detail

values

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

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

valueOf

public static PortletPocService.URI_SCOPE valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getType

public ObjectType getType()
Returns the ObjectType that matches the scope

Returns:
the matching type
Since:
8.5