|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GearEnvironment
A GearEnvironment represents the context in which a gear renders. It contains specific data associated with the rendering gear.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Method Summary | |
---|---|
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 |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
Region getRegion()
Region
java.lang.String getGearMode()
GearDefinition getGearDefinition()
GearDefinition
java.lang.String[] getGearInstanceParameterNames()
boolean hasGearInstanceParameter(java.lang.String pName)
pName
- the parameter name
java.lang.String getGearInstanceParameter(java.lang.String pName)
pName
- the parameter name
void setGearInstanceParameter(java.lang.String pName, java.lang.String pValue)
pName
- the parameter namepValue
- the parameter valuejava.lang.String getGearInstanceDefaultValue(java.lang.String pName)
pName
- the parameter name
void setGearInstanceDefaultValue(java.lang.String pName, java.lang.String pValue)
pName
- the parameter namepValue
- the parameter valuejava.lang.String[] getGearUserParameterNames()
boolean hasGearUserParameter(java.lang.String pName)
pName
- the parameter name
java.lang.String getGearUserParameter(java.lang.String pName)
pName
- the parameter name
void setGearUserParameter(java.lang.String pName, java.lang.String pValue)
pName
- the parameter namepValue
- the parameter valuejava.lang.String getGearUserDefaultValue(java.lang.String pName)
pName
- the parameter name
void setGearUserDefaultValue(java.lang.String pName, java.lang.String pValue)
pName
- the parameter namepValue
- the parameter valuejava.util.Map getGearInstanceParameters()
java.util.Map getGearUserParameters()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |