public interface Gear extends SecuredObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
int |
getAccessLevel() |
java.lang.String |
getAuthor()
Access the author of the gear
|
java.util.Date |
getCreationDate()
Access the creation date of the gear
|
java.lang.String |
getDescription()
Deprecated.
|
java.lang.String |
getDescription(java.util.Locale locale)
Gets the localized description of this gear, 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 instance parameters
|
GearDefinition |
getGearDefinition()
Access the gear definition
|
java.lang.String |
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
|
java.lang.String |
getGearUserParameter(java.lang.String pParam)
Access a named gear instance parameter
|
java.lang.String |
getGearUserParameterDefaultValue(java.lang.String pParam)
Access the default value of the named gear instance parameter
|
java.util.List |
getGearUserParameterDefaultValues(java.lang.String pParam) |
java.lang.String[] |
getGearUserParameterNames()
Access the names of the gear instance parameters
|
java.util.List |
getGearUserParameterValues(java.lang.String prefName) |
java.lang.String |
getId()
Access the id of the gear
|
java.lang.String |
getLargeImageURL()
Access a url to the large image for the Gear
|
java.util.Date |
getLastModified()
Access the last modified date of the gear
|
java.lang.String |
getName()
Deprecated.
|
java.lang.String |
getName(java.util.Locale locale)
Gets the localized name of this gear, returning a default
string if the locale is not recognized.
|
Community |
getParentCommunity()
Access the parent community
|
Portal |
getPortal()
Returns the portal that this gear is associated with.
|
GearHeightEnum |
getPreferredHeight()
Access the preferred height of the gear
|
GearWidthEnum |
getPreferredWidth()
Access the preferred width of the gear
|
Role |
getRole(java.lang.String pName)
Access the Role associated with the supplied name
|
java.security.Principal |
getSecurityPrincipal(java.lang.String pName)
Access the principal associated with the supplied name
|
java.lang.String |
getServletContext()
Access the servlet context of the gear
|
java.lang.String |
getSmallImageURL()
Access a url to the small image for the Gear
|
java.lang.String |
getVersion()
Access the version of the gear
|
boolean |
hasAccess(AccessRight pRight)
Returns true if the current user has the specified access
to the page.
|
boolean |
hasAccess(BaseEnvironment pEnv)
Deprecated.
|
boolean |
hasGearAlertParameter(java.lang.String pParam)
Returns true if the gear has a named alert parameter
|
boolean |
hasGearInstanceParameter(java.lang.String pParam)
Returns true if the gear has a named instance parameter
|
boolean |
hasGearUserParameter(java.lang.String pParam)
Returns true if the gear has a named instance parameter
|
boolean |
hasMode(java.lang.String pGearMode,
java.lang.String pDisplayMode)
True if the Gear has a given gear mode for the given display mode
|
boolean |
hasMode(java.lang.String pGearMode,
java.lang.String pDisplayMode,
java.lang.String pDeviceOutput)
True if the Gear has a given gear mode for the given display mode
and the given deviceOutput
|
boolean |
hasRole(java.lang.String gearRole)
Returns true if the user has the indicated gear role.
|
boolean |
isReadOnlyParameter(java.lang.String pParamName) |
boolean |
isShared()
True if the gear may be shared
|
boolean |
isShowTitleBars()
True if the gear should display its titlebar
|
void |
setAccessLevel(int pAccessLevel)
Sets the access level of this gear
|
void |
setDescription(java.lang.String pDescription)
Deprecated.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the description of the gear for the given locale.
|
void |
setGearAlertParameter(java.lang.String pParam,
java.lang.String pValue)
Set the gear alert parameter
|
void |
setGearAlertParameterDefaultValue(java.lang.String pParam,
java.lang.String pValue)
Set the default value of the gear instance parameter
|
void |
setGearDefinition(GearDefinition pGearDefinition)
Sets the gearDefinition of this gear
|
void |
setGearInstanceParameter(java.lang.String pParam,
java.lang.String pValue)
Set the gear instance parameter
|
void |
setGearInstanceParameterDefaultValue(java.lang.String pParam,
java.lang.String pValue)
Set the default value of the gear instance parameter
|
void |
setGearUserParameter(java.lang.String pParam,
java.lang.String pValue)
Set the gear instance parameter
|
void |
setGearUserParameterDefaultValue(java.lang.String pParam,
java.lang.String pValue)
Set the default value of the gear instance parameter
|
void |
setGearUserParameterValues(java.lang.String m_name,
java.util.Collection m_values) |
void |
setName(java.lang.String pName)
Deprecated.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the name of the gear for the given locale.
|
void |
setParentCommunity(Community pParentCommunity)
set the parent community of this gear
|
void |
setShared(boolean pShared)
Set if the gear should be shared across communities
|
void |
unshare()
Unshare a shared gear so that its unavailable to
all the other communities but its parent community using
|
getAccessControlList, getOwner, getSecurityContext, setAccessControlList, setOwner, supportsAccessControlList, supportsOwner, unsecuredGetAccessControlList, unsecuredGetContainers, unsecuredGetOwner, unsecuredSetAccessControlList, unsecuredSetOwner
static final java.lang.String CLASS_VERSION
Portal getPortal()
java.lang.String getId()
java.lang.String getName()
getName(Locale)
java.lang.String getName(java.util.Locale locale)
void setName(java.lang.String pName)
setName(String, Locale)
void setName(java.lang.String name, java.util.Locale locale)
name
- locale
- java.lang.String getDescription()
getDescription(Locale)
java.lang.String getDescription(java.util.Locale locale)
void setDescription(java.lang.String pDescription)
setDescription(String, Locale)
void setDescription(java.lang.String description, java.util.Locale locale)
description
- locale
- java.util.Date getCreationDate()
java.util.Date getLastModified()
java.lang.String getAuthor()
java.lang.String getVersion()
boolean isShowTitleBars()
java.lang.String getServletContext()
java.lang.String getSmallImageURL()
java.lang.String getLargeImageURL()
GearWidthEnum getPreferredWidth()
GearHeightEnum getPreferredHeight()
boolean isShared()
void setShared(boolean pShared)
boolean hasMode(java.lang.String pGearMode, java.lang.String pDisplayMode)
pGearMode
- a gear modepDisplayMode
- a display modeboolean hasMode(java.lang.String pGearMode, java.lang.String pDisplayMode, java.lang.String pDeviceOutput)
pGearMode
- a gear modepDisplayMode
- a display modepDeviceOutput
- a device outputCommunity getParentCommunity()
void setParentCommunity(Community pParentCommunity)
GearDefinition getGearDefinition()
GearDefinition
void setGearDefinition(GearDefinition pGearDefinition)
boolean hasGearInstanceParameter(java.lang.String pParam)
pParam
- the name of the parameterjava.lang.String getGearInstanceParameter(java.lang.String pParam)
pParam
- the name of the parametervoid setGearInstanceParameter(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the valuejava.lang.String getGearInstanceParameterDefaultValue(java.lang.String pParam)
pName
- the parameter namevoid setGearInstanceParameterDefaultValue(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the default valuejava.lang.String[] getGearInstanceParameterNames()
boolean hasGearUserParameter(java.lang.String pParam)
pParam
- the name of the parameterjava.lang.String getGearUserParameter(java.lang.String pParam)
pParam
- the name of the parametervoid setGearUserParameter(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the valuevoid setGearUserParameterValues(java.lang.String m_name, java.util.Collection m_values)
m_name
- m_values
- java.lang.String getGearUserParameterDefaultValue(java.lang.String pParam)
pName
- the parameter namejava.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 valuejava.lang.String[] getGearUserParameterNames()
boolean hasGearAlertParameter(java.lang.String pParam)
pParam
- the name of the parameteratg.portal.alert.AlertParameter getGearAlertParameter(java.lang.String pParam)
pParam
- the name of the parametervoid setGearAlertParameter(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the valuejava.lang.String getGearAlertParameterDefaultValue(java.lang.String pParam)
pName
- the parameter namevoid setGearAlertParameterDefaultValue(java.lang.String pParam, java.lang.String pValue)
pParam
- the name of the parameterpValue
- the default valuejava.lang.String[] getGearAlertParameterNames()
int getAccessLevel()
void setAccessLevel(int pAccessLevel)
boolean hasAccess(BaseEnvironment pEnv)
pEnv
- an environmentboolean hasAccess(AccessRight pRight) throws SecurityException
SecurityException
PortalAccessRights
,
PortalAccessRights.PAGE_RIGHTS
boolean hasRole(java.lang.String gearRole)
Role getRole(java.lang.String pName)
pName
- a role namejava.security.Principal getSecurityPrincipal(java.lang.String pName)
pName
- a namevoid unshare() throws PortalException, SecurityException
PortalException
- if there were any errors unsharing the gear.SecurityException
java.util.List getGearUserParameterValues(java.lang.String prefName)
prefName
- boolean isReadOnlyParameter(java.lang.String pParamName)