|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletView
View class for a portlet.
"Views" are deep copy immutable objects. Unlike "Definitions" and "Instances" Views cannot be modified by the developer. An Instance or a Definition however can always be obtained from the view. The persistence APIs provide coarse grain and fine grain getters, but only fine grain setters. If you are interested in an object and all its children then retrieve the View, but if you are only interested in the immediate object and don't care about its children then retrieve the Definition.
View
Field Summary | |
---|---|
static String |
CATEGORY_ID_DELIM |
static short |
ORIENTATION_BOTTOM Constant for signifying the titlebar orientation. |
static short |
ORIENTATION_LEFT Constant for signifying the titlebar orientation. |
static short |
ORIENTATION_RIGHT Constant for signifying the titlebar orientation. |
static short |
ORIENTATION_TOP Constant for signifying the titlebar orientation. |
static String[] |
WSRP_USER_PROPERTY_NAMES |
Method Summary | |
---|---|
String |
getBackingFile() Get the path to the backing file for the portlet. |
int |
getCacheExpires() Return the time-to-live in seconds for this portlet. |
int[] |
getCategoryIds() Deprecated use getPortletCategoryDefinitionIds(); |
String |
getContentUri() Getter for the contentUri attribute in the .portlet file. |
String |
getEditUri() Get the URI to the content that should be displayed when this portlet enters edit mode. |
String[] |
getEnabledClientClassifications() Returns a list of classifications for which the Portlet is enabled, meaning the Portal framework will display it if the current request's client classification is found in this list. |
String |
getHelpUri() Get the URI to the content that should be displayed when this portlet enters help mode. |
String |
getInstanceLabel() Return the unique label for this portlet. |
PlacementId |
getPlacementId() Getter for the portlet's placement id. |
PortletCategoryDefinitionId[] |
getPortletCategoryDefinitionIds() Returns the array of portlet category ids that this portlet has been attached to. |
PortletDefinition |
getPortletDefinition() Retrieve the associated PortletDefinition from this Portlet View. |
PortletDefinitionId |
getPortletDefinitionId() Getter for the portlet definition id. |
String |
getPortletFile() Get the file path to the .portlet definition file. |
String |
getPortletHandle() For proxy portlets, returns the portletHandle assigned by the producer. |
PortletInstance |
getPortletInstance() Retrieve the associated PortletInstance from this Portlet View. |
PortletInstanceId |
getPortletInstanceId() Getter for the portlet instance id. |
byte[] |
getPortletState() For proxy portlets, this method returns binary portletState if allocated by the producer. |
Map<String,com.bea.portlet.prefs.Preference> |
getPreferences() Returns preferences, if any. |
String |
getProducerHandle() For proxy portlets, returns the handle of the producer that this portlet is associated with. |
Collection<String> |
getSpecifiedWsrpProperties() Get the specified properties, only valid when wsrpPropertiesMode == PortletDefinition.WSRP_USER_PROPERTIES_MODE__SPECIFIED |
byte |
getStateChangeFlag() For proxy portlets, returns the state change flag. |
short |
getTitlebarOrientation() Returns the titlebars's orientation. |
String |
getWebAppName() Return the name of the webapp that this layout is associated with. |
int |
getWsrpPropertiesMode() Get the properties mode Will be one of PortletDefinition.WSRP_PROPERTIES_MODE__* |
boolean |
isDefaultMinimized() Has this portlet been set to default minimized state? If so this portlet will be minimized upon the first request to the page. |
boolean |
isDeleted() If isDeleted is true then the portlet has been removed from the file system. |
boolean |
isForkable() Can this portlet run in a separate thread? The developer marks this portlet as "forkable" and then either the developer or admin can mark the portlet as being forked via the "isForkRender" attribute. |
boolean |
isForkRender() Should the framework render this portlet in a separate thread? |
boolean |
isProducerOfferedPortlet() |
boolean |
isRenderCacheable() Does this portlet support caching. |
boolean |
isRequiresUrlTemplates() For proxy portlets, returns whether the remote portlet requires URL templates or not. |
boolean |
isTemplatesStoredInSession() For proxy portlets, returns whether the remote portlet stores URL templates in session or not. |
void |
setSpecifiedWsrpProperties(Collection<String> specifiedWsrpProperties) Set the specified properties, only valid when wsrpPropertiesMode == PortletDefinition.WSRP_USER_PROPERTIES_MODE__SPECIFIED |
void |
setWsrpPropertiesMode(int wsrpPropertiesMode) Set the properties mode Must be one of PortletDefinition.WSRP_PROPERTIES_MODE__* |
Methods inherited from interface com.bea.netuix.application.view.PlaceableView |
---|
getDefinitionLabel, getLabel, getLocalizationResourceView, getPlaceableDefinition, getPlaceableInstance, getPlaceholderDefinitionId, getPlaceholderPosition |
Methods inherited from interface com.bea.netuix.application.view.View |
---|
getDescription, getTitle |
Methods inherited from interface com.bea.netuix.application.view.ThemedMarkupBasedView |
---|
getThemeView |
Methods inherited from interface com.bea.netuix.application.view.MarkupBasedView |
---|
getMarkupView |
Methods inherited from interface com.bea.netuix.application.view.View |
---|
getDescription, getTitle |
Field Detail |
---|
static final short ORIENTATION_TOP
static final short ORIENTATION_LEFT
static final short ORIENTATION_RIGHT
static final short ORIENTATION_BOTTOM
static final String CATEGORY_ID_DELIM
static final String[] WSRP_USER_PROPERTY_NAMES
Method Detail |
---|
PortletInstanceId getPortletInstanceId()
Getter for the portlet instance id. The instance id is the primary key value for the portlet instance in the PF_PORTLET_INSTANCE table. A Portlet Definition may have many instances; these instance are created when administrators or users customize their portal. A Portlet Definition always has at least one instance, namely the "primary" instance.
PortletDefinitionId getPortletDefinitionId()
Getter for the portlet definition id. The definition id is the primary key value for the portlet definition in the PF_PORTLET_DEFINITION table. A Portlet Definition may have many instances; these instance are created when administrators or users customize their portal. A Portlet Definition always has at least one instance, namely the "primary" instance.
PlacementId getPlacementId()
Getter for the portlet's placement id. The placement id represents a unique placement of a portlet on a page. Pages may contain books and portlets. If this portlet is placed on a Page then this placement id represents the primary key value of the PF_PLACEMENT.PLACEMENT_ID value in the database. Note: this portlet might not have been placed on a page as it may be placed on another portlet or be the main portlet of the desktop. Also, if this view was obtained directly from the database and not from a parent view object then this value may also be null.
getPlacementId
in interface PlaceableView
PortletInstance getPortletInstance()
Retrieve the associated PortletInstance
from this Portlet View. Portlet Views are immutable but Instances and Definitions are not. Therefore it is often necessary to retrieve the instance from the view in order to update its values and then in turn call the persistence API.
PortletDefinition getPortletDefinition()
Retrieve the associated PortletDefinition
from this Portlet View. Portlet Views are immutable but Instances and Definitions are not. Therefore it is often necessary to retrieve the definition from the view in order to update its values and then in turn call the persistence API.
boolean isDefaultMinimized()
short getTitlebarOrientation()
Returns the titlebars's orientation. The orientation is a hint to the portlet and titlebar skeleton to render the titlebar at the top, left, right or bottom of the portlet. Since this is only a hint to the portlet/titlebar skeleton, if the skeleton does not support it, it will have no effect.
ORIENTATION_TOP, ORIENTATION_LEFT, ORIENTATION_RIGHTT, ORIENTATION_BOTTOM
String getContentUri()
String getBackingFile()
boolean isForkable()
Can this portlet run in a separate thread? The developer marks this portlet as "forkable" and then either the developer or admin can mark the portlet as being forked via the "isForkRender" attribute. Note this attribute alone does not fork the portlet; it only enables it to be forked.
boolean isForkRender()
Should the framework render this portlet in a separate thread?
boolean isRenderCacheable()
int getCacheExpires()
String getPortletFile()
boolean isDeleted()
String getHelpUri()
String getEditUri()
String getInstanceLabel()
String getWebAppName()
String getProducerHandle()
String getPortletHandle()
byte getStateChangeFlag()
boolean isRequiresUrlTemplates()
boolean isTemplatesStoredInSession()
byte[] getPortletState()
String[] getEnabledClientClassifications()
String
returned for each classification corresponds to the "description" attribute in client-classifications.xml.String
for each enabled classification.Map<String,com.bea.portlet.prefs.Preference> getPreferences()
Returns preferences, if any.
Note that an empty return map does not indicate that this portlet does not have preferences.
Currently, this method returns preferences only when this PortletView
is returned via the PortletTokenizer
. At request time, applications should directly use the PreferencePersistenceManager
to retrieve portlet preferences.
PreferencePersistenceManager
@Deprecated
int[] getCategoryIds()
PortletCategoryDefinitionId[] getPortletCategoryDefinitionIds()
Returns the array of portlet category ids that this portlet has been attached to.
PortletCategoryDefinitionId
sboolean isProducerOfferedPortlet()
Collection<String> getSpecifiedWsrpProperties()
PortletDefinition
void setSpecifiedWsrpProperties(Collection<String> specifiedWsrpProperties)
specifiedWsrpProperties
- The specifiedWsrpProperties to set.PortletDefinition
int getWsrpPropertiesMode()
PortletDefinition
void setWsrpPropertiesMode(int wsrpPropertiesMode)
wsrpPropertiesMode
- The wsrpPropertiesMode to set.PortletDefinition
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.