org.jboss.portal.common.invocation
Interface InvocationContext

All Known Subinterfaces:

ActionContext, PortletInvocationContext, RenderContext, ServerInvocationContext

All Known Implementing Classes:

AbstractActionContext, AbstractInvocationContext, AbstractPortletInvocationContext, AbstractRenderContext, ActionContextSupport, ControllerContext, JCRCommandContext, JSFActionContext, JSFRenderContext, PortletInvocationContextSupport, RenderContextSupport, ServerInvocationContextImpl, TestActionContext, TestRenderContext

public interface InvocationContext

Version:

$Revision: 7228 $

Author:

Julien Viet

Method Summary

java.lang.Object	getAttribute(Scope attrScope, java.lang.Object attrKey) Returns an attribute value.
AttributeResolver	getAttributeResolver(Scope attrScope) Return the attribute resolver of this context.
void	removeAttribute(Scope attrScope, java.lang.Object attrKey) Remove an attribute value.
void	setAttribute(Scope attrScope, java.lang.Object attrKey, java.lang.Object attrValue) Update an attribute value.

Method Detail

getAttributeResolver

AttributeResolver getAttributeResolver(Scope attrScope)
                                       throws java.lang.IllegalArgumentException

Return the attribute resolver of this context.

Parameters:

attrScope - the attribute resolver scope

Returns:

the attribute resolver or null if not found

Throws:

java.lang.IllegalArgumentException - if the attribute scope is invalid

getAttribute

java.lang.Object getAttribute(Scope attrScope,
                              java.lang.Object attrKey)
                              throws java.lang.IllegalArgumentException

Returns an attribute value.

Parameters:

attrScope - the attribute scope

attrKey -

Returns:

the attribute value or null if not found

Throws:

java.lang.IllegalArgumentException - if the attribute key or the attribute scope is not valid

setAttribute

void setAttribute(Scope attrScope,
                  java.lang.Object attrKey,
                  java.lang.Object attrValue)
                  throws java.lang.IllegalArgumentException

Update an attribute value.

Parameters:

attrScope - the attribute scope

attrKey -

attrValue - the attribute value

Throws:

java.lang.IllegalArgumentException - if the attribute key or the attribute scope is not valid

removeAttribute

void removeAttribute(Scope attrScope,
                     java.lang.Object attrKey)

Remove an attribute value. If the attribute value is null the resolver must treat the operation as a removal of the attribute.

Parameters:

attrKey -

Throws:

java.lang.IllegalArgumentException - if the attribute key is null or the attribute scope is not valid