com.plumtree.portaluiinfrastructure.classtypedescriptors
Class ClassTypeDescManager

java.lang.Object
  com.plumtree.uiinfrastructure.opener.types.ClassTypeManager
      com.plumtree.portaluiinfrastructure.classtypedescriptors.ClassTypeDescManager

All Implemented Interfaces:

IFriendlyURLManager, IPTClassTypeDescManager, IClassTypeManager

public class ClassTypeDescManager
extends ClassTypeManager
implements IClassTypeManager, IPTClassTypeDescManager, IFriendlyURLManager

This class manages the class type descriptor objects.

Author:

John Osborne, Ricky Wong

Field Summary

Fields inherited from class com.plumtree.uiinfrastructure.opener.types.ClassTypeManager

m_aIClassTypes, m_mapClassTypes

Constructor Summary

ClassTypeDescManager(CachingManager cmCachingManager)

Method Summary

boolean	AppearsInGlobalObjPropMap(int _nClassID) Returns whether this class type appears in the global object property map utility.
boolean	AppearsInMainCreateNewClassMenu(int _nClassID) Returns whether this class type appears in the create object dropdown.
java.lang.String	ConstructFriendlyURL(FriendlyURL url, AActivitySpace space) Returns the friendly URL using the FriendlyURL and AActivitySpace class provided.
IProvInfo[]	GetAllRegisteredProvInfo() Returns all registered ProvInfo items.
java.lang.String	GetASNameForClassTypeEditor(int _nClassID) Returns the name of the activity space associated with the specified PT ClassID.
java.lang.String	GetASNameForClassTypeEditor(int _nClassID, java.lang.String _StrProvEnglishName)
java.lang.String	GetClassTypeLocalizedName(int _nClassID, java.lang.String _strLangID) Returns the localized name for a particular PT class.
java.lang.String	GetClassTypeLocalizedName(int _nClassID, java.lang.String _strLangID, java.lang.String _sProvEnglishName) Returns the localized name for a particular PT class.
HTMLImg	GetDefaultIconForClassType(int _nClassID, java.lang.String _strLangID) Returns the default icon to use for this PT class type.
HTMLImg	GetDefaultIconForClassType(int _nClassID, java.lang.String _strLangID, java.lang.String _sProvEnglishName)
int[]	GetDependentClassTypeIDs(int _nClassID)
Redirect	GetFriendlyViewOpenerRedirect(IFriendlyURLParser _fURLParser, AActivitySpace _asParent, java.lang.Object _userSession) Creates a Redirect object by retrieving the correct class type descriptor to parse the friendly URL.
IPTClassTypeDesc[]	GetLockManagerClassTypes(java.lang.String _strLangID)
int[]	GetOrderedListOfClassIDs(java.lang.String _strLangID)
java.lang.String	GetProviderEnglishNameForExistingObject(int _nClassID, int _nObjectID, IPTSession _ptSession)
java.lang.String	GetProviderEnglishNameGivenCLSID(java.lang.String _sCLSID)
IProvInfo[]	GetRegisteredProvInfoForClassType(int _nClassID) Returns an array containing all the registered providers for a particular class.
IProvInfo	GetRegisteredProvInfoGivenEnglishName(java.lang.String _strProvInfoEngName) Given the English name of a provider this passes back the ProvInfo descriptor.
int[]	GetRelatedClassTypeIDs(int _nClassID)
boolean	HasCreateActivityRight(int _nClassID, IPTSession _ptSession)
boolean	HasGlobalClassTypeMap(int _nClassID)
static void	InitializeExtensibleObject(IPTObject _ptObject, java.lang.String _sCLSID) Initializes an extensible Plumtree object.
boolean	IsObjectExtensible(int _nClassID) True if the Plumtree Object of this ClassID is extensible.
java.lang.String	LookupFriendlyURLKeyFromClassId(java.lang.String _strClassId) Returns the friendly URL key for the particular class
void	SetFriendlyURLLookupTable(XPHashtable htLookupTable) Sets the lookup table in the Manager

Methods inherited from class com.plumtree.uiinfrastructure.opener.types.ClassTypeManager

GetClassTypeDescItem, GetDefaultOpenerMode, GetOpenerRedirect

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plumtree.uiinfrastructure.opener.types.IClassTypeManager

GetDefaultOpenerMode, GetOpenerRedirect

Constructor Detail

ClassTypeDescManager

public ClassTypeDescManager(CachingManager cmCachingManager)

Parameters:

cmCachingManager -

Method Detail

InitializeExtensibleObject

public static final void InitializeExtensibleObject(IPTObject _ptObject,
                                                    java.lang.String _sCLSID)

Initializes an extensible Plumtree object.

Parameters:

_ptObject - The Plumtree Object.

_sCLSID - The CLSID of the provider.

AppearsInMainCreateNewClassMenu

public final boolean AppearsInMainCreateNewClassMenu(int _nClassID)

Returns whether this class type appears in the create object dropdown. This method only applies to PTClassTypeDesc class types.

Parameters:

_nClassID - ClassID of the object.

Returns:

True if this class appears in the create object dropdown.

AppearsInGlobalObjPropMap

public final boolean AppearsInGlobalObjPropMap(int _nClassID)

Returns whether this class type appears in the global object property map utility. This method only applies to PTClassTypeDesc class types.

Parameters:

_nClassID - ClassID of the object.

Returns:

True if this class appears in the global object property map utility.

GetAllRegisteredProvInfo

public final IProvInfo[] GetAllRegisteredProvInfo()

Returns all registered ProvInfo items.

Returns:

All registered ProvInfo items

GetDefaultIconForClassType

public final HTMLImg GetDefaultIconForClassType(int _nClassID,
                                                java.lang.String _strLangID)

Returns the default icon to use for this PT class type.

Parameters:

_nClassID - ClassID to get icon for.

_strLangID - If no icon, set alt in this language.

Returns:

The default icon to use for this PT class type.

GetDefaultIconForClassType

public final HTMLImg GetDefaultIconForClassType(int _nClassID,
                                                java.lang.String _strLangID,
                                                java.lang.String _sProvEnglishName)

GetProviderEnglishNameForExistingObject

public final java.lang.String GetProviderEnglishNameForExistingObject(int _nClassID,
                                                                      int _nObjectID,
                                                                      IPTSession _ptSession)

Specified by:

GetProviderEnglishNameForExistingObject in interface IPTClassTypeDescManager

GetProviderEnglishNameGivenCLSID

public final java.lang.String GetProviderEnglishNameGivenCLSID(java.lang.String _sCLSID)

Specified by:

GetProviderEnglishNameGivenCLSID in interface IPTClassTypeDescManager

GetRegisteredProvInfoForClassType

public final IProvInfo[] GetRegisteredProvInfoForClassType(int _nClassID)

Description copied from interface: IPTClassTypeDescManager

Returns an array containing all the registered providers for a particular class.

Specified by:

GetRegisteredProvInfoForClassType in interface IPTClassTypeDescManager

Parameters:

_nClassID - The class ID of the type. (i.e. 38 for Crawler)

Returns:

An array containing all the registered providers for a class. If there are none installed, you get back null.

GetRegisteredProvInfoGivenEnglishName

public final IProvInfo GetRegisteredProvInfoGivenEnglishName(java.lang.String _strProvInfoEngName)

Description copied from interface: IPTClassTypeDescManager

Given the English name of a provider this passes back the ProvInfo descriptor.

Specified by:

GetRegisteredProvInfoGivenEnglishName in interface IPTClassTypeDescManager

Parameters:

_strProvInfoEngName - The provider English name.

Returns:

The ProvInfo class. Null if not found.

IsObjectExtensible

public final boolean IsObjectExtensible(int _nClassID)

True if the Plumtree Object of this ClassID is extensible.

Parameters:

_nClassID - The ClassID for this Plumtree Object.

Returns:

True if the Plumtree Object of this ClassID is extensible.

GetASNameForClassTypeEditor

public java.lang.String GetASNameForClassTypeEditor(int _nClassID)

Returns the name of the activity space associated with the specified PT ClassID.

Parameters:

_nClassID - The ClassID for this Plumtree Object.

Returns:

The name of the associated activity space.

GetASNameForClassTypeEditor

public java.lang.String GetASNameForClassTypeEditor(int _nClassID,
                                                    java.lang.String _StrProvEnglishName)

GetClassTypeLocalizedName

public java.lang.String GetClassTypeLocalizedName(int _nClassID,
                                                  java.lang.String _strLangID)

Returns the localized name for a particular PT class.

Parameters:

_nClassID - The ClassID for this Plumtree Object.

Returns:

The localized name for a particular PT class.

GetClassTypeLocalizedName

public java.lang.String GetClassTypeLocalizedName(int _nClassID,
                                                  java.lang.String _strLangID,
                                                  java.lang.String _sProvEnglishName)

Returns the localized name for a particular PT class.

Parameters:

_nClassID - The ClassID for this Plumtree Object.

_sProvEnglishName - The English Provider Name.

Returns:

The localized name for a particular PT class.

GetOrderedListOfClassIDs

public final int[] GetOrderedListOfClassIDs(java.lang.String _strLangID)

GetRelatedClassTypeIDs

public int[] GetRelatedClassTypeIDs(int _nClassID)

GetDependentClassTypeIDs

public int[] GetDependentClassTypeIDs(int _nClassID)

HasGlobalClassTypeMap

public boolean HasGlobalClassTypeMap(int _nClassID)

HasCreateActivityRight

public boolean HasCreateActivityRight(int _nClassID,
                                      IPTSession _ptSession)

GetLockManagerClassTypes

public IPTClassTypeDesc[] GetLockManagerClassTypes(java.lang.String _strLangID)

GetFriendlyViewOpenerRedirect

public Redirect GetFriendlyViewOpenerRedirect(IFriendlyURLParser _fURLParser,
                                              AActivitySpace _asParent,
                                              java.lang.Object _userSession)

Creates a Redirect object by retrieving the correct class type descriptor to parse the friendly URL.

Specified by:

GetFriendlyViewOpenerRedirect in interface IFriendlyURLManager

Parameters:

_fURLParser - The friendly URL parser containing URL path

_asParent - The parent activity space.

_userSession - The current session.

Returns:

Redirect object that tells the portal what page to go to.

ConstructFriendlyURL

public java.lang.String ConstructFriendlyURL(FriendlyURL url,
                                             AActivitySpace space)

Description copied from interface: IFriendlyURLManager

Returns the friendly URL using the FriendlyURL and AActivitySpace class provided.

Specified by:

ConstructFriendlyURL in interface IFriendlyURLManager

Returns:

The friendly URL

LookupFriendlyURLKeyFromClassId

public java.lang.String LookupFriendlyURLKeyFromClassId(java.lang.String _strClassId)

Description copied from interface: IFriendlyURLManager

Returns the friendly URL key for the particular class

Specified by:

LookupFriendlyURLKeyFromClassId in interface IFriendlyURLManager

Parameters:

_strClassId - class id of the key that we want

Returns:

The friendly URL key

SetFriendlyURLLookupTable

public void SetFriendlyURLLookupTable(XPHashtable htLookupTable)

Description copied from interface: IFriendlyURLManager

Sets the lookup table in the Manager

Specified by:

SetFriendlyURLLookupTable in interface IFriendlyURLManager

Parameters:

htLookupTable - table of class Id to keyword mappings