当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

Instance - JBOSS Portal 2.6 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 Subinterfaces:

InstanceCustomization, InstanceDefinition

All Known Implementing Classes:

InstanceCustomizationImpl, InstanceDefinitionImpl, InstanceImpl

---

public interface Instance

A shared portlet instance.

Version:

$Revision: 5448 $

Author:

Julien Viet

---

Method Summary
InstanceContainer	getContainer()           Return the container of this object.
InstanceCustomization	getCustomization(java.lang.String customizationId)           Return a customization.
java.lang.String	getId()           Return the id.
Portlet	getPortlet()           Return the runtime metadata for this portlet.
PropertyMap	getProperties()           Return the instance preferences.
PropertyMap	getProperties(java.util.Set keys)           Return the instance preferences.
PortletInvocationResponse	invoke(PortletInvocation invocation)           Invoke the instance
void	setProperties(PropertyChange[] changes)           Update the prefs of this instance.

 

Method Detail

getId

public java.lang.String getId()

Return the id.

Returns:

the id

---

getPortlet

public Portlet getPortlet()
                   throws PortletInvokerException

Return the runtime metadata for this portlet.

Returns:

the info

Throws:

PortletInvokerException

---

getContainer

public InstanceContainer getContainer()

Return the container of this object.

Returns:

the instance container

---

invoke

public PortletInvocationResponse invoke(PortletInvocation invocation)
                                 throws PortletInvokerException

Invoke the instance

Parameters:

invocation - the invocation

Throws:

PortletInvokerException

---

getProperties

public PropertyMap getProperties()
                          throws PortletInvokerException

Return the instance preferences.

Returns:

the prefs

Throws:

PortletInvokerException

---

getProperties

public PropertyMap getProperties(java.util.Set keys)
                          throws PortletInvokerException

Return the instance preferences.

Returns:

the prefs

Throws:

PortletInvokerException

---

setProperties

public void setProperties(PropertyChange[] changes)
                   throws PortletInvokerException

Update the prefs of this instance.

Parameters:

changes - the changes

Throws:

PortletInvokerException

---

getCustomization

public InstanceCustomization getCustomization(java.lang.String customizationId)

Return a customization.

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---