com.plumtree.portaluiinfrastructure.classtypedescriptors.classtypes
Class PTDocTypes

java.lang.Object
  com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc
      com.plumtree.portaluiinfrastructure.classtypedescriptors.APTNonExtClassTypeDesc
          com.plumtree.portaluiinfrastructure.classtypedescriptors.classtypes.PTDocTypes

All Implemented Interfaces:

IPTClassTypeDesc, IClassTypeDesc

public class PTDocTypes
extends APTNonExtClassTypeDesc

Common Opener Mode Description: 1) Create - Doc type editor in create mode (APTNonExtClassTypeDesc). 2) Edit - Doc type editor in edit mode (APTNonExtClassTypeDesc). 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

PTDocTypes()

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() 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.
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[]	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.APTNonExtClassTypeDesc

GetRedirectCreateNew, GetRedirectOpenObject, IsExtensible

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

AppearsInGlobalObjPropMap, ConstructFriendlyURL, GetClassKey, GetClassType, GetDefaultOpenerMode, GetDependentClassTypeIDs, 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

PTDocTypes

public PTDocTypes()

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 APTClassTypeDesc

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()

Description copied from class: APTNonExtClassTypeDesc

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

Specified by:

GetASNameForEditor in class APTNonExtClassTypeDesc

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 APTClassTypeDesc

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.

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.

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.

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.