GearDefinition (ATG Java API)

```
public interface GearDefinition
```
Represents a gear definition

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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
  - CLASS_VERSION
```
static final java.lang.String CLASS_VERSION
```
    Class version string
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPortal
```
Portal getPortal()
```
    Returns the portal that this gear definition is associated with.
  - getId
```
java.lang.String getId()
```
    Returns:
    
    The id of this GearDefinition
  - isJSR168
```
boolean isJSR168()
```
    Returns whether this gear is a JSR168 Portlet.
    
    Returns:
    
    true if the gear is a JSR168 Portlet.
  - getPortletGUID
```
java.lang.String getPortletGUID()
```
    Returns the Portlet's GUID, if this is a JSR168 portlet.
    
    Returns:
  - getName
```
java.lang.String getName()
```
    Returns:
    
    The name of this GearDefinition
  - hasUniqueName
```
boolean hasUniqueName()
```
    Returns true if this is the only gear definition with this name
    
    Returns:
  - setName
```
void setName(java.lang.String pName)
```
    Set the name property
    
    Parameters:
    
    a - name
  - setName
```
void setName(java.lang.String pDescription,
             java.lang.String pLocaleString)
```
  - setName
```
void setName(java.lang.String pName,
             java.util.Locale pLocale)
```
  - 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.
  - getDescription
```
java.lang.String getDescription()
```
    Returns:
    
    The description of this GearDefinition
  - setDescription
```
void setDescription(java.lang.String pDescription)
```
    Set the description property
    
    Parameters:
    
    a - description
  - setDescription
```
void setDescription(java.lang.String pDescription,
                    java.lang.String pLocaleString)
```
  - setDescription
```
void setDescription(java.lang.String pDescription,
                    java.util.Locale pLocale)
```
  - 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.
  - getCreationDate
```
java.util.Date getCreationDate()
```
    Returns:
    
    The creation date of this GearDefinition
  - getLastModified
```
java.util.Date getLastModified()
```
    Returns:
    
    The date of the last modification of this GearDefinition
  - getAuthor
```
java.lang.String getAuthor()
```
    Returns:
    
    The author of this GearDefinition
  - setAuthor
```
void setAuthor(java.lang.String pAuthor)
```
    Set the author property
    
    Parameters:
    
    a - author
  - getVersion
```
java.lang.String getVersion()
```
    Returns:
    
    The version of this GearDefinition
  - setVersion
```
void setVersion(java.lang.String pVersion)
```
    Set the version property
    
    Parameters:
    
    a - version
  - getHide
```
boolean getHide()
```
    Returns:
    
    The hide boolean property
  - setHide
```
void setHide(boolean pHide)
```
    Set the hide property
    
    Parameters:
    
    a - hide
  - getRenderingTimeout
```
long getRenderingTimeout()
```
    Returns:
    
    The rendering timeout property
  - setRenderingTimeout
```
void setRenderingTimeout(long pRenderingTimeout)
```
    Set the renderingTimeout property
    
    Parameters:
    
    a - renderingTimeout
  - getRenderAsynchronously
```
boolean getRenderAsynchronously()
```
    Returns:
    
    The render asynchronous boolean property
  - setRenderAsynchronously
```
void setRenderAsynchronously(boolean pRenderAsynchronously)
```
    Set the renderAsynchronously property
    
    Parameters:
    
    a - renderAsynchronously
  - getShouldCache
```
boolean getShouldCache()
```
    Returns:
    
    The cache boolean property
  - setShouldCache
```
void setShouldCache(boolean pShouldCache)
```
    Set the shouldCache property
    
    Parameters:
    
    a - shouldCache
  - getCacheKeyProperties
```
java.lang.String[] getCacheKeyProperties()
```
    The names of properties used to make up the cache key
    
    Returns:
    
    and array of property names
  - setCacheKeyProperties
```
void setCacheKeyProperties(java.lang.String[] pCacheKeyProperties)
```
    Set the CacheKeyProperties property
    
    Parameters:
    
    a - cacheKeyProperties
  - getCacheTimeout
```
long getCacheTimeout()
```
    Returns:
    
    The cache timeout property
  - setCacheTimeout
```
void setCacheTimeout(long pCacheTimeout)
```
    Set the cacheTimeout property
    
    Parameters:
    
    a - cacheTimeout
  - getInterceptErrors
```
boolean getInterceptErrors()
```
    Returns:
    
    The intercept errors boolean property
  - setInterceptErrors
```
void setInterceptErrors(boolean pInterceptErrors)
```
    Set the interceptErrors property
    
    Parameters:
    
    a - interceptErrors
  - getShouldCoverErrorsWithCache
```
boolean getShouldCoverErrorsWithCache()
```
    Returns:
    
    The cache errors boolean property
  - setShouldCoverErrorsWithCache
```
void setShouldCoverErrorsWithCache(boolean pShouldCoverErrorsWithCache)
```
    Set the shouldCoverErrorsWithCache property
    
    Parameters:
    
    a - shouldCoverErrorsWithCache
  - getServletContext
```
java.lang.String getServletContext()
```
    Returns:
    
    The servlet context property
  - setServletContext
```
void setServletContext(java.lang.String pServletContext)
```
    Set the servletContext property
    
    Parameters:
    
    a - servletContext
  - getPreferredWidth
```
GearWidthEnum getPreferredWidth()
```
    Returns:
    
    The preferred width of this Gear Definition
  - setPreferredWidth
```
void setPreferredWidth(java.lang.String pPreferredWidth)
```
    Set the preferredWidth property
    
    Parameters:
    
    a - preferredWidth
  - getPreferredHeight
```
GearHeightEnum getPreferredHeight()
```
    Returns:
    
    The preferred height of this Gear Definition
  - setPreferredHeight
```
void setPreferredHeight(java.lang.String pPreferredHeight)
```
    Set the preferredHeight property
    
    Parameters:
    
    a - preferredHeight
  - getSmallImageURL
```
java.lang.String getSmallImageURL()
```
    Returns:
    
    The small image URL
  - setSmallImageURL
```
void setSmallImageURL(java.lang.String pSmallImageURL)
```
    Set the small image URL property
    
    Parameters:
    
    a - smallImageURL
  - getLargeImageURL
```
java.lang.String getLargeImageURL()
```
    Returns:
    
    The large image URL
  - setLargeImageURL
```
void setLargeImageURL(java.lang.String pLargeImageURL)
```
    Set the large image URL property
    
    Parameters:
    
    a - largeImageURL
  - setImage
```
void setImage(java.lang.String pProperty,
              java.lang.String pValue)
```
    Set an image property
    
    Parameters:
    
    an - image property
    
    an - image url
  - hasGearMode
```
boolean hasGearMode(java.lang.String pGearMode)
```
    Returns true if this gear definition has a named gear mode
    
    Parameters:
    
    pGearMode - the name of a gear mode
    
    Returns:
    
    true if gear mode exists, false otherwise
  - getGearMode
```
GearMode getGearMode(java.lang.String pGearMode)
```
    Access a named gear mode from the gear definition
    
    Parameters:
    
    pGearMode - the name of a gear mode
    
    Returns:
    
    a gear mode
  - getGearModes
```
GearMode[] getGearModes()
```
    Access all gear modes
    
    Returns:
    
    an array of gear modes
  - setGearMode
```
void setGearMode(GearMode pGearMode)
```
    Set the gear mode property
    
    Parameters:
    
    a - gearMode
  - getGearMode
```
GearMode getGearMode()
```
    Get the gear mode property
    
    Returns:
    
    a gearMode
  - hasGearInstanceParameter
```
boolean hasGearInstanceParameter(java.lang.String pParam)
```
    Returns true if the gear definition has a named instance parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    Returns:
    
    true is parameter exists, false otherwise
  - getGearInstanceParameter
```
GearParameter getGearInstanceParameter(java.lang.String pParam)
```
    Access a named gear instance parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    Returns:
    
    a gear parameter
  - getGearInstanceParameterDefaultValue
```
java.lang.String getGearInstanceParameterDefaultValue(java.lang.String pParam)
```
    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
  - setGearInstanceParameterDefaultValue
```
void setGearInstanceParameterDefaultValue(java.lang.String pParam,
                                          java.lang.String pValue)
```
    Set the default value of the gear instance parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    pValue - the default value
  - getGearInstanceParameters
```
GearParameter[] getGearInstanceParameters()
```
    Access all the gear instance parameters
    
    Returns:
    
    an array of gear parameters
  - setGearInstanceParameters
```
void setGearInstanceParameters(GearParameter[] pGearInstanceParameters)
```
    Set the gear instance parameters property
    
    Parameters:
    
    a - gearInstanceParameters
  - getGearInstanceParameterNames
```
java.lang.String[] getGearInstanceParameterNames()
```
    Access the names of the gear instance parameters
    
    Returns:
    
    an array of gear instance parameter names
  - addGearInstanceParameter
```
void addGearInstanceParameter(GearParameter pGearInstanceParameter)
```
    Add the the parameter to the gear instance parameters property
    
    Parameters:
    
    a - gearInstanceParameter
  - hasGearUserParameter
```
boolean hasGearUserParameter(java.lang.String pParam)
```
    Returns true if the gear definition has a named user parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    Returns:
    
    true is parameter exists, false otherwise
  - getGearUserParameterDefaultValue
```
java.lang.String getGearUserParameterDefaultValue(java.lang.String pParam)
```
    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
  - getGearUserParameterDefaultValues
```
java.util.List getGearUserParameterDefaultValues(java.lang.String pParam)
```
  - setGearUserParameterDefaultValue
```
void setGearUserParameterDefaultValue(java.lang.String pParam,
                                      java.lang.String pValue)
```
    Set the default value of the gear user parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    pValue - the default value
  - setGearUserParameterDefaultValues
```
void setGearUserParameterDefaultValues(java.lang.String m_name,
                                       java.util.Collection m_values)
```
  - getGearUserParameter
```
GearParameter getGearUserParameter(java.lang.String pParam)
```
    Access a named gear user parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    Returns:
    
    a gear parameter
  - getGearUserParameters
```
GearParameter[] getGearUserParameters()
```
    Access all the gear user parameters
    
    Returns:
    
    an array of gear parameters
  - getGearUserParameterNames
```
java.lang.String[] getGearUserParameterNames()
```
    Access the names of the gear user parameters
    
    Returns:
    
    an array of gear user parameter names
  - setGearUserParameters
```
void setGearUserParameters(GearParameter[] pGearUserParameters)
```
    Set the gear user parameters property
    
    Parameters:
    
    a - gearUserParameters
  - addGearUserParameter
```
void addGearUserParameter(GearParameter pGearUserParameter)
```
    Add the the parameter to the gear user parameters property
    
    Parameters:
    
    a - gearUserParameter
  - hasGearAlertParameter
```
boolean hasGearAlertParameter(java.lang.String pParam)
```
    Returns true if the gear definition has a named alert parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    Returns:
    
    true is parameter exists, false otherwise
  - getGearAlertParameterDefaultValue
```
java.lang.String getGearAlertParameterDefaultValue(java.lang.String pParam)
```
    Access the default value of the named gear alert parameter
    
    Parameters:
    
    pName - the parameter name
    
    Returns:
    
    the default value of the parameter, null if it does not exist
  - setGearAlertParameterDefaultValue
```
void setGearAlertParameterDefaultValue(java.lang.String pParam,
                                       java.lang.String pValue)
```
    Set the default value of the gear alert parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    pValue - the default value
  - getGearAlertParameter
```
atg.portal.alert.AlertParameter getGearAlertParameter(java.lang.String pParam)
```
    Access a named gear alert parameter
    
    Parameters:
    
    pParam - the name of the parameter
    
    Returns:
    
    a gear parameter
  - getGearAlertParameters
```
atg.portal.alert.AlertParameter[] getGearAlertParameters()
```
    Access all the gear alert parameters
    
    Returns:
    
    an array of gear alert parameters
  - getGearAlertParameterNames
```
java.lang.String[] getGearAlertParameterNames()
```
    Access the names of the gear alert parameters
    
    Returns:
    
    an array of gear alert parameter names
  - setGearAlertParameters
```
void setGearAlertParameters(atg.portal.alert.AlertParameter[] pGearAlertParameters)
```
    Set the alert parameters property
    
    Parameters:
    
    a - alertParameters
  - addGearAlertParameter
```
void addGearAlertParameter(atg.portal.alert.AlertParameter pGearAlertParameter)
```
    Add the the parameter to the gear alert parameters property
    
    Parameters:
    
    a - gearAlertParameter
  - getGearRoleManager
```
atg.portal.framework.RelativeRoleManager getGearRoleManager()
```
    Returns the role manager for this gear definition.

Interface GearDefinition

Field Summary

Method Summary

Field Detail

CLASS_VERSION

Method Detail

getPortal

getId

isJSR168

getPortletGUID

getName

hasUniqueName

setName

setName

setName

getName

getDescription

setDescription

setDescription

setDescription

getDescription

getCreationDate

getLastModified

getAuthor

setAuthor

getVersion

setVersion

getHide

setHide

getRenderingTimeout

setRenderingTimeout

getRenderAsynchronously

setRenderAsynchronously

getShouldCache

setShouldCache

getCacheKeyProperties

setCacheKeyProperties

getCacheTimeout

setCacheTimeout

getInterceptErrors

setInterceptErrors

getShouldCoverErrorsWithCache

setShouldCoverErrorsWithCache

getServletContext

setServletContext

getPreferredWidth

setPreferredWidth

getPreferredHeight

setPreferredHeight

getSmallImageURL

setSmallImageURL

getLargeImageURL

setLargeImageURL

setImage

hasGearMode

getGearMode

getGearModes

setGearMode

getGearMode

hasGearInstanceParameter

getGearInstanceParameter

getGearInstanceParameterDefaultValue

setGearInstanceParameterDefaultValue

getGearInstanceParameters

setGearInstanceParameters

getGearInstanceParameterNames

addGearInstanceParameter

hasGearUserParameter

getGearUserParameterDefaultValue

getGearUserParameterDefaultValues

setGearUserParameterDefaultValue

setGearUserParameterDefaultValues

getGearUserParameter

getGearUserParameters

getGearUserParameterNames

setGearUserParameters

addGearUserParameter

hasGearAlertParameter

getGearAlertParameterDefaultValue

setGearAlertParameterDefaultValue