atg.portal.framework
Interface GearMode

All Superinterfaces:

atg.portal.framework.BaseProperties, atg.portal.framework.GearModeProperties

public interface GearMode
extends atg.portal.framework.GearModeProperties

Object representing a gear mode

Field Summary

static GearMode	ABOUT About Gear Mode
static java.lang.String	CLASS_VERSION Class version string
static GearMode	CONTENT Content Gear Mode
static GearMode	HELP Help Gear Mode
static GearMode	INITIALCONFIG Initial Configuration Gear Mode
static GearMode	INSTALLCONFIG Install Configuration Gear Mode
static GearMode	INSTANCECONFIG Instance Configuration Gear Mode
static GearMode	PREVIEW Preview Gear Mode
static GearMode	USERCONFIG User Configuration Gear Mode

Fields inherited from interface atg.portal.framework.GearModeProperties

GEARMODE_ABOUT, GEARMODE_CONTENT, GEARMODE_HELP, GEARMODE_INITIALCONFIG, GEARMODE_INSTALLCONFIG, GEARMODE_INSTANCECONFIG, GEARMODE_PREVIEW, GEARMODE_USERCONFIG, ITEM_DESCRIPTOR

Fields inherited from interface atg.portal.framework.BaseProperties

AUTHOR, DESCRIPTION, NAME, SERVLETCONTEXT, VERSION

Method Summary

DisplayMode	getDisplayMode(java.lang.String pDisplayMode) Deprecated.
DisplayMode[]	getDisplayModes() Deprecated.
java.lang.String	getId() Deprecated.
java.lang.String	getName() Access the name of the gear mode
boolean	hasDisplayMode(java.lang.String pDisplayMode) Deprecated.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

CONTENT

static final GearMode CONTENT

Content Gear Mode

HELP

static final GearMode HELP

Help Gear Mode

ABOUT

static final GearMode ABOUT

About Gear Mode

PREVIEW

static final GearMode PREVIEW

Preview Gear Mode

USERCONFIG

static final GearMode USERCONFIG

User Configuration Gear Mode

INSTANCECONFIG

static final GearMode INSTANCECONFIG

Instance Configuration Gear Mode

INITIALCONFIG

static final GearMode INITIALCONFIG

Initial Configuration Gear Mode

INSTALLCONFIG

static final GearMode INSTALLCONFIG

Install Configuration Gear Mode

Method Detail

getId

java.lang.String getId()

Deprecated.

Access the id of the gear mode

Returns:

an id

getName

java.lang.String getName()

Access the name of the gear mode

Returns:

a name

hasDisplayMode

boolean hasDisplayMode(java.lang.String pDisplayMode)

Deprecated.

Returns true is this gear mode has a particuar display mode

Parameters:

pDisplayMode - the name of a display mode

Returns:

true if display mode exists, false otherwise

getDisplayMode

DisplayMode getDisplayMode(java.lang.String pDisplayMode)

Deprecated.

Access a named display mode from the gear mode

Parameters:

pDisplayMode - the name of a display mode

Returns:

a display mode

getDisplayModes

DisplayMode[] getDisplayModes()

Deprecated.

Access all display modes

Returns:

an array of display modes