com.plumtree.taskapi.portalui
Class TaskAPIUIDirectory

java.lang.Object
  extended by com.plumtree.taskapi.portalui.TaskAPIUIDirectory

public class TaskAPIUIDirectory
extends java.lang.Object

Knowledge Directory related TaskAPI functions. Use TaskAPIDirectoryService.GetInstance() instead.


Constructor Summary
TaskAPIUIDirectory()
           
 
Method Summary
static IPTURL CreateCommonOpenerDirectoryFolderURL(AActivitySpace owner, java.lang.String strTitle, int nDirMode, int nFolderID)
          Gets an URL to open a specified Knowledge Directory folder in the selected mode.
static IPTURL CreateCommonOpenerDirectoryFolderURL(AActivitySpace owner, java.lang.String strTitle, int nDirMode, int nFolderID, java.lang.String strFolderName)
          Gets an URL to open a specified Knowledge Directory folder in the selected mode.
static IPTURL CreateCommonOpenerDocumentURL(AActivitySpace owner, java.lang.String strTitle, int nDocumentID)
          Gets an URL to open a specified Document in the Knowledge Directory.
static IPTURL CreateCommonOpenerDocumentURL(AActivitySpace owner, java.lang.String strTitle, int nDocumentID, java.lang.String strDocumentName)
          Gets an URL to open a specified Document in the Knowledge Directory.
static IPTURL GetURLForBrowseDirectory(AActivitySpace owner, int nFolderID)
          Gets the URL to the specified Knowledge Directory in Browse Mode.
static IPTURL GetURLForEditDirectory(AActivitySpace owner, int nFolderID)
          Gets the URL to the specified Knowledge Directory in Edit Mode.
static boolean IsCurrentPageDirectoryPage(AActivitySpace owner)
          Checks if the current page is a Knowledge Directory page.
static boolean IsDirectoryFeaturedEnabledInSubPortal(AActivitySpace owner)
          Checks if the Knowledge Directory feature is enabled in the current Experience Definition.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskAPIUIDirectory

public TaskAPIUIDirectory()
Method Detail

IsDirectoryFeaturedEnabledInSubPortal

public static boolean IsDirectoryFeaturedEnabledInSubPortal(AActivitySpace owner)
Checks if the Knowledge Directory feature is enabled in the current Experience Definition.

Parameters:
owner - Current Activityspace.
Returns:
true Knowledge Directory feature is enabled, false otherwise.

GetURLForBrowseDirectory

public static IPTURL GetURLForBrowseDirectory(AActivitySpace owner,
                                              int nFolderID)
Gets the URL to the specified Knowledge Directory in Browse Mode. The folder will not be accessible if the current user does not have sufficient access to it.

Parameters:
owner - Current Activityspace.
nFolderID - Object ID of a Knowledge Directory folder to create an URL to.
Returns:
An IPTURL with the URL to the specified folder in Knowledge Directory Browse Mode, or null if the URL is not valid in the current context.

GetURLForEditDirectory

public static IPTURL GetURLForEditDirectory(AActivitySpace owner,
                                            int nFolderID)
Gets the URL to the specified Knowledge Directory in Edit Mode. The folder will not be accessible if the current user does not have sufficient access it.

Parameters:
owner - Current Activityspace.
nFolderID - Object ID of a Knowledge Directory folder to create an URL to.
Returns:
An IPTURL with the URL to the specified folder in Knowledge Directory Edit Mode, or null if the URL is not valid in the current context.

CreateCommonOpenerDirectoryFolderURL

public static IPTURL CreateCommonOpenerDirectoryFolderURL(AActivitySpace owner,
                                                          java.lang.String strTitle,
                                                          int nDirMode,
                                                          int nFolderID)
Gets an URL to open a specified Knowledge Directory folder in the selected mode. The folder will not be accessible if the current user does not have sufficient access it.

Parameters:
owner - Current Activityspace.
strTitle - Title of the URL, normally the name of the folder to open.
nDirMode - DirConstants.BROWSE_MODE or DirConstants.EDIT_MODE
nFolderID - Object ID of the Knowledge Directory Folder to get an URL to.
Returns:
An IPTURL to a folder in the Knowledge Directory - no image is assigned to the URL.
See Also:
DirConstants

CreateCommonOpenerDirectoryFolderURL

public static IPTURL CreateCommonOpenerDirectoryFolderURL(AActivitySpace owner,
                                                          java.lang.String strTitle,
                                                          int nDirMode,
                                                          int nFolderID,
                                                          java.lang.String strFolderName)
Gets an URL to open a specified Knowledge Directory folder in the selected mode. The folder will not be accessible if the current user does not have sufficient access it.

Parameters:
owner - Current Activityspace.
strTitle - Title of the URL, normally the name of the folder to open.
nDirMode - DirConstants.BROWSE_MODE or DirConstants.EDIT_MODE
nFolderID - Object ID of the Knowledge Directory Folder to get an URL to.
Returns:
An IPTURL to a folder in the Knowledge Directory - no image is assigned to the URL.
See Also:
DirConstants

CreateCommonOpenerDocumentURL

public static IPTURL CreateCommonOpenerDocumentURL(AActivitySpace owner,
                                                   java.lang.String strTitle,
                                                   int nDocumentID)
Gets an URL to open a specified Document in the Knowledge Directory. The document will not be accessible if the current user does not have sufficient access it.

Parameters:
owner - Current Activityspace.
strTitle - Title of the URL, normally the name of the Document to open.
nDocumentID - Object ID of the Document to get an URL to.
Returns:

CreateCommonOpenerDocumentURL

public static IPTURL CreateCommonOpenerDocumentURL(AActivitySpace owner,
                                                   java.lang.String strTitle,
                                                   int nDocumentID,
                                                   java.lang.String strDocumentName)
Gets an URL to open a specified Document in the Knowledge Directory. The document will not be accessible if the current user does not have sufficient access it.

Parameters:
owner - Current Activityspace.
strTitle - Title of the URL, normally the name of the Document to open.
nDocumentID - Object ID of the Document to get an URL to.
strDocumentName - Name of the document.
Returns:
The URL to the document

IsCurrentPageDirectoryPage

public static boolean IsCurrentPageDirectoryPage(AActivitySpace owner)
Checks if the current page is a Knowledge Directory page.

Parameters:
owner - Current Activityspace.
Returns:
true if the current page us a Knowledge Directory page, false otherwise.



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