org.gatein.pc.api.spi

Interface InstanceContext

public interface InstanceContext

Version:

$Revision: 5448 $

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
AccessMode	getAccessMode() Return the access mode to this portlet instance.
String	getId() Return an id that can differenciate instances.
PortletStateType<?>	getStateType() Returns the state type managed by the consumer.
void	onStateEvent(StateEvent event) A state event occured.

Method Detail

getId

String getId()

Return an id that can differenciate instances.

Returns:

the instance id

getAccessMode

AccessMode getAccessMode()

Return the access mode to this portlet instance.

Returns:

the access mode

onStateEvent

void onStateEvent(StateEvent event)

A state event occured.

Parameters:

event - the event

getStateType

PortletStateType<?> getStateType()

Returns the state type managed by the consumer. If the consumer cannot manage state by itself, then null must be returned.

Returns:

the consumer state type