|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.application.definition.PortletDefinition
public class PortletDefinition
This class represents a persistent portlet.
Field Summary | |
---|---|
static byte |
CLONE_BEFORE_WRITE
|
protected PortletInstance |
portletInstance
|
static byte |
READ_ONLY
|
static byte |
READ_WRITE
|
Constructor Summary | |
---|---|
|
PortletDefinition(LocalizationResource localizationResource,
MarkupDefinitionId markupDefinitionId,
String contentUri,
String backingFile,
String definitionLabel,
String instanceLabel,
boolean forkable,
boolean _public,
ThemeDefinitionId themeDefinitionId,
short titlebarOrientation,
boolean defaultMinimized,
boolean renderCacheable,
int cacheExpires,
boolean forkRender,
String portletFile,
boolean deleted,
String helpUri,
String editUri,
String webAppName)
Contructor to create a new PortletDefinition object. |
|
PortletDefinition(LocalizationResource localizationResource,
MarkupDefinitionId markupDefinitionId,
String contentUri,
String backingFile,
String definitionLabel,
String instanceLabel,
boolean forkable,
boolean _public,
ThemeDefinitionId themeDefinitionId,
short titlebarOrientation,
boolean defaultMinimized,
boolean renderCacheable,
int cacheExpires,
boolean forkRender,
String portletFile,
boolean deleted,
String helpUri,
String editUri,
String webAppName,
String producerHandle,
String portletHandle,
byte stateChangeFlag,
boolean requiresUrlTemplates,
boolean templatesStoredInSession,
byte[] portletState,
boolean producerOfferedPortlet)
Overloaded constructor |
protected |
PortletDefinition(MarkupDefinitionId markupDefinitionId,
String contentUri,
String backingFile,
boolean forkable,
boolean _public,
boolean renderCacheable,
int cacheExpires,
boolean forkRender,
String portletFile,
boolean deleted,
String helpUri,
String editUri,
String definitionLabel,
String webAppName,
PortletInstance portletInstance)
Overloaded constructor that takes a PortletInstance . |
protected |
PortletDefinition(MarkupDefinitionId markupDefinitionId,
String contentUri,
String backingFile,
boolean forkable,
boolean _public,
boolean renderCacheable,
int cacheExpires,
boolean forkRender,
String portletFile,
boolean deleted,
String helpUri,
String editUri,
String definitionLabel,
String webAppName,
PortletInstance portletInstance,
String producerHandle,
String portletHandle,
byte stateChangeFlag,
boolean requiresUrlTemplates,
boolean templatesStoredInSession,
byte[] portletState,
boolean producerOfferedPortlet)
Overloaded constructor |
Method Summary | |
---|---|
String |
getBackingFile()
Returns the name of the backing file for this portlet, if present, null otherwise. |
int |
getCacheExpires()
Getter for cache TTL |
String |
getContentUri()
Returns the content uri for this portlet. |
Date |
getCreatedDate()
Gets the time that this object was created in the database. |
String |
getDefinitionLabel()
Returns the definition label for this portlet. |
String |
getDescription()
Retrieves this portlet's localized description from its LocalizationResource . |
String |
getEditUri()
Getter for the edit content. |
String |
getHelpUri()
Getter for the help content. |
String |
getInstanceLabel()
Returns the instance label for this portlet. |
LocalizationIntersectionId |
getLocalizationIntersectionId()
Returns the LocalizationIntersectionId for this portlet. |
LocalizationResource |
getLocalizationResource()
Returns the LocalizationResource associated with this
PortletDefinition based on the locale of the request used
for retrieving the PortletDefinition . |
MarkupDefinitionId |
getMarkupDefinitionId()
Returns the MarkupDefinitionId for the MarkupDefinition
associated with this portlet. |
Date |
getModifiedDate()
Gets the time that this object was last updated in the database. |
PlaceableDefinitionId |
getPlaceableDefinitionId()
Returns the PlaceableDefinitionId associated with this portlet. |
PlacementId |
getPlacementId()
Returns the PlacementId for this portlet. |
PortletDefinitionId |
getPortletDefinitionId()
Returns the PortletDefinitionId for this portlet. |
String |
getPortletFile()
Getter for returning the relative path of the .portlet file representing this portlet. |
String |
getPortletHandle()
Returns the portlet handle associated with this portlet if it is a WSRP remote portlet, null otherwise. |
byte[] |
getPortletState()
Returns the portlet state for a WSRP remote portlet |
PortletInstanceId |
getPrimaryInstanceId()
Deprecated This method is unreliable as it may return an instance id which is NOT the primary instance! Use: IPortletDefinitionManager.getPortletView(customizationContext, portletDefinitionId.getPortletDefinitionId()).getPortletInstanceId() |
String |
getProducerHandle()
Returns the producer handle associated with this portlet if it is a WSRP remote portlet, null otherwise. |
byte |
getStateChangeFlag()
Returns state change flag associated with this portlet if it is a WSRP remote portlet. |
ThemeDefinitionId |
getThemeDefinitionId()
Returns the ThemeDefinitionId of theme associated with this
PortletDefinition . |
String |
getTitle()
Retrieves this portlet's localized title from its LocalizationResource . |
short |
getTitlebarOrientation()
Returns the titlebar orientation for this PortletDefinition |
int |
getUserPropertiesMode()
Get the WSRP user properties mode. |
String |
getWebAppName()
Returns the name of the J2EE web application this portlet is scoped to. |
boolean |
isDefaultMinimized()
Returns if this portlet is minimized by default. |
boolean |
isDeleted()
Getter to determined if this portet definition has been deleted. |
boolean |
isForkable()
Getter for the boolean indicating if this portlet is forkable. |
boolean |
isForkRender()
Getter for property forkRender. |
boolean |
isProducerOfferedPortlet()
Returns whether a WSRP remote portlet has not been customized by a WSRP consumer |
boolean |
isPublic()
Returns whether this portlet is end-user created. |
boolean |
isRenderCacheable()
Getter for property renderCacheable. |
boolean |
isRequiresUrlTemplates()
Returns whether a WSRP remote portlet requires url templates |
boolean |
isTemplatesStoredInSession()
Returns whether url templates are stored in the HttpSession for a WSRP remote portlet |
void |
setBackingFile(String backingFile)
Sets the backing file for this portlet. |
void |
setCacheExpires(int cacheExpires)
Setter for the cache TTL. |
void |
setContentUri(String contentUri)
Sets the content uri for this portlet. |
void |
setDefaultMinimized(boolean defaultMinimized)
Sets whether this portlet is default minimized. |
void |
setDefinitionLabel(String definitionLabel)
Sets the definition label for this portlet. |
void |
setDeleted(boolean deleted)
Getter to determined if this portet definition has been deleted. |
void |
setEditUri(String editUri)
Setter for the edit content. |
void |
setForkable(boolean forkable)
setter for the boolean indicating if this portlet is forkable. |
void |
setForkRender(boolean forkRender)
Setter for property forkRender. |
void |
setHelpUri(String helpUri)
Setter for the help content. |
void |
setInstanceLabel(String instanceLabel)
Sets the instance label for this portlet. |
void |
setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this portlet. |
void |
setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
Sets the MarkupDefinitionId for this portlet. |
void |
setPortletFile(String portletFile)
Setter for setting the relative path of the .portlet file representing this portlet. |
void |
setPortletHandle(String portletHandle)
Sets the portlet handle for this portlet |
void |
setPortletState(byte[] portletState)
Sets the portlet state for a WSRP remote portlet |
void |
setProducerHandle(String producerHandle)
Sets the producer handle for this portlet |
void |
setProducerOfferedPortlet(boolean producerOfferedPortlet)
Sets whether a WSRP remote portlet is customized by a WSRP consumer |
void |
setPublic(boolean _public)
Sets whether this portlet is end-user created. |
void |
setRenderCacheable(boolean renderCacheable)
Setter for property renderCacheable. |
void |
setRequiresUrlTemplates(boolean requiresUrlTemplates)
Sets whether a WSRP remote portlet requires url templates |
void |
setStateChangeFlag(byte stateChangeFlag)
Sets state change flag |
void |
setTemplatesStoredInSession(boolean templatesStoredInSession)
Sets whether url templates are stored in the HttpSession for a WSRP remote portlet |
void |
setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
Associates a theme with this portlet. |
void |
setTitlebarOrientation(short titlebarOrientation)
Sets the titlebar orientation for this portlet |
void |
setUserPropertiesMode(int mode)
Set the WSRP user properties mode. |
void |
setWebAppName(String webAppName)
Scopes this portlet to specified J2EE web application |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected PortletInstance portletInstance
public static final byte READ_ONLY
public static final byte CLONE_BEFORE_WRITE
public static final byte READ_WRITE
Constructor Detail |
---|
public PortletDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String contentUri, String backingFile, String definitionLabel, String instanceLabel, boolean forkable, boolean _public, ThemeDefinitionId themeDefinitionId, short titlebarOrientation, boolean defaultMinimized, boolean renderCacheable, int cacheExpires, boolean forkRender, String portletFile, boolean deleted, String helpUri, String editUri, String webAppName)
PortletDefinition
object.
localizationResource
- localized title and descriptionmarkupDefinitionId
- reference to a persisted MarkupDefinition
that specifies the markup for this portletcontentUri
- uri that represents the content of this portletbackingFile
- name of the backing file for this portlet, if anydefinitionLabel
- uniquely identifies this portlet in
non-persistent modeinstanceLabel
- uniquely identifies an instance of this portlet
when there exist multiple instances of the sameforkable
- _public
- if this portlet was created by an end-userthemeDefinitionId
- reference to a persisted ThemeDefinition
that is the theme for this portlettitlebarOrientation
- orientation of the titlebar as defined by
PortletView.ORIENTATION_LEFT
PortletView.ORIENTATION_RIGHT
PortletView.ORIENTATION_TOP
PortletView.ORIENTATION_BOTTOM
defaultMinimized
- if this portlet is minimized by defaultrenderCacheable
- if this portlet may be cached in the render cachecacheExpires
- forkRender
- portletFile
- path to the portlet file. This path is relative to the
web application contextdeleted
- if this portlet has been deletedhelpUri
- uri to the help mode content for this portleteditUri
- uri to the edit mode content for this portletwebAppName
- name of the J2EE web application this portlet is
scoped toprotected PortletDefinition(MarkupDefinitionId markupDefinitionId, String contentUri, String backingFile, boolean forkable, boolean _public, boolean renderCacheable, int cacheExpires, boolean forkRender, String portletFile, boolean deleted, String helpUri, String editUri, String definitionLabel, String webAppName, PortletInstance portletInstance)
PortletInstance
.
markupDefinitionId
- reference to a persisted MarkupDefinition
that specifies the markup for this portletcontentUri
- uri that represents the content of this portletbackingFile
- name of the backing file for this portlet, if anyforkable
- _public
- if this portlet was created by an end-userrenderCacheable
- if this portlet may be cached in the render cachecacheExpires
- forkRender
- portletFile
- path to the portlet file. This path is relative to the
web application contextdeleted
- if this portlet has been deletedhelpUri
- uri to the help mode content for this portleteditUri
- uri to the edit mode content for this portletdefinitionLabel
- uniquely identifies this portlet in
non-persistent modewebAppName
- name of the J2EE web application this portlet is
scoped toportletInstance
- public PortletDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String contentUri, String backingFile, String definitionLabel, String instanceLabel, boolean forkable, boolean _public, ThemeDefinitionId themeDefinitionId, short titlebarOrientation, boolean defaultMinimized, boolean renderCacheable, int cacheExpires, boolean forkRender, String portletFile, boolean deleted, String helpUri, String editUri, String webAppName, String producerHandle, String portletHandle, byte stateChangeFlag, boolean requiresUrlTemplates, boolean templatesStoredInSession, byte[] portletState, boolean producerOfferedPortlet)
localizationResource
- localized title and descriptionmarkupDefinitionId
- reference to a persisted MarkupDefinition
that specifies the markup for this portletcontentUri
- uri that represents the content of this portletbackingFile
- name of the backing file for this portlet, if anydefinitionLabel
- uniquely identifies this portlet in
non-persistent modeinstanceLabel
- uniquely identifies an instance of this portlet
when there exist multiple instances of the sameforkable
- _public
- if this portlet was created by an end-userthemeDefinitionId
- reference to a persisted ThemeDefinition
that is the theme for this portlettitlebarOrientation
- orientation of the titlebar as defined by
PortletView.ORIENTATION_LEFT
PortletView.ORIENTATION_RIGHT
PortletView.ORIENTATION_TOP
PortletView.ORIENTATION_BOTTOM
defaultMinimized
- if this portlet is minimized by defaultrenderCacheable
- if this portlet may be cached in the render cachecacheExpires
- forkRender
- portletFile
- path to the portlet file. This path is relative to the
web application contextdeleted
- if this portlet has been deletedhelpUri
- uri to the help mode content for this portleteditUri
- uri to the edit mode content for this portletwebAppName
- name of the J2EE web application this portlet is
scoped toproducerHandle
- producer handle for the WSRP producer that offers portlet
(specific to WSRP remote portlets)portletHandle
- portlet handle of this portlet,
(specific to WSRP remote portlets)stateChangeFlag
- state change flag,
(specific to WSRP remote portlets)requiresUrlTemplates
- whether this portlet requires url templates
(specific to WSRP remote portlets)templatesStoredInSession
- whether the url templates are stored in the HttpSession
(specific to WSRP remote portlets)portletState
- the portlet state
(specific to WSRP remote portlets)producerOfferedPortlet
- if this remote portlet has not been customized by the
WSRP consumer
(specific to WSRP remote portlets)protected PortletDefinition(MarkupDefinitionId markupDefinitionId, String contentUri, String backingFile, boolean forkable, boolean _public, boolean renderCacheable, int cacheExpires, boolean forkRender, String portletFile, boolean deleted, String helpUri, String editUri, String definitionLabel, String webAppName, PortletInstance portletInstance, String producerHandle, String portletHandle, byte stateChangeFlag, boolean requiresUrlTemplates, boolean templatesStoredInSession, byte[] portletState, boolean producerOfferedPortlet)
markupDefinitionId
- reference to a persisted MarkupDefinition
that specifies the markup for this portletcontentUri
- uri that represents the content of this portletbackingFile
- name of the backing file for this portlet, if anyforkable
- _public
- if this portlet was created by an end-userrenderCacheable
- if this portlet may be cached in the render cachecacheExpires
- forkRender
- portletFile
- path to the portlet file. This path is relative to the
web application contextdeleted
- if this portlet has been deletedhelpUri
- uri to the help mode content for this portleteditUri
- uri to the edit mode content for this portletdefinitionLabel
- uniquely identifies this portlet in
non-persistent modewebAppName
- name of the J2EE web application this portlet is
scoped toportletInstance
- producerHandle
- producer handle for the WSRP producer that offers portlet
(specific to WSRP remote portlets)portletHandle
- portlet handle of this portlet,
(specific to WSRP remote portlets)stateChangeFlag
- state change flag,
(specific to WSRP remote portlets)requiresUrlTemplates
- whether this portlet requires url templates
(specific to WSRP remote portlets)templatesStoredInSession
- whether the url templates are stored in the HttpSession
(specific to WSRP remote portlets)portletState
- the portlet state
(specific to WSRP remote portlets)producerOfferedPortlet
- if this remote portlet has not been customized by the
WSRP consumer
(specific to WSRP remote portlets)Method Detail |
---|
public PlaceableDefinitionId getPlaceableDefinitionId()
PlaceableDefinitionId
associated with this portlet.
Returns null when the PortletDefinition has not been retrieved
by using the persistence API.
getPlaceableDefinitionId
in interface PlaceableDefinition
PlaceableDefinitionId
associated with this portletPlaceableDefinition
public PortletDefinitionId getPortletDefinitionId()
PortletDefinitionId
for this portlet.
Returns null when the PortletDefinition has not been retrieved
by using the persistence API.
PortletDefinitionId
for this portletpublic PlacementId getPlacementId()
PlacementId
for this portlet.
May be null if this portlet is not placed
or if it has not been retrieved using the persistence API.
PlacementId
for this portletpublic MarkupDefinitionId getMarkupDefinitionId()
MarkupDefinitionId
for the MarkupDefinition
associated with this portlet.
MarkupDefinitionId
MarkupDefinition
public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
MarkupDefinitionId
for this portlet.
markupDefinitionId
- public String getContentUri()
public void setContentUri(String contentUri)
contentUri
- public String getBackingFile()
public void setBackingFile(String backingFile)
backingFile
- public String getDefinitionLabel()
getDefinitionLabel
in interface PlaceableDefinition
public void setDefinitionLabel(String definitionLabel)
definitionLabel
- public boolean isPublic()
public void setPublic(boolean _public)
_public
- public LocalizationResource getLocalizationResource()
LocalizationResource
associated with this
PortletDefinition
based on the locale of the request used
for retrieving the PortletDefinition
.
getLocalizationResource
in interface PlaceableDefinition
LocalizationResource
associated with this portletpublic void setLocalizationResource(LocalizationResource localizationResource)
LocalizationResource
for this portlet.
localizationResource
- public LocalizationIntersectionId getLocalizationIntersectionId()
LocalizationIntersectionId
for this portlet.
Returns null if no LocalizationResource is associated with
this portlet. A LocalizationIntersectionId
is a reference to all
localized versions of title and description for an entity.
LocalizationIntersectionId
for this portletpublic ThemeDefinitionId getThemeDefinitionId()
ThemeDefinitionId
of theme associated with this
PortletDefinition
.
ThemeDefinitionId
public void setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
themeDefinitionId
- of theme associated with this portletpublic short getTitlebarOrientation()
PortletDefinition
public void setTitlebarOrientation(short titlebarOrientation)
titlebarOrientation
- public boolean isDefaultMinimized()
public void setDefaultMinimized(boolean defaultMinimized)
defaultMinimized
- true to set the portlet to minimized by default@Deprecated public PortletInstanceId getPrimaryInstanceId()
IPortletDefinitionManager.getPortletView(customizationContext, portletDefinitionId.getPortletDefinitionId()).getPortletInstanceId()
PortletInstanceId
getPortletDefinitionId()
,
IPortletDefinitionManager.getPortletView(com.bea.netuix.application.manager.CustomizationContext, PortletDefinitionId)
,
PortletView.getPortletInstanceId()
public String getInstanceLabel()
public void setInstanceLabel(String instanceLabel)
instanceLabel
- public String getTitle()
LocalizationResource
.
getTitle
in interface PlaceableDefinition
public String getDescription()
LocalizationResource
.
getDescription
in interface PlaceableDefinition
public boolean isRenderCacheable()
public void setRenderCacheable(boolean renderCacheable)
renderCacheable
- true if the portlet can be cached.public int getCacheExpires()
public void setCacheExpires(int cacheExpires)
cacheExpires
- number of seconds before the cache expires.public boolean isForkRender()
public void setForkRender(boolean forkRender)
forkRender
- true mean we will fork (multithred) the renderer.public boolean isForkable()
public void setForkable(boolean forkable)
forkable
- true if this portlet can be forked.public String getPortletFile()
public void setPortletFile(String portletFile)
portletFile
- the relative path name of the .portlet file.public boolean isDeleted()
Getter to determined if this portet definition has been deleted. This is set by the system if the .portlet file has been removed from the file system. Because the consequences of deleting the portletDefinition and all its instances would be a costly and perminent, we just mark the portlet definition as being deleted and then the admin can permanently delete it via his admin tools.
public void setDeleted(boolean deleted)
deleted
- true if the portlet has been marked deleted.public String getHelpUri()
Getter for the help content. The Help uri is the uri to the JSP or HTML page to be displayed when the portlet is in help mode.
public void setHelpUri(String helpUri)
Setter for the help content. The Help uri is the uri to the JSP or HTML page to be displayed when the portlet is in help mode.
helpUri
- a relative path to the JSP or html page.public String getEditUri()
Getter for the edit content. The Edit uri is the uri to the JSP or HTML page to be displayed when the portlet is in edit mode.
public void setEditUri(String editUri)
Setter for the edit content. The Edit uri is the uri to the JSP or HTML page to be displayed when the portlet is in edit mode.
editUri
- a relative path to the JSP or html page.public String getWebAppName()
getWebAppName
in interface PlaceableDefinition
public void setWebAppName(String webAppName)
webAppName
- name of the web application to scope this portlet topublic String getProducerHandle()
public void setProducerHandle(String producerHandle)
producerHandle
- public String getPortletHandle()
public void setPortletHandle(String portletHandle)
portletHandle
- public byte getStateChangeFlag()
public void setStateChangeFlag(byte stateChangeFlag)
stateChangeFlag
- public boolean isRequiresUrlTemplates()
public void setRequiresUrlTemplates(boolean requiresUrlTemplates)
requiresUrlTemplates
- public boolean isTemplatesStoredInSession()
public void setTemplatesStoredInSession(boolean templatesStoredInSession)
templatesStoredInSession
- public byte[] getPortletState()
public void setPortletState(byte[] portletState)
portletState
- public boolean isProducerOfferedPortlet()
public void setProducerOfferedPortlet(boolean producerOfferedPortlet)
producerOfferedPortlet
- public int getUserPropertiesMode()
public void setUserPropertiesMode(int mode)
public Date getCreatedDate()
getCreatedDate
in interface DateableDefinition
public Date getModifiedDate()
getModifiedDate
in interface DateableDefinition
public String toString()
toString
in class Object
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |