|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.webaccess.util.ServletDescriptor
Represents a documented WebAccess servlet URI, and its associated properties.
Field Summary | |
static int |
CATEGORY_5250
|
static int |
CATEGORY_COMMAND
|
static int |
CATEGORY_CUSTOMIZE
|
static int |
CATEGORY_DATABASE
|
static int |
CATEGORY_DOWNLOAD
|
static int |
CATEGORY_FILES
|
static int |
CATEGORY_JOBS
|
static int |
CATEGORY_MESSAGES
|
static int |
CATEGORY_OTHER
|
static int |
CATEGORY_PRINT
|
Constructor Summary | |
ServletDescriptor(int category,
java.lang.String uri,
boolean isListServlet,
ServletParameter[] parms,
java.lang.String titleKey,
java.lang.String descriptionKey)
|
Method Summary | |
boolean |
equals(java.lang.Object obj)
|
static int[] |
getCategories()
Returns an array of all known servlet categories. |
int |
getCategory()
Returns the category to which this servlet belongs. |
static java.lang.String |
getCategoryDescription(int category,
java.util.ResourceBundle bundle)
Returns the translated description of the specified category. |
static java.lang.String |
getCategoryTitle(int category,
java.util.ResourceBundle bundle)
Returns the translated title name of the specified category. |
static ServletParameter[] |
getCommonParameters()
Returns the array of common servlet parameters. |
java.lang.String |
getDescription(java.util.ResourceBundle bundle)
Returns the translated description of this servlet. |
ServletParameter[] |
getOptionalParameters()
Returns the array of optional parameters for this servlet, or an empty array if there are none. |
ServletParameter |
getParameter(java.lang.String uri)
Returns the servlet parameter for the given URI, or null if no match was found. |
ServletParameter[] |
getParameters()
Returns the array of parameters for this servlet, or an empty array if there are none. |
ServletParameter[] |
getRequiredParameters()
Returns the array of required parameters for this servlet, or an empty array if there are none. |
java.lang.String |
getTitle(java.util.ResourceBundle bundle)
Returns the translated title name of this servlet. |
java.lang.String |
getTitleKey()
Returns the translated title MRI key of this servlet. |
java.lang.String |
getURI()
Returns the URI string for this servlet, e.g. |
boolean |
isListServlet()
Indicates if this servlet is a WebAccess list servlet or not. |
boolean |
supportsCommonParms()
Indicates if this servlet supports the common parameters. |
void |
supportsCommonParms(boolean supportsCommonParms)
Sets whether this servlet supports the common parameters. |
boolean |
supportsIFramePortlet()
Indicates if this servlet supports being configured by the IFrame portlet. |
void |
supportsIFramePortlet(boolean supportsIFramePortlet)
Sets whether this servlet supports being configured by the IFrame portlet. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int CATEGORY_5250
public static final int CATEGORY_COMMAND
public static final int CATEGORY_CUSTOMIZE
public static final int CATEGORY_DATABASE
public static final int CATEGORY_DOWNLOAD
public static final int CATEGORY_FILES
public static final int CATEGORY_JOBS
public static final int CATEGORY_MESSAGES
public static final int CATEGORY_PRINT
public static final int CATEGORY_OTHER
Constructor Detail |
public ServletDescriptor(int category, java.lang.String uri, boolean isListServlet, ServletParameter[] parms, java.lang.String titleKey, java.lang.String descriptionKey)
Method Detail |
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public static int[] getCategories()
public int getCategory()
public static java.lang.String getCategoryDescription(int category, java.util.ResourceBundle bundle)
public static java.lang.String getCategoryTitle(int category, java.util.ResourceBundle bundle)
public static ServletParameter[] getCommonParameters()
public java.lang.String getDescription(java.util.ResourceBundle bundle)
public ServletParameter getParameter(java.lang.String uri)
public ServletParameter[] getParameters()
public ServletParameter[] getRequiredParameters()
public ServletParameter[] getOptionalParameters()
public java.lang.String getTitle(java.util.ResourceBundle bundle)
public java.lang.String getTitleKey()
public java.lang.String getURI()
public boolean isListServlet()
public boolean supportsCommonParms()
public void supportsCommonParms(boolean supportsCommonParms)
public boolean supportsIFramePortlet()
public void supportsIFramePortlet(boolean supportsIFramePortlet)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |