com.sun.portal.rssportlet
Interface RssPortletConstants

All Known Implementing Classes:
RssPortletHelper

public interface RssPortletConstants

This class provides helper constants for use within the Rss Portlet JSPs. There are several categories of constants:

If the portlet's JSPs are customized, it is important to use the constant markup element names specified in this interface. If these constants are not used, the portlet cannot process form submissions, and Javascript in the JSPs may fail.

Portlet preference name constants are provided for convenience as the JSPs read the preferences when rendering the portlet.

Error parameters are used to pass error information between the portlet class and the edit JSP. Error parameters are set as portlet render parameters. The existence or non-existence of the error parameter is a flag indicating if the error occured. The value of the error parameter may simply be "true", or it may include some information about the error. See descriptions of the error parameters for details.

This API is unstable and changing.


Field Summary
static String CACHE_TIMEOUT_PROP
          Portlet preference name specifying the cache time out value (in seconds).
static String DEFAULT_FEED_PROP
          Portlet preference name specifying the default feed to be used if no other is available.
static String DISABLE_MAX_AGE_PROP
          Portlet preference name specifying if the maximum age of feed entries to display feature should be disabled.
static String FEEDS_PROP
          Portlet preference name for the set of feeds.
static String FILE_NOT_FOUND_ERROR_PARAM
          Error parameter name specifying that the URL entered by the user was not found.
static String INPUT_ADD_FEED
          Markup element name of the "add feed" button in the portlet's edit mode.
static String INPUT_DISABLE_MAX_AGE
          Markup element name for the "disable maximum feed age" check box in the portlet's edit mode.
static String INPUT_FEEDS
          Markup element name of the feeds check box group in the portlet's edit mode.
static String INPUT_MAX_AGE
          Markup element name of the "maximum feed age" text box in the portlet's edit mode
static String INPUT_MAX_ENTRIES
          Markup element name for the "maximum entries" text box in the portlet's edit mode.
static String INPUT_NEWWIN
          Markup element name of the "new window" check box in the portlet's edit mode.
static String INPUT_SELECT_FEED
          Markup element name of the select feed drop down list in the portlet's view mode.
static String INPUT_START_FEED
          Markup element name for the "start feed" drop down list in the portlet's edit mode.
static String MALFORMED_URL_ERROR_PARAM
          Error parameter name specifying that a malformed URL was entered by the user.
static String MAX_AGE_LT_ONE_ERROR_PARAM
          Error parameter name specifying that a numeric value less than one was entered in the "maximum feed age" text box.
static String MAX_AGE_NAN_ERROR_PARAM
          Error parameter name specifying that a non-numeric value was enterd in the "maximum feed age" text box.
static String MAX_AGE_PROP
          Portlet preference name for the maximum age of feed entries to display
static String MAX_DESCRIPTION_LENGTH_PROP
           
static String MAX_ENTRIES_LT_ONE_ERROR_PARAM
          Error parameter name specifying that a numeric value less than one was entered in the "maximum entries" text box.
static String MAX_ENTRIES_NAN_ERROR_PARAM
          Error parameter name specifying that a non-numeric value was entered in the "maximum entries" text box.
static String MAX_ENTRIES_PROP
          Portlet preference name for the maximum number of entries to display.
static String NEWWIN_PROP
          Portlet preference name specifying if a new window should be opened when the user clicks on an entry.
static String START_FEED_PROP
          Portlet preference name for the start feed.
static String SUBMIT_ADD
          Markup element name for the "add new feed" submit button in the portlet's edit mode.
static String SUBMIT_EDIT
          Markup element name for the "finished" button in the portlet's edit mode.
static String SUBMIT_GO
          Markup element name for the "go" button in the portlet's view mode.
static String UNKNOWN_HOST_ERROR_PARAM
          Error parameter name specifying that the URL entered by the user references an unknown host.
 

Field Detail

INPUT_SELECT_FEED

public static final String INPUT_SELECT_FEED
Markup element name of the select feed drop down list in the portlet's view mode.

See Also:
Constant Field Values

INPUT_FEEDS

public static final String INPUT_FEEDS
Markup element name of the feeds check box group in the portlet's edit mode.

See Also:
Constant Field Values

INPUT_ADD_FEED

public static final String INPUT_ADD_FEED
Markup element name of the "add feed" button in the portlet's edit mode.

See Also:
Constant Field Values

INPUT_MAX_AGE

public static final String INPUT_MAX_AGE
Markup element name of the "maximum feed age" text box in the portlet's edit mode

See Also:
Constant Field Values

INPUT_NEWWIN

public static final String INPUT_NEWWIN
Markup element name of the "new window" check box in the portlet's edit mode.

See Also:
Constant Field Values

INPUT_MAX_ENTRIES

public static final String INPUT_MAX_ENTRIES
Markup element name for the "maximum entries" text box in the portlet's edit mode.

See Also:
Constant Field Values

INPUT_DISABLE_MAX_AGE

public static final String INPUT_DISABLE_MAX_AGE
Markup element name for the "disable maximum feed age" check box in the portlet's edit mode.

See Also:
Constant Field Values

INPUT_START_FEED

public static final String INPUT_START_FEED
Markup element name for the "start feed" drop down list in the portlet's edit mode.

See Also:
Constant Field Values

SUBMIT_ADD

public static final String SUBMIT_ADD
Markup element name for the "add new feed" submit button in the portlet's edit mode.

See Also:
Constant Field Values

SUBMIT_EDIT

public static final String SUBMIT_EDIT
Markup element name for the "finished" button in the portlet's edit mode.

See Also:
Constant Field Values

SUBMIT_GO

public static final String SUBMIT_GO
Markup element name for the "go" button in the portlet's view mode.

See Also:
Constant Field Values

FEEDS_PROP

public static final String FEEDS_PROP
Portlet preference name for the set of feeds.

See Also:
Constant Field Values

MAX_ENTRIES_PROP

public static final String MAX_ENTRIES_PROP
Portlet preference name for the maximum number of entries to display.

See Also:
Constant Field Values

MAX_AGE_PROP

public static final String MAX_AGE_PROP
Portlet preference name for the maximum age of feed entries to display

See Also:
Constant Field Values

START_FEED_PROP

public static final String START_FEED_PROP
Portlet preference name for the start feed. The start feed is displayed when the user logs in.

See Also:
Constant Field Values

NEWWIN_PROP

public static final String NEWWIN_PROP
Portlet preference name specifying if a new window should be opened when the user clicks on an entry. Value must be "true" or "false".

See Also:
Constant Field Values

DEFAULT_FEED_PROP

public static final String DEFAULT_FEED_PROP
Portlet preference name specifying the default feed to be used if no other is available. Value must be a URL.

See Also:
Constant Field Values

CACHE_TIMEOUT_PROP

public static final String CACHE_TIMEOUT_PROP
Portlet preference name specifying the cache time out value (in seconds).

See Also:
Constant Field Values

DISABLE_MAX_AGE_PROP

public static final String DISABLE_MAX_AGE_PROP
Portlet preference name specifying if the maximum age of feed entries to display feature should be disabled. Value must be "true" or "false".

See Also:
Constant Field Values

MAX_DESCRIPTION_LENGTH_PROP

public static final String MAX_DESCRIPTION_LENGTH_PROP
See Also:
Constant Field Values

MALFORMED_URL_ERROR_PARAM

public static final String MALFORMED_URL_ERROR_PARAM
Error parameter name specifying that a malformed URL was entered by the user. The value of the error parameter is the malformed URL.

See Also:
Constant Field Values

MAX_AGE_NAN_ERROR_PARAM

public static final String MAX_AGE_NAN_ERROR_PARAM
Error parameter name specifying that a non-numeric value was enterd in the "maximum feed age" text box.

See Also:
Constant Field Values

MAX_AGE_LT_ONE_ERROR_PARAM

public static final String MAX_AGE_LT_ONE_ERROR_PARAM
Error parameter name specifying that a numeric value less than one was entered in the "maximum feed age" text box.

See Also:
Constant Field Values

MAX_ENTRIES_NAN_ERROR_PARAM

public static final String MAX_ENTRIES_NAN_ERROR_PARAM
Error parameter name specifying that a non-numeric value was entered in the "maximum entries" text box.

See Also:
Constant Field Values

MAX_ENTRIES_LT_ONE_ERROR_PARAM

public static final String MAX_ENTRIES_LT_ONE_ERROR_PARAM
Error parameter name specifying that a numeric value less than one was entered in the "maximum entries" text box.

See Also:
Constant Field Values

FILE_NOT_FOUND_ERROR_PARAM

public static final String FILE_NOT_FOUND_ERROR_PARAM
Error parameter name specifying that the URL entered by the user was not found. The value of the error parameter is the non-existence URL.

See Also:
Constant Field Values

UNKNOWN_HOST_ERROR_PARAM

public static final String UNKNOWN_HOST_ERROR_PARAM
Error parameter name specifying that the URL entered by the user references an unknown host. The value of the error parameter is the offending URL.

See Also:
Constant Field Values