com.plumtree.uiinfrastructure.opener.types
Class AUIClassTypeDesc

java.lang.Object
  com.plumtree.uiinfrastructure.opener.types.AUIClassTypeDesc

All Implemented Interfaces:

IClassTypeDesc, IUIClassTypeDesc

Direct Known Subclasses:

UIActivitySpaces, UIGateway

public abstract class AUIClassTypeDesc
extends java.lang.Object
implements IUIClassTypeDesc

TODO Add Description.

Constructor Summary

AUIClassTypeDesc()

Method Summary

java.lang.String	GetClassKey() Returns the key for this class type.
abstract java.lang.String	GetClassName() Returns the class name of the class type.
ClassTypeEnum	GetClassType() Returns the class type.
int	GetDefaultOpenerMode() Returns the default opener mode for this class type.
Redirect	GetRedirectCreateNew(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession) This method is called by the Common Opener in the create mode.
Redirect	GetRedirectOpenObject(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession) This method is called by the Common Opener in the edit mode.
Redirect	GetRedirectSearchBrowse(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession) This method is called by the Common Opener in the search basic mode.
Redirect	GetRedirectSearchEdit(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession) This method is called by the Common Opener in the search basic mode.
abstract Redirect	GetRedirectViewObject(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession) This method is called by the Common Opener in the view mode.
Redirect	GetRedirectViewObjectMetaData(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession) This method is called by the Common Opener in the meta mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

AUIClassTypeDesc

public AUIClassTypeDesc()

Method Detail

GetClassName

public abstract 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

Returns:

The class name of the class type.

GetClassKey

public java.lang.String GetClassKey()

Description copied from interface: IClassTypeDesc

Returns the key for this class type.

Specified by:

GetClassKey in interface IClassTypeDesc

Returns:

The key for this class type.

GetClassType

public ClassTypeEnum GetClassType()

Description copied from interface: IClassTypeDesc

Returns the class type.

Specified by:

GetClassType in interface IClassTypeDesc

Returns:

The class type.

GetDefaultOpenerMode

public int GetDefaultOpenerMode()

Description copied from interface: IClassTypeDesc

Returns the default opener mode for this class type.

Specified by:

GetDefaultOpenerMode in interface IClassTypeDesc

Returns:

The default opener mode for this class type.

GetRedirectViewObject

public abstract 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

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.

GetRedirectCreateNew

public Redirect GetRedirectCreateNew(XPHashtable _htArguments,
                                     AActivitySpace _asParent,
                                     java.lang.Object _userSession)

Description copied from interface: IClassTypeDesc

This method is called by the Common Opener in the create 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:

GetRedirectCreateNew in interface IClassTypeDesc

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 create activity space for the particular class/object.

GetRedirectViewObjectMetaData

public Redirect GetRedirectViewObjectMetaData(XPHashtable _htArguments,
                                              AActivitySpace _asParent,
                                              java.lang.Object _userSession)

Description copied from interface: IClassTypeDesc

This method is called by the Common Opener in the meta 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:

GetRedirectViewObjectMetaData in interface IClassTypeDesc

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 meta activity space for the particular class/object.

GetRedirectSearchBrowse

public Redirect GetRedirectSearchBrowse(XPHashtable _htArguments,
                                        AActivitySpace _asParent,
                                        java.lang.Object _userSession)

Description copied from interface: IClassTypeDesc

This method is called by the Common Opener in the search basic mode. This is a helper method that will return one of the four main modes.

Specified by:

GetRedirectSearchBrowse in interface IClassTypeDesc

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 meta activity space for the particular class/object.

GetRedirectSearchEdit

public Redirect GetRedirectSearchEdit(XPHashtable _htArguments,
                                      AActivitySpace _asParent,
                                      java.lang.Object _userSession)

Description copied from interface: IClassTypeDesc

This method is called by the Common Opener in the search basic mode. This is a helper method that will return one of the four main modes.

Specified by:

GetRedirectSearchEdit in interface IClassTypeDesc

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 meta activity space for the particular class/object.

GetRedirectOpenObject

public Redirect GetRedirectOpenObject(XPHashtable _htArguments,
                                      AActivitySpace _asParent,
                                      java.lang.Object _userSession)

Description copied from interface: IClassTypeDesc

This method is called by the Common Opener in the edit 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:

GetRedirectOpenObject in interface IClassTypeDesc

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 edit activity space for the particular class/object.