Instance - JBOSS Portal 2.4 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.core.model.instance
Interface Instance

All Known Implementing Classes:: InstanceImpl

public interface Instance

A shared portlet instance.

Method Summary

InstanceContainer getContainer()
          Return the container of this object.

java.lang.String getId()
          Return the id in the scope of its container.

Portlet getPortlet()
          Return the runtime metadata for this portlet.

java.lang.String getPortletRef()
          Return the portlet id referenced of this instance.

ValueMap getPreferences()
          Return the instance preferences.

void invoke(PortletInvocation invocation)
          Invoke the instance

boolean isModifiable()
          Return true if the instance state can be modified.

void setPreferences(ValueMap prefs)
          Update the prefs of this instance.

Method Detail

getId

public java.lang.String getId()

Return the id in the scope of its container.

Returns:: the instance id

getPortlet

public Portlet getPortlet()
                   throws PortletInvokerException

Return the runtime metadata for this portlet.

Returns:: the info
Throws:: PortletInvokerException

isModifiable

public boolean isModifiable()

Return true if the instance state can be modified.

Returns:: if the instance is modifiable

getContainer

public InstanceContainer getContainer()

Return the container of this object.

Returns:: the instance container

getPortletRef

public java.lang.String getPortletRef()

Return the portlet id referenced of this instance.

Returns:: the portlet id referenced by this instance

invoke

public void invoke(PortletInvocation invocation)
            throws PortletInvokerException

Invoke the instance

Parameters:: invocation - the invocation
Throws:: PortletInvokerException

getPreferences

public ValueMap getPreferences()
                        throws PortletInvokerException

Return the instance preferences.

Returns:: the prefs
Throws:: PortletInvokerException

setPreferences

public void setPreferences(ValueMap prefs)
                    throws PortletInvokerException

Update the prefs of this instance.

Parameters:: prefs - the new prefs
Throws:: PortletInvokerException