com.plumtree.portaluiinfrastructure.classtypedescriptors.classtypes
Class PTDocuments

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

All Implemented Interfaces:

IPTClassTypeDesc, IClassTypeDesc

public class PTDocuments
extends APTExtClassTypeDesc

Common Opener Mode Description: 1) Create - Show error. (PTDocuments). 2) Edit - Document editor in edit mode (APTExtClassTypeDesc). 3) View - Clickthrough to document (PTDocuments). 4) Meta - View object properties page (PTDocuments).

Author:

John Osborne

Field Summary

static java.lang.String	DOCUMENT_AS_NAME
static java.lang.String	DOCUMENT_CONTROL_NAME
static java.lang.String	DOCUMENT_DP_NAME
static java.lang.String	SEARCH_AS_NAME
static java.lang.String	SEARCH_CONTROL_NAME
static java.lang.String	STR_CARD_ID
static java.lang.String	STR_OBJTYPE

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

hasObjectLockManager, objectLockManagerMsgFileName, objectLockManagerMsgID

Constructor Summary

PTDocuments()

Method Summary

boolean	AppearsInGlobalObjPropMap() Returns a boolean that tells the client if this class type appears in the global object property map utility.
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	ConstructFriendlyURL(FriendlyURL url, AActivitySpace space) Generates a friendly URL to the implementing class type.
java.lang.String	GetASNameForEditor()
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.
Redirect	GetRedirectCreateNew(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession) This method is called by the Common Opener in the create mode.
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.
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

GetClassKey, GetClassType, GetDefaultOpenerMode, GetDependentClassTypeIDs, GetObjectLockManagerLocalizedName, GetRedirectSearchBrowse, GetRedirectSearchEdit, HasCreateActivityRight, HasObjectLockManager

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_AS_NAME

public static final java.lang.String DOCUMENT_AS_NAME

See Also:

Constant Field Values

DOCUMENT_DP_NAME

public static final java.lang.String DOCUMENT_DP_NAME

See Also:

Constant Field Values

DOCUMENT_CONTROL_NAME

public static final java.lang.String DOCUMENT_CONTROL_NAME

See Also:

Constant Field Values

STR_CARD_ID

public static final java.lang.String STR_CARD_ID

See Also:

Constant Field Values

SEARCH_AS_NAME

public static final java.lang.String SEARCH_AS_NAME

See Also:

Constant Field Values

SEARCH_CONTROL_NAME

public static final java.lang.String SEARCH_CONTROL_NAME

See Also:

Constant Field Values

STR_OBJTYPE

public static final java.lang.String STR_OBJTYPE

See Also:

Constant Field Values

Constructor Detail

PTDocuments

public PTDocuments()

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.

AppearsInGlobalObjPropMap

public boolean AppearsInGlobalObjPropMap()

Description copied from interface: IPTClassTypeDesc

Returns a boolean that tells the client if this class type appears in the global object property map utility.

Specified by:

AppearsInGlobalObjPropMap in interface IPTClassTypeDesc

Overrides:

AppearsInGlobalObjPropMap in class APTClassTypeDesc

Returns:

A boolean that tells the client if this class type appears in the global object property map utility

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.

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.

GetASNameForEditor

public java.lang.String GetASNameForEditor()

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.

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.

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.

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.

GetRedirectViewObject

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

Description copied from interface: IPTClassTypeDesc

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 IPTClassTypeDesc

Specified by:

GetRedirectViewObject in interface IClassTypeDesc

Overrides:

GetRedirectViewObject in class APTClassTypeDesc

Parameters:

_htArguments - contains the URL path.

_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.

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

Overrides:

GetRedirectViewObjectMetaData 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 meta 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.

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.

ConstructFriendlyURL

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

Description copied from interface: IPTClassTypeDesc

Generates a friendly URL to the implementing class type. Ideally the object name is provided, otherwise if only the object id is provided, the method has to look up the object name. If both are provided, both the object name and object id is used in the friendly url.

Specified by:

ConstructFriendlyURL in interface IPTClassTypeDesc

Overrides:

ConstructFriendlyURL in class APTClassTypeDesc

Parameters:

url - FriendlyURL containing the information for the url

Returns:

Returns the friendly part of the friendly Url, that is, just the part of the Url after server.pt including leading slash.

See Also:

Generates a friendly Url for Documents