atg.portal.framework

Interface GearEnvironment

All Superinterfaces:

BaseEnvironment, Environment

public interface GearEnvironment
extends Environment

A GearEnvironment represents the context in which a gear renders. It contains specific data associated with the rendering gear.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
GearDefinition	getGearDefinition() Access the gear definition
java.lang.String	getGearInstanceDefaultValue(java.lang.String pName) Access the default value of the named gear instance parameter
java.lang.String	getGearInstanceParameter(java.lang.String pName) Get the value of a named instance parameter
java.lang.String[]	getGearInstanceParameterNames() Access the names of the gear definition instance parameters
java.util.Map	getGearInstanceParameters() Access the name/value pairs of the gear instance parameters
java.lang.String	getGearMode() Access the name of the gear mode
java.lang.String	getGearUserDefaultValue(java.lang.String pName) Access the default value of the named gear user parameter
java.lang.String	getGearUserParameter(java.lang.String pName) Get the value of a named user parameter
java.lang.String[]	getGearUserParameterNames() Access the names of the gear definition user parameters
java.util.Map	getGearUserParameters() Access the name/value pairs of the gear user parameters
Region	getRegion() Access the region which the gear is rendering
boolean	hasGearInstanceParameter(java.lang.String pName) Test if gear has a named gear instance parameter
boolean	hasGearUserParameter(java.lang.String pName) Test if gear has a named gear user parameter
void	setGearInstanceDefaultValue(java.lang.String pName, java.lang.String pValue) Sets the default value of the named gear instance parameter
void	setGearInstanceParameter(java.lang.String pName, java.lang.String pValue) Set the value of the gear instance parameter with the supplied name
void	setGearUserDefaultValue(java.lang.String pName, java.lang.String pValue) Sets the default value of the named gear user parameter
void	setGearUserParameter(java.lang.String pName, java.lang.String pValue) Set the value of the gear user parameter with the supplied name

Methods inherited from interface atg.portal.framework.Environment

getDisplayMode, getOriginalRequestURI

Methods inherited from interface atg.portal.framework.BaseEnvironment

getAccessDeniedURI, getCommunity, getCommunityFolder, getCommunityURI, getCommunityURI, getGear, getGearDefinitionFolder, getInactiveCommunityURI, getLoginURI, getLoginURI, getLogoutURI, getPage, getPageFolder, getPages, getPageURI, getPageURI, getPortal, getRegistrationSuccessURI, getRegistrationURI, getRequest, getServletContext, getUpdateProfileURI, isGuest, isLeader, isMember, isPortalAdministrator, isRegisteredUser

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getRegion

Region getRegion()

Access the region which the gear is rendering

Returns:

a region

See Also:

Region

getGearMode

java.lang.String getGearMode()

Access the name of the gear mode

Returns:

the gear mode

getGearDefinition

GearDefinition getGearDefinition()

Access the gear definition

Returns:

the gear definition

See Also:

GearDefinition

getGearInstanceParameterNames

java.lang.String[] getGearInstanceParameterNames()

Access the names of the gear definition instance parameters

Returns:

array of gear parameter names

hasGearInstanceParameter

boolean hasGearInstanceParameter(java.lang.String pName)

Test if gear has a named gear instance parameter

Parameters:

pName - the parameter name

Returns:

true if instance parameter exists, false otherwise

getGearInstanceParameter

java.lang.String getGearInstanceParameter(java.lang.String pName)

Get the value of a named instance parameter

Parameters:

pName - the parameter name

Returns:

the value of the instance parameter or null

setGearInstanceParameter

void setGearInstanceParameter(java.lang.String pName,
                              java.lang.String pValue)

Set the value of the gear instance parameter with the supplied name

Parameters:

pName - the parameter name

pValue - the parameter value

getGearInstanceDefaultValue

java.lang.String getGearInstanceDefaultValue(java.lang.String pName)

Access the default value of the named gear instance parameter

Parameters:

pName - the parameter name

Returns:

the default value of the parameter, null if it does not exist

setGearInstanceDefaultValue

void setGearInstanceDefaultValue(java.lang.String pName,
                                 java.lang.String pValue)

Sets the default value of the named gear instance parameter

Parameters:

pName - the parameter name

pValue - the parameter value

getGearUserParameterNames

java.lang.String[] getGearUserParameterNames()

Access the names of the gear definition user parameters

Returns:

array of gear parameter names

hasGearUserParameter

boolean hasGearUserParameter(java.lang.String pName)

Test if gear has a named gear user parameter

Parameters:

pName - the parameter name

Returns:

true if instance parameter exists, false otherwise

getGearUserParameter

java.lang.String getGearUserParameter(java.lang.String pName)

Get the value of a named user parameter

Parameters:

pName - the parameter name

Returns:

the value of the user parameter or null

setGearUserParameter

void setGearUserParameter(java.lang.String pName,
                          java.lang.String pValue)

Set the value of the gear user parameter with the supplied name

Parameters:

pName - the parameter name

pValue - the parameter value

getGearUserDefaultValue

java.lang.String getGearUserDefaultValue(java.lang.String pName)

Access the default value of the named gear user parameter

Parameters:

pName - the parameter name

Returns:

the default value of the parameter, null if it does not exist

setGearUserDefaultValue

void setGearUserDefaultValue(java.lang.String pName,
                             java.lang.String pValue)

Sets the default value of the named gear user parameter

Parameters:

pName - the parameter name

pValue - the parameter value

getGearInstanceParameters

java.util.Map getGearInstanceParameters()

Access the name/value pairs of the gear instance parameters

Returns:

a Map of gear keyed on instance parameter names and values containg the actual value of those parameters(as String)

getGearUserParameters

java.util.Map getGearUserParameters()

Access the name/value pairs of the gear user parameters

Returns:

a Map of gear keyed on user parameter names and values containg the actual value of those parameters(as String)