com.plumtree.portaluiinfrastructure.classtypedescriptors
Class APTExtClassTypeDesc

java.lang.Object
  com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc
      com.plumtree.portaluiinfrastructure.classtypedescriptors.APTExtClassTypeDesc

All Implemented Interfaces:

IPTClassTypeDesc, IClassTypeDesc

Direct Known Subclasses:

APTExtClassTypeDesc, PTAuthSources, PTCrawlers, PTDataSources, PTDocuments, PTNetworkedSearches, PTProfileSources, PTWebServices

public abstract class APTExtClassTypeDesc
extends APTClassTypeDesc

This class provides the contract for extensible PTClassTypes. It provides basic implementations for GetRedirectCreateNew and GetRedirectOpenObject, two of the modes of the Common Opener.

Author:

John Osborne

Field Summary

Fields inherited from class com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc

hasObjectLockManager, objectLockManagerMsgFileName, objectLockManagerMsgID

Constructor Summary

APTExtClassTypeDesc()

Method Summary

abstract boolean	AppearsInMainCreateNewClassMenu() Returns a boolean that tells the client if this class type should appear in the main create new object menu.
abstract java.lang.String	GetASNameForEditor(java.lang.String _strProvEnglishName) Returns the name of the Activity Space that is used to edit this class type.
abstract int	GetClassID() Returns the class ID of the class type.
abstract java.lang.String	GetCLSIDForExistingObject(int _nObjectID, IPTSession _ptSession) Returns the CLSID for this object.
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.
boolean	IsExtensible() Returns a boolean that tells the client if this class type is extensible.

Methods inherited from class com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc

AppearsInGlobalObjPropMap, ConstructFriendlyURL, GetClassKey, GetClassType, GetClassTypeLocalizedName, GetCreateActivityID, GetDefaultIcon, GetDefaultOpenerMode, GetDependentClassTypeIDs, GetObjectLockManagerLocalizedName, GetRedirectSearchBrowse, GetRedirectSearchEdit, GetRedirectViewObject, GetRedirectViewObjectMetaData, GetRelatedClassTypeIDs, HasCreateActivityRight, HasGlobalClassTypeMap, HasObjectLockManager

Methods inherited from class java.lang.Object

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

Constructor Detail

APTExtClassTypeDesc

public APTExtClassTypeDesc()

Method Detail

AppearsInMainCreateNewClassMenu

public abstract boolean AppearsInMainCreateNewClassMenu()

Description copied from interface: IPTClassTypeDesc

Returns a boolean that tells the client if this class type should appear in the main create new object menu.

Specified by:

AppearsInMainCreateNewClassMenu in interface IPTClassTypeDesc

Specified by:

AppearsInMainCreateNewClassMenu in class APTClassTypeDesc

Returns:

A boolean that tells the client if this class type should appear in the main create new object menu.

GetASNameForEditor

public abstract java.lang.String GetASNameForEditor(java.lang.String _strProvEnglishName)

Returns the name of the Activity Space that is used to edit this class type.

Parameters:

_strProvEnglishName - The english name of the provider that is being used for this class type.

Returns:

The name of the Activity Space that is used to edit this class type.

GetClassID

public abstract int GetClassID()

Description copied from interface: IPTClassTypeDesc

Returns the class ID of the class type. Use the PT_CLASSIDS constant to determine/reference IDs.

Specified by:

GetClassID in interface IPTClassTypeDesc

Specified by:

GetClassID in class APTClassTypeDesc

Returns:

The class ID of the class type.

GetCLSIDForExistingObject

public abstract java.lang.String GetCLSIDForExistingObject(int _nObjectID,
                                                           IPTSession _ptSession)

Returns the CLSID for this object.

Parameters:

_nObjectID - The object ID.

_ptSession - The current session.

Returns:

The CLSID for this 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

Specified by:

GetRedirectCreateNew in class APTClassTypeDesc

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.

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

Specified by:

GetRedirectOpenObject in class APTClassTypeDesc

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.

IsExtensible

public boolean IsExtensible()

Description copied from interface: IPTClassTypeDesc

Returns a boolean that tells the client if this class type is extensible.

Specified by:

IsExtensible in interface IPTClassTypeDesc

Specified by:

IsExtensible in class APTClassTypeDesc

Returns:

A boolean that tells the client if this class type is extensible.