com.sapportals.portal.prt.component
Interface IPortalComponentURI

public interface IPortalComponentURI

An IPortalComponentURI represents an URI that can either change the root context, change the node mode, fire an event to a specific node

Method Summary

java.lang.String	getContextName() Returns the new context name
NodeMode	getNodeMode() Gets the node mode
IPortalRequestEvent	getPortalRequestEvent() Gets the PortalRequestEvent
INode	getTargetNode() Gets the target node or null if none has been set
void	setContextName(java.lang.String newContext) Sets the new context name
void	setNodeMode(NodeMode nodeMode) Sets a node mode
void	setPortalRequestEvent(IPortalRequestEvent portalRequestEvent) Sets the portalRequestEvent, if a target node has been set the toString () will produce an url that fire an event on the targetNode, if a new contextName has been set the event will be fired on the top most Portal Component.
void	setTargetNode(INode targetNode) Sets the target node

Method Detail

setPortalRequestEvent

public void setPortalRequestEvent(IPortalRequestEvent portalRequestEvent)

Sets the portalRequestEvent, if a target node has been set the toString () will produce an url that fire an event on the targetNode, if a new contextName has been set the event will be fired on the top most Portal Component. Otherwise the url will fire the event on the current node

Parameters:

portalRequestEvent, - an IPortalRequestEvent

getPortalRequestEvent

public IPortalRequestEvent getPortalRequestEvent()

Gets the PortalRequestEvent

Returns:

an IPortalRequestEvent or null if none has been set

setContextName

public void setContextName(java.lang.String newContext)

Sets the new context name

Parameters:

newContext, - the new context that will change the prtroot

getContextName

public java.lang.String getContextName()

Returns the new context name

Returns:

the new context name or null if none has been set

setTargetNode

public void setTargetNode(INode targetNode)

Sets the target node

Parameters:

targetNode, - the new targetNode

getTargetNode

public INode getTargetNode()

Gets the target node or null if none has been set

setNodeMode

public void setNodeMode(NodeMode nodeMode)

Sets a node mode

getNodeMode

public NodeMode getNodeMode()

Gets the node mode