com.plumtree.uiinfrastructure.opener
Class RedirectData

java.lang.Object
  com.plumtree.uiinfrastructure.opener.RedirectData

public class RedirectData
extends java.lang.Object

This object is used to encapsulate the destination information for the Common Opener. The destination can be a redirect (allowing us to go to Activity Spaces), or there can be information in the QS arguments. Plugins can use the QS information to perform different actions, such as converting a UUID into a ClassID/ObjectID pair. This object also has a method that allows the Plugin process to be ended prematurely (if multiple Plugins are installed).

Author:

RickyW

Constructor Summary

RedirectData()
Constructor simply initializes members.

Method Summary

void	AddQSArgument(java.lang.String _strKey, boolean _bValue)
void	AddQSArgument(java.lang.String _strKey, int _nValue)
void	AddQSArgument(java.lang.String _strKey, java.lang.Object _oValue)
void	AddQSArgument(java.lang.String _strKey, java.lang.String _strValue) Adds a querystring argument to the Querystring arguments hashtable.
boolean	GetHaltPlugins() Get whether to halt plugin processing.
XPHashtable	GetQSArguments() Get the Querystring arguments.
Redirect	GetRedirect() Get the Redirect destination.
boolean	HasRedirect()
void	SetHaltPlugins(boolean _bHaltPlugins) Set whether to halt plugin processing.
void	SetQSArguments(XPHashtable _htArguments) Set the Querystring arguments.
void	SetRedirect(Redirect _rRedirect) Set the Redirect destination.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedirectData

public RedirectData()

Constructor simply initializes members.

Method Detail

HasRedirect

public boolean HasRedirect()

Returns:

True if there is a Redirect.

GetRedirect

public Redirect GetRedirect()

Get the Redirect destination.

Returns:

Redirect destination.

SetRedirect

public void SetRedirect(Redirect _rRedirect)

Set the Redirect destination.

Parameters:

_rRedirect - Redirect destination.

GetQSArguments

public XPHashtable GetQSArguments()

Get the Querystring arguments.

Returns:

Querystring arguments.

SetQSArguments

public void SetQSArguments(XPHashtable _htArguments)

Set the Querystring arguments.

Parameters:

_htArguments - Querystring arguments.

AddQSArgument

public void AddQSArgument(java.lang.String _strKey,
                          java.lang.String _strValue)

Adds a querystring argument to the Querystring arguments hashtable. If the argument is already there, then it is replaced. If the key or hashtable are null, do nothing.

Parameters:

_strKey - The key to add into the Querystring hashtable.

_strValue - The value to add into the Querystring hashtable.

AddQSArgument

public void AddQSArgument(java.lang.String _strKey,
                          int _nValue)

AddQSArgument

public void AddQSArgument(java.lang.String _strKey,
                          boolean _bValue)

AddQSArgument

public void AddQSArgument(java.lang.String _strKey,
                          java.lang.Object _oValue)

GetHaltPlugins

public boolean GetHaltPlugins()

Get whether to halt plugin processing.

Returns:

True to halt plugin processing.

SetHaltPlugins

public void SetHaltPlugins(boolean _bHaltPlugins)

Set whether to halt plugin processing.

Parameters:

_bHaltPlugins - True to halt plugin processing.