com.plumtree.portaluiinfrastructure.classtypedescriptors.classtypes
Class PTMyPages

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

All Implemented Interfaces:

IPTClassTypeDesc, IClassTypeDesc

public class PTMyPages
extends APTNonExtClassTypeDesc

Author:

michaeld

Field Summary

static java.lang.String	EDITPAGE_AS_NAME
static java.lang.String	EDITPAGE_CONTROL_NAME
static java.lang.String	MYPAGE_AS_NAME
static java.lang.String	MYPAGE_CONTROL_NAME
static java.lang.String	STR_CREATE_MYPAGE
static java.lang.String	STR_EDITORTYPE_ID
static java.lang.String	STR_OPENERCONTAINER_ID
static java.lang.String	STR_OPENERPAGE_ID
static java.lang.String	STR_PAGE_ID

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

hasObjectLockManager, objectLockManagerMsgFileName, objectLockManagerMsgID

Constructor Summary

PTMyPages()

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	ConstructFriendlyURL(FriendlyURL url, AActivitySpace space) Generates a friendly URL to the implementing class type.
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.
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.
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.APTNonExtClassTypeDesc

IsExtensible

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

AppearsInGlobalObjPropMap, 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

MYPAGE_AS_NAME

public static final java.lang.String MYPAGE_AS_NAME

See Also:

Constant Field Values

MYPAGE_CONTROL_NAME

public static final java.lang.String MYPAGE_CONTROL_NAME

See Also:

Constant Field Values

STR_PAGE_ID

public static final java.lang.String STR_PAGE_ID

See Also:

Constant Field Values

EDITPAGE_AS_NAME

public static final java.lang.String EDITPAGE_AS_NAME

See Also:

Constant Field Values

EDITPAGE_CONTROL_NAME

public static final java.lang.String EDITPAGE_CONTROL_NAME

See Also:

Constant Field Values

STR_OPENERPAGE_ID

public static final java.lang.String STR_OPENERPAGE_ID

See Also:

Constant Field Values

STR_OPENERCONTAINER_ID

public static final java.lang.String STR_OPENERCONTAINER_ID

See Also:

Constant Field Values

STR_EDITORTYPE_ID

public static final java.lang.String STR_EDITORTYPE_ID

See Also:

Constant Field Values

STR_CREATE_MYPAGE

public static final java.lang.String STR_CREATE_MYPAGE

See Also:

Constant Field Values

Constructor Detail

PTMyPages

public PTMyPages()

Method Detail

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.

See Also:

APTNonExtClassTypeDesc.GetASNameForEditor()

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.

See Also:

IPTClassTypeDesc.AppearsInMainCreateNewClassMenu()

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.

See Also:

IPTClassTypeDesc.GetClassID()

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.

See Also:

IPTClassTypeDesc.GetClassTypeLocalizedName(java.lang.String)

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.

See Also:

APTClassTypeDesc.GetCreateActivityID()

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.

See Also:

IPTClassTypeDesc.GetDefaultIcon()

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.

See Also:

IPTClassTypeDesc.GetRelatedClassTypeIDs()

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.

See Also:

IPTClassTypeDesc.HasGlobalClassTypeMap()

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 APTNonExtClassTypeDesc

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.

See Also:

com.plumtree.portaluiinfrastructure.classtypedescriptors.IClassTypeDesc#GetRedirectCreateNew(com.plumtree.openfoundation.util.XPHashtable, com.plumtree.uiinfrastructure.activityspace.AActivitySpace, com.plumtree.server.IPTSession)

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

Overrides:

GetRedirectOpenObject in class APTNonExtClassTypeDesc

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.

See Also:

com.plumtree.portaluiinfrastructure.classtypedescriptors.IClassTypeDesc#GetRedirectOpenObject(com.plumtree.openfoundation.util.XPHashtable, com.plumtree.uiinfrastructure.activityspace.AActivitySpace, com.plumtree.server.IPTSession)

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.

See Also:

com.plumtree.portaluiinfrastructure.classtypedescriptors.IClassTypeDesc#GetRedirectViewObject(com.plumtree.openfoundation.util.XPHashtable, com.plumtree.uiinfrastructure.activityspace.AActivitySpace, com.plumtree.server.IPTSession)

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 user mypages

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.