com.ibm.task.api
Class JspUsageEnum

java.lang.Object
  extended by com.ibm.task.api.JspUsageEnum
All Implemented Interfaces:
java.io.Serializable

public final class JspUsageEnum
extends java.lang.Object
implements java.io.Serializable

This enumeration class defines symbolic constants for JSP usage patterns. These values are to be used when JSP location information is retrieved from a Web client setting.

Since:
6.0 - introduced in 5.1
See Also:
JspLocation, WebClientSetting, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
static JspUsageEnum FAULT
          Symbolic constant for a JSP that displays a fault of a task.
static JspUsageEnum INFO
          Deprecated.  
static JspUsageEnum INPUT
          Symbolic constant for a JSP that displays the input of a task.
static JspUsageEnum INSTANCE
          Deprecated.  
static JspUsageEnum MAP
          Symbolic constant for a JSP that maps task data in a HTML form into the format of the task's output.
static JspUsageEnum OUTPUT
          Symbolic constant for a JSP that displays the output of a task.
static JspUsageEnum PAGE
          Symbolic constant for a JSP that displays all information about a task, including input and output.
static JspUsageEnum TEMPLATE
          Deprecated.  
 
Method Summary
static JspUsageEnum newJspUsageEnum(java.lang.String jspUsageEnum)
          Factory method to create a JspUsageEnum by its string representation.
 java.lang.String toString()
          Returns a string representation of the JspUsageEnum object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

PAGE

public static final JspUsageEnum PAGE
Symbolic constant for a JSP that displays all information about a task, including input and output.

Since:
5.1

INFO

public static final JspUsageEnum INFO
Deprecated. 
Symbolic constant for a JSP that displays information about a task.

Since:
5.1

INPUT

public static final JspUsageEnum INPUT
Symbolic constant for a JSP that displays the input of a task.

Since:
5.1

OUTPUT

public static final JspUsageEnum OUTPUT
Symbolic constant for a JSP that displays the output of a task.

Since:
5.1

MAP

public static final JspUsageEnum MAP
Symbolic constant for a JSP that maps task data in a HTML form into the format of the task's output.

Since:
5.1

TEMPLATE

public static final JspUsageEnum TEMPLATE
Deprecated. 
Symbolic constant for a JSP that displays information about a task template.

Since:
5.1

INSTANCE

public static final JspUsageEnum INSTANCE
Deprecated. 
Symbolic constant for a JSP that displays information about a task instance.

Since:
5.1

FAULT

public static final JspUsageEnum FAULT
Symbolic constant for a JSP that displays a fault of a task.

Since:
5.1
Method Detail

newJspUsageEnum

public static JspUsageEnum newJspUsageEnum(java.lang.String jspUsageEnum)
Factory method to create a JspUsageEnum by its string representation. If the enum passed is not a JspUsageEnum, the default PAGE is set.

Parameters:
jspUsageEnum - The string representation of a JspUsageEnum.
Returns:
JspUsageEnum - The JspUsageEnum object created.
Since:
5.1

toString

public java.lang.String toString()
Returns a string representation of the JspUsageEnum object.

Overrides:
toString in class java.lang.Object
Returns:
String - A string representation of the object.
Since:
5.1