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

All Known Subinterfaces:

InstanceCustomization, InstanceDefinition

All Known Implementing Classes:

AbstractInstance, AbstractInstanceCustomization, AbstractInstanceDefinition

public interface Instance

A shared portlet instance.

Version:

$Revision: 9574 $

Author:

Julien Viet

Field Summary

static java.lang.String

INSTANCE_ID_ATTRIBUTE The attribute name under which the instance id can be accessed.

Method Summary

void	destroyCustomization(java.lang.String customizationId) Destroy the customization
InstanceContainer	getContainer() Return the container of this object.
InstanceCustomization	getCustomization(java.lang.String customizationId) Return a customization of this instance related to the provided customization id.
LocalizedString	getDisplayName() Return the display name
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	setDisplayName(LocalizedString localizedString) Set the display name
void	setProperties(PropertyChange[] changes) Update the prefs of this instance.

Field Detail

INSTANCE_ID_ATTRIBUTE

static final java.lang.String INSTANCE_ID_ATTRIBUTE

The attribute name under which the instance id can be accessed.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Return the id.

Returns:

the id

getDisplayName

LocalizedString getDisplayName()

Return the display name

Returns:

the display name

setDisplayName

void setDisplayName(LocalizedString localizedString)

Set the display name

Parameters:

localizedString -

getPortlet

Portlet getPortlet()
                   throws PortletInvokerException

Return the runtime metadata for this portlet.

Returns:

the info

Throws:

PortletInvokerException

getContainer

InstanceContainer getContainer()

Return the container of this object.

Returns:

the instance container

invoke

PortletInvocationResponse invoke(PortletInvocation invocation)
                                 throws PortletInvokerException

Invoke the instance

Parameters:

invocation - the invocation

Throws:

PortletInvokerException

getProperties

PropertyMap getProperties()
                          throws PortletInvokerException

Return the instance preferences.

Returns:

the prefs

Throws:

PortletInvokerException

getProperties

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

Return the instance preferences.

Returns:

the prefs

Throws:

PortletInvokerException

setProperties

void setProperties(PropertyChange[] changes)
                   throws PortletInvokerException

Update the prefs of this instance.

Parameters:

changes - the changes

Throws:

PortletInvokerException

getCustomization

InstanceCustomization getCustomization(java.lang.String customizationId)

Return a customization of this instance related to the provided customization id.

Returns:

an instance customization

destroyCustomization

void destroyCustomization(java.lang.String customizationId)

Destroy the customization

Parameters:

customizationId - the id of the customization to destroy