com.plumtree.uiinfrastructure.opener.types.classtypes
Class UIActivitySpaces

java.lang.Object
  extended by com.plumtree.uiinfrastructure.opener.types.AUIClassTypeDesc
      extended by com.plumtree.uiinfrastructure.opener.types.classtypes.UIActivitySpaces
All Implemented Interfaces:
IClassTypeDesc, IUIClassTypeDesc

public class UIActivitySpaces
extends AUIClassTypeDesc

This psuedo class type represents the ID to use to tell the Common Opener to open Activity Spaces. Although the Common Opener is supposed to open objects, there are places in the Portal that are not related to objects, and thus this class type will allow you to go to those pages.

Author:
RickyW

Field Summary
static java.lang.String QS_ACTIVITY_SPACE_ID
          QueryString paramenter for defining AS ID or to use a cached space.
static java.lang.String QS_ACTIVITY_SPACE_NAME
          QueryString paramenter for defining AS name.
static java.lang.String QS_PARENT_SPACE_ID
          QueryString paramenter for defining parent AS ID.
static java.lang.String QS_PARENT_SPACE_NAME
          QueryString paramenter for defining parent AS name.
static java.lang.String QS_SPACE_ID_CACHED
          QueryString paramenter value for using a cached space.
static java.lang.String UICLASSTYPEDESC_CLASSNAME
          Name that identifies this UIClassTypeDesc
 
Constructor Summary
UIActivitySpaces()
           
 
Method Summary
 java.lang.String GetClassName()
          Returns the class name of the class type.
 ClassTypeEnum GetClassType()
          Returns the class type.
 Redirect GetRedirectViewObject(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
          This method is called by the Common Opener in the view mode.
 
Methods inherited from class com.plumtree.uiinfrastructure.opener.types.AUIClassTypeDesc
GetClassKey, GetDefaultOpenerMode, GetRedirectCreateNew, GetRedirectOpenObject, GetRedirectSearchBrowse, GetRedirectSearchEdit, GetRedirectViewObjectMetaData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UICLASSTYPEDESC_CLASSNAME

public static final java.lang.String UICLASSTYPEDESC_CLASSNAME
Name that identifies this UIClassTypeDesc

See Also:
Constant Field Values

QS_ACTIVITY_SPACE_NAME

public static final java.lang.String QS_ACTIVITY_SPACE_NAME
QueryString paramenter for defining AS name.

See Also:
Constant Field Values

QS_ACTIVITY_SPACE_ID

public static final java.lang.String QS_ACTIVITY_SPACE_ID
QueryString paramenter for defining AS ID or to use a cached space.

See Also:
Constant Field Values

QS_SPACE_ID_CACHED

public static final java.lang.String QS_SPACE_ID_CACHED
QueryString paramenter value for using a cached space.

See Also:
Constant Field Values

QS_PARENT_SPACE_NAME

public static final java.lang.String QS_PARENT_SPACE_NAME
QueryString paramenter for defining parent AS name.

See Also:
Constant Field Values

QS_PARENT_SPACE_ID

public static final java.lang.String QS_PARENT_SPACE_ID
QueryString paramenter for defining parent AS ID.

See Also:
Constant Field Values
Constructor Detail

UIActivitySpaces

public UIActivitySpaces()
Method Detail

GetClassType

public ClassTypeEnum GetClassType()
Description copied from interface: IClassTypeDesc
Returns the class type.

Specified by:
GetClassType in interface IClassTypeDesc
Overrides:
GetClassType in class AUIClassTypeDesc
Returns:
The class type.

GetClassName

public java.lang.String GetClassName()
Description copied from interface: IUIClassTypeDesc
Returns the class name of the class type. This is a unique string that identifies this class. When the Opener sees "open=XYZ" where "XYZ" is not an integer, it will invoke the ClassTypeDesc with the matching class name. Note that class name should not be an integer representation, i.e. "512", because it will collide with PT_CLASSIDS.

Specified by:
GetClassName in interface IUIClassTypeDesc
Specified by:
GetClassName in class AUIClassTypeDesc
Returns:
The class name of the class type.

GetRedirectViewObject

public Redirect GetRedirectViewObject(XPHashtable _htArguments,
                                      AActivitySpace _asParent,
                                      java.lang.Object _userSession)
Description copied from interface: IClassTypeDesc
This method is called by the Common Opener in the view mode. Depending on what class type you are dealing with, the Common Opener will invoke the correct implemented method. Some class types may need to override this so that they can put additional control arguments in.

Specified by:
GetRedirectViewObject in interface IClassTypeDesc
Specified by:
GetRedirectViewObject in class AUIClassTypeDesc
Parameters:
_htArguments - Arguments to reach the new space.
_asParent - The parent activity space.
_userSession - The current session.
Returns:
A redirect that will bring you to the view activity space for the particular class/object.



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.