|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GearDefinition
Represents a gear definition
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Method Summary | |
---|---|
void |
addGearAlertParameter(atg.portal.alert.AlertParameter pGearAlertParameter)
Add the the parameter to the gear alert parameters property |
void |
addGearInstanceParameter(GearParameter pGearInstanceParameter)
Add the the parameter to the gear instance parameters property |
void |
addGearUserParameter(GearParameter pGearUserParameter)
Add the the parameter to the gear user parameters property |
java.lang.String |
getAuthor()
|
java.lang.String[] |
getCacheKeyProperties()
The names of properties used to make up the cache key |
long |
getCacheTimeout()
|
java.util.Date |
getCreationDate()
|
java.lang.String |
getDescription()
|
java.lang.String |
getDescription(java.util.Locale locale)
Gets the localized description of this gear definition, returning a default string if the locale is not recognized. |
atg.portal.alert.AlertParameter |
getGearAlertParameter(java.lang.String pParam)
Access a named gear alert parameter |
java.lang.String |
getGearAlertParameterDefaultValue(java.lang.String pParam)
Access the default value of the named gear alert parameter |
java.lang.String[] |
getGearAlertParameterNames()
Access the names of the gear alert parameters |
atg.portal.alert.AlertParameter[] |
getGearAlertParameters()
Access all the gear alert parameters |
GearParameter |
getGearInstanceParameter(java.lang.String pParam)
Access a named gear instance parameter |
java.lang.String |
getGearInstanceParameterDefaultValue(java.lang.String pParam)
Access the default value of the named gear instance parameter |
java.lang.String[] |
getGearInstanceParameterNames()
Access the names of the gear instance parameters |
GearParameter[] |
getGearInstanceParameters()
Access all the gear instance parameters |
GearMode |
getGearMode()
Get the gear mode property |
GearMode |
getGearMode(java.lang.String pGearMode)
Access a named gear mode from the gear definition |
GearMode[] |
getGearModes()
Access all gear modes |
atg.portal.framework.RelativeRoleManager |
getGearRoleManager()
Returns the role manager for this gear definition. |
GearParameter |
getGearUserParameter(java.lang.String pParam)
Access a named gear user parameter |
java.lang.String |
getGearUserParameterDefaultValue(java.lang.String pParam)
Access the default value of the named gear user parameter |
java.util.List |
getGearUserParameterDefaultValues(java.lang.String pParam)
|
java.lang.String[] |
getGearUserParameterNames()
Access the names of the gear user parameters |
GearParameter[] |
getGearUserParameters()
Access all the gear user parameters |
boolean |
getHide()
|
java.lang.String |
getId()
|
boolean |
getInterceptErrors()
|
java.lang.String |
getLargeImageURL()
|
java.util.Date |
getLastModified()
|
java.lang.String |
getName()
|
java.lang.String |
getName(java.util.Locale locale)
Gets the localized name of this gear definition, returning a default string if the locale is not recognized. |
Portal |
getPortal()
Returns the portal that this gear definition is associated with. |
java.lang.String |
getPortletGUID()
Returns the Portlet's GUID, if this is a JSR168 portlet. |
GearHeightEnum |
getPreferredHeight()
|
GearWidthEnum |
getPreferredWidth()
|
boolean |
getRenderAsynchronously()
|
long |
getRenderingTimeout()
|
java.lang.String |
getServletContext()
|
boolean |
getShouldCache()
|
boolean |
getShouldCoverErrorsWithCache()
|
java.lang.String |
getSmallImageURL()
|
java.lang.String |
getVersion()
|
boolean |
hasGearAlertParameter(java.lang.String pParam)
Returns true if the gear definition has a named alert parameter |
boolean |
hasGearInstanceParameter(java.lang.String pParam)
Returns true if the gear definition has a named instance parameter |
boolean |
hasGearMode(java.lang.String pGearMode)
Returns true if this gear definition has a named gear mode |
boolean |
hasGearUserParameter(java.lang.String pParam)
Returns true if the gear definition has a named user parameter |
boolean |
hasUniqueName()
Returns true if this is the only gear definition with this name |
boolean |
isJSR168()
Returns whether this gear is a JSR168 Portlet. |
void |
setAuthor(java.lang.String pAuthor)
Set the author property |
void |
setCacheKeyProperties(java.lang.String[] pCacheKeyProperties)
Set the CacheKeyProperties property |
void |
setCacheTimeout(long pCacheTimeout)
Set the cacheTimeout property |
void |
setDescription(java.lang.String pDescription)
Set the description property |
void |
setDescription(java.lang.String pDescription,
java.util.Locale pLocale)
|
void |
setDescription(java.lang.String pDescription,
java.lang.String pLocaleString)
|
void |
setGearAlertParameterDefaultValue(java.lang.String pParam,
java.lang.String pValue)
Set the default value of the gear alert parameter |
void |
setGearAlertParameters(atg.portal.alert.AlertParameter[] pGearAlertParameters)
Set the alert parameters property |
void |
setGearInstanceParameterDefaultValue(java.lang.String pParam,
java.lang.String pValue)
Set the default value of the gear instance parameter |
void |
setGearInstanceParameters(GearParameter[] pGearInstanceParameters)
Set the gear instance parameters property |
void |
setGearMode(GearMode pGearMode)
Set the gear mode property |
void |
setGearUserParameterDefaultValue(java.lang.String pParam,
java.lang.String pValue)
Set the default value of the gear user parameter |
void |
setGearUserParameterDefaultValues(java.lang.String m_name,
java.util.Collection m_values)
|
void |
setGearUserParameters(GearParameter[] pGearUserParameters)
Set the gear user parameters property |
void |
setHide(boolean pHide)
Set the hide property |
void |
setImage(java.lang.String pProperty,
java.lang.String pValue)
Set an image property |
void |
setInterceptErrors(boolean pInterceptErrors)
Set the interceptErrors property |
void |
setLargeImageURL(java.lang.String pLargeImageURL)
Set the large image URL property |
void |
setName(java.lang.String pName)
Set the name property |
void |
setName(java.lang.String pName,
java.util.Locale pLocale)
|
void |
setName(java.lang.String pDescription,
java.lang.String pLocaleString)
|
void |
setPreferredHeight(java.lang.String pPreferredHeight)
Set the preferredHeight property |
void |
setPreferredWidth(java.lang.String pPreferredWidth)
Set the preferredWidth property |
void |
setRenderAsynchronously(boolean pRenderAsynchronously)
Set the renderAsynchronously property |
void |
setRenderingTimeout(long pRenderingTimeout)
Set the renderingTimeout property |
void |
setServletContext(java.lang.String pServletContext)
Set the servletContext property |
void |
setShouldCache(boolean pShouldCache)
Set the shouldCache property |
void |
setShouldCoverErrorsWithCache(boolean pShouldCoverErrorsWithCache)
Set the shouldCoverErrorsWithCache property |
void |
setSmallImageURL(java.lang.String pSmallImageURL)
Set the small image URL property |
void |
setVersion(java.lang.String pVersion)
Set the version property |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
Portal getPortal()
java.lang.String getId()
boolean isJSR168()
java.lang.String getPortletGUID()
java.lang.String getName()
boolean hasUniqueName()
void setName(java.lang.String pName)
a
- namevoid setName(java.lang.String pDescription, java.lang.String pLocaleString)
void setName(java.lang.String pName, java.util.Locale pLocale)
java.lang.String getName(java.util.Locale locale)
java.lang.String getDescription()
void setDescription(java.lang.String pDescription)
a
- descriptionvoid setDescription(java.lang.String pDescription, java.lang.String pLocaleString)
void setDescription(java.lang.String pDescription, java.util.Locale pLocale)
java.lang.String getDescription(java.util.Locale locale)
java.util.Date getCreationDate()
java.util.Date getLastModified()
java.lang.String getAuthor()
void setAuthor(java.lang.String pAuthor)
a
- authorjava.lang.String getVersion()
void setVersion(java.lang.String pVersion)
a
- versionboolean getHide()
void setHide(boolean pHide)
a
- hidelong getRenderingTimeout()
void setRenderingTimeout(long pRenderingTimeout)
a
- renderingTimeoutboolean getRenderAsynchronously()
void setRenderAsynchronously(boolean pRenderAsynchronously)
a
- renderAsynchronouslyboolean getShouldCache()
void setShouldCache(boolean pShouldCache)
a
- shouldCachejava.lang.String[] getCacheKeyProperties()
void setCacheKeyProperties(java.lang.String[] pCacheKeyProperties)
a
- cacheKeyPropertieslong getCacheTimeout()
void setCacheTimeout(long pCacheTimeout)
a
- cacheTimeoutboolean getInterceptErrors()
void setInterceptErrors(boolean pInterceptErrors)
a
- interceptErrorsboolean getShouldCoverErrorsWithCache()
void setShouldCoverErrorsWithCache(boolean pShouldCoverErrorsWithCache)
a
- shouldCoverErrorsWithCachejava.lang.String getServletContext()
void setServletContext(java.lang.String pServletContext)
a
- servletContextGearWidthEnum getPreferredWidth()
void setPreferredWidth(java.lang.String pPreferredWidth)
a
- preferredWidthGearHeightEnum getPreferredHeight()
void setPreferredHeight(java.lang.String pPreferredHeight)
a
- preferredHeightjava.lang.String getSmallImageURL()
void setSmallImageURL(java.lang.String pSmallImageURL)
a
- smallImageURLjava.lang.String getLargeImageURL()
void setLargeImageURL(java.lang.String pLargeImageURL)
a
- largeImageURLvoid setImage(java.lang.String pProperty, java.lang.String pValue)
an
- image propertyan
- image urlboolean hasGearMode(java.lang.String pGearMode)
pGearMode
- the name of a gear mode
GearMode getGearMode(java.lang.String pGearMode)
pGearMode
- the name of a gear mode
GearMode[] getGearModes()
void setGearMode(GearMode pGearMode)
a
- gearModeGearMode getGearMode()
boolean hasGearInstanceParameter(java.lang.String pParam)
pParam
- the name of the parameter
GearParameter getGearInstanceParameter(java.lang.String pParam)
pParam
- the name of the parameter
java.lang.String getGearInstanceParameterDefaultValue(java.lang.String pParam)
pName
- the parameter name
void setGearInstanceParameterDefaultValue(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the default valueGearParameter[] getGearInstanceParameters()
void setGearInstanceParameters(GearParameter[] pGearInstanceParameters)
a
- gearInstanceParametersjava.lang.String[] getGearInstanceParameterNames()
void addGearInstanceParameter(GearParameter pGearInstanceParameter)
a
- gearInstanceParameterboolean hasGearUserParameter(java.lang.String pParam)
pParam
- the name of the parameter
java.lang.String getGearUserParameterDefaultValue(java.lang.String pParam)
pName
- the parameter name
java.util.List getGearUserParameterDefaultValues(java.lang.String pParam)
void setGearUserParameterDefaultValue(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the default valuevoid setGearUserParameterDefaultValues(java.lang.String m_name, java.util.Collection m_values)
GearParameter getGearUserParameter(java.lang.String pParam)
pParam
- the name of the parameter
GearParameter[] getGearUserParameters()
java.lang.String[] getGearUserParameterNames()
void setGearUserParameters(GearParameter[] pGearUserParameters)
a
- gearUserParametersvoid addGearUserParameter(GearParameter pGearUserParameter)
a
- gearUserParameterboolean hasGearAlertParameter(java.lang.String pParam)
pParam
- the name of the parameter
java.lang.String getGearAlertParameterDefaultValue(java.lang.String pParam)
pName
- the parameter name
void setGearAlertParameterDefaultValue(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the default valueatg.portal.alert.AlertParameter getGearAlertParameter(java.lang.String pParam)
pParam
- the name of the parameter
atg.portal.alert.AlertParameter[] getGearAlertParameters()
java.lang.String[] getGearAlertParameterNames()
void setGearAlertParameters(atg.portal.alert.AlertParameter[] pGearAlertParameters)
a
- alertParametersvoid addGearAlertParameter(atg.portal.alert.AlertParameter pGearAlertParameter)
a
- gearAlertParameteratg.portal.framework.RelativeRoleManager getGearRoleManager()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |