org.jasig.portal
Class Constants

java.lang.Object
  org.jasig.portal.Constants

public class Constants
extends Object

Houses constants used in the portal code base. Developers, any constants added here should be clearly documented.

Version:

$Revision: 19776 $

Author:

Mark Boyd mark.boyd@engineer.com

Field Summary

static String	AUTO_PUBLISH_CATEGORY The name of a category into which automatically published channels from a channel archive are placed.
static String	FNAME_PARAM The query parameter name that can be appended to a baseActionUrl along with its value, the fname of a channel, to cause an instance of that channel to appear in focused mode without the user having to subcribe to that channel.
static String	LOCALES_PARAM The request parameter name that can be appended to a baseActionURL along with its value, the locales to which the portal should assign priority.
static String	NAVIGATION_CHAN_FNAME The default functional name of the administrative links channel.
static String	TEMPLATE_USER_NAME_ATT The attribute used to convey a custom template account from which to copy the initial layout for a user.
static String	UPORTAL_2_DTD_PREFIX The prefix of DTDs owned by uPortal version 2.0.

Constructor Summary

Constants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FNAME_PARAM

public static final String FNAME_PARAM

The query parameter name that can be appended to a baseActionUrl along with its value, the fname of a channel, to cause an instance of that channel to appear in focused mode without the user having to subcribe to that channel. Examples are infrastructure channels like CChannelManager and CUserPreferences. They don't reside in a user's layout but are merged in via the fname functionality as needed.

See Also:

Constant Field Values

LOCALES_PARAM

public static final String LOCALES_PARAM

The request parameter name that can be appended to a baseActionURL along with its value, the locales to which the portal should assign priority. These locales will be a priority for the remainder of a user's session. The value of this parameter should be a comma-delimited list of locale codes. For example, en_US,ja_JP,de_DE

See Also:

Constant Field Values

AUTO_PUBLISH_CATEGORY

public static final String AUTO_PUBLISH_CATEGORY

The name of a category into which automatically published channels from a channel archive are placed. It is expected to be found in the root category and if not found during publishing is automatically created.

See Also:

Constant Field Values

NAVIGATION_CHAN_FNAME

public static final String NAVIGATION_CHAN_FNAME

The default functional name of the administrative links channel. This is used by channels designed for being delegated to from the administrative links channel that return to that channel when the user is finished with their functionality. Returning to the links channel is accomplished through the use of a URL obtained from ChannelRuntimeData.getFnameActionUrl passing a functional name. The value of this field can be passed to that method to obtain a URL that will bring that channel into focus.

See Also:

Constant Field Values

UPORTAL_2_DTD_PREFIX

public static final String UPORTAL_2_DTD_PREFIX

The prefix of DTDs owned by uPortal version 2.0. This is used to allow local resolution of uPortal specific DTDs.

See Also:

Constant Field Values

TEMPLATE_USER_NAME_ATT

public static final String TEMPLATE_USER_NAME_ATT

The attribute used to convey a custom template account from which to copy the initial layout for a user.

See Also:

Constant Field Values

Constructor Detail

Constants

public Constants()