com.plumtree.portaluiinfrastructure.classtypedescriptors.classtypes
Class PTDataSources

java.lang.Object
  extended by com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc
      extended by com.plumtree.portaluiinfrastructure.classtypedescriptors.APTExtClassTypeDesc
          extended by com.plumtree.portaluiinfrastructure.classtypedescriptors.classtypes.PTDataSources
All Implemented Interfaces:
IPTClassTypeDesc, IClassTypeDesc

public class PTDataSources
extends APTExtClassTypeDesc

Common Opener Mode Description: 1) Create - Data source editor in create mode (PTDataSources). 2) Edit - Data source editor in edit mode (APTExtClassTypeDesc). 3) View - Redirect to Edit (APTClassTypeDesc). 4) Meta - View object properties page (APTClassTypeDesc).

Author:
John Osborne

Field Summary
 
Fields inherited from class com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc
hasObjectLockManager, objectLockManagerMsgFileName, objectLockManagerMsgID
 
Constructor Summary
PTDataSources()
           
 
Method Summary
 boolean AppearsInMainCreateNewClassMenu()
          Returns a boolean that tells the client if this class type should appear in the main create new object menu.
 java.lang.String GetASNameForEditor(java.lang.String _strProvEnglishName)
          Returns the name of the Activity Space that is used to edit this class type.
 int GetClassID()
          Returns the class ID of the class type.
 java.lang.String GetClassTypeLocalizedName(java.lang.String _strLangID)
          Returns the localized name for the class type.
 java.lang.String GetCLSIDForExistingObject(int _nObjectID, IPTSession _ptSession)
          Returns the CLSID for this object.
 int GetCreateActivityID()
          This method returns the Activity Rights ID that the user needs to have in order to have access to make changes to this class type.
 HTMLImg GetDefaultIcon()
          Returns the default icon for items of this class type.
 int[] GetDependentClassTypeIDs()
          This method lets you specify what kind of PTClassTypes depend on this PTClassType.
 Redirect GetRedirectCreateNew(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
          This method is called by the Common Opener in the create mode.
 int[] GetRelatedClassTypeIDs()
          This method lets you associate the class ID for this PTClassType with other class IDs.
 boolean HasGlobalClassTypeMap()
          Returns a boolean that tells the client if this class type is on the global class type map.
 
Methods inherited from class com.plumtree.portaluiinfrastructure.classtypedescriptors.APTExtClassTypeDesc
GetRedirectOpenObject, IsExtensible
 
Methods inherited from class com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc
AppearsInGlobalObjPropMap, ConstructFriendlyURL, GetClassKey, GetClassType, GetDefaultOpenerMode, GetObjectLockManagerLocalizedName, GetRedirectSearchBrowse, GetRedirectSearchEdit, GetRedirectViewObject, GetRedirectViewObjectMetaData, HasCreateActivityRight, HasObjectLockManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PTDataSources

public PTDataSources()
Method Detail

AppearsInMainCreateNewClassMenu

public 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 APTExtClassTypeDesc
Returns:
A boolean that tells the client if this class type should appear in the main create new object menu.

GetASNameForEditor

public java.lang.String GetASNameForEditor(java.lang.String _strProvEnglishName)
Description copied from class: APTExtClassTypeDesc
Returns the name of the Activity Space that is used to edit this class type.

Specified by:
GetASNameForEditor in class APTExtClassTypeDesc
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 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 APTExtClassTypeDesc
Returns:
The class ID of the class type.

GetClassTypeLocalizedName

public java.lang.String GetClassTypeLocalizedName(java.lang.String _strLangID)
Description copied from interface: IPTClassTypeDesc
Returns the localized name for the class type. For example, the name for users is "User" in English.

Specified by:
GetClassTypeLocalizedName in interface IPTClassTypeDesc
Specified by:
GetClassTypeLocalizedName in class APTClassTypeDesc
Parameters:
_strLangID - The language to retrieve the name for.
Returns:
The localized name for the class type.

GetCLSIDForExistingObject

public final java.lang.String GetCLSIDForExistingObject(int _nObjectID,
                                                        IPTSession _ptSession)
Description copied from class: APTExtClassTypeDesc
Returns the CLSID for this object.

Specified by:
GetCLSIDForExistingObject in class APTExtClassTypeDesc
Parameters:
_nObjectID - The object ID.
_ptSession - The current session.
Returns:
The CLSID for this object.

GetCreateActivityID

public int GetCreateActivityID()
Description copied from class: APTClassTypeDesc
This method returns the Activity Rights ID that the user needs to have in order to have access to make changes to this class type. Use the PT_ACTIVITY_RIGHTS constant to specify/compare rights.

Specified by:
GetCreateActivityID in class APTClassTypeDesc
Returns:
The Activity Rights ID necessary for changes to this class type.

GetDefaultIcon

public HTMLImg GetDefaultIcon()
Description copied from interface: IPTClassTypeDesc
Returns the default icon for items of this class type.

Specified by:
GetDefaultIcon in interface IPTClassTypeDesc
Specified by:
GetDefaultIcon in class APTClassTypeDesc
Returns:
The default icon for items of this class type.

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
Overrides:
GetRedirectCreateNew in class APTExtClassTypeDesc
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.

GetRelatedClassTypeIDs

public int[] GetRelatedClassTypeIDs()
Description copied from interface: IPTClassTypeDesc
This method lets you associate the class ID for this PTClassType with other class IDs. One application for this is at the end of the editor creation wizard, it provides shortcut links to create related objets. Return NULL if there are no related class types.

Specified by:
GetRelatedClassTypeIDs in interface IPTClassTypeDesc
Specified by:
GetRelatedClassTypeIDs in class APTClassTypeDesc
Returns:
An array of related class IDs. May be NULL.

GetDependentClassTypeIDs

public int[] GetDependentClassTypeIDs()
Description copied from interface: IPTClassTypeDesc
This method lets you specify what kind of PTClassTypes depend on this PTClassType. One application for this is to make sure to try to delete dependent items before deleting the main item, otherwise the delete may fail because there are dependent items. This method should only return class types that are directly dependent on this class type. For example, Remote Servers should return Web Services, but not Portlets. Web Services should return Portlets. Return NULL if there are no related class types. NOTE: This does not support circular loops of dependencies (I.E. A -> B -> C -> A). This behavior is undefined, and will mostly likely cause deletes of those objects to fail.

Specified by:
GetDependentClassTypeIDs in interface IPTClassTypeDesc
Overrides:
GetDependentClassTypeIDs in class APTClassTypeDesc
Returns:
An array of dependent class IDs. May be NULL.

HasGlobalClassTypeMap

public boolean HasGlobalClassTypeMap()
Description copied from interface: IPTClassTypeDesc
Returns a boolean that tells the client if this class type is on the global class type map.

Specified by:
HasGlobalClassTypeMap in interface IPTClassTypeDesc
Specified by:
HasGlobalClassTypeMap in class APTClassTypeDesc
Returns:
A boolean that tells the client if this class type is on the global class type map.



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