com.plumtree.taskapi.portalui
Interface ITaskAPIUIDirectory

All Known Implementing Classes:

TaskAPIUIDirectoryService

public interface ITaskAPIUIDirectory

Method Summary

IXPList	AddUploadData(AActivitySpace owner, IXPList _sources) Adds the upload data for the Web Services associated with the Data Sources used for submitting documents to the Knowledge Directory.
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.
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.
IPTURL	CreateCommonOpenerDocumentURL(AActivitySpace owner, java.lang.String strTitle, int nDocumentID) Gets an URL to open a specified Document in the Knowledge Directory.
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.
IXPList	GetSubmitDataSources(AActivitySpace owner) Gets the Data Sources used for submitting documents to the Knowledge Directory.
IPTURL	GetURLForBrowseDirectory(AActivitySpace owner, int nFolderID) Gets the URL to the specified Knowledge Directory in Browse Mode.
IPTURL	GetURLForEditDirectory(AActivitySpace owner, int nFolderID) Gets the URL to the specified Knowledge Directory in Edit Mode.
boolean	IsCurrentPageDirectoryPage(AActivitySpace owner) Checks if the current page is a Knowledge Directory page.
boolean	IsDirectoryFeaturedEnabledInSubPortal(AActivitySpace owner) Checks if the Knowledge Directory feature is enabled in the current Experience Definition.
boolean	IsWebDataSource(IPTDataSource _dataSource, IPTSession _session) Check if the provider for this data source supports web paths.

Method Detail

IsDirectoryFeaturedEnabledInSubPortal

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

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

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

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

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

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

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

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.

GetSubmitDataSources

IXPList GetSubmitDataSources(AActivitySpace owner)

Gets the Data Sources used for submitting documents to the Knowledge Directory.

Parameters:

owner - Current Activityspace.

Returns:

the list of Data Sources used for submitting documents to the Knowledge Directory. Each entry in the list will be a HashTableDataObject with entries for "name" and "id", as described in the SubmitDataSourceConstants class.

AddUploadData

IXPList AddUploadData(AActivitySpace owner,
                      IXPList _sources)

Adds the upload data for the Web Services associated with the Data Sources used for submitting documents to the Knowledge Directory. This will also filter the list for invalid submit data sources. Data sources should be either web submit, or remote file upload. Any other kinds of data sources will be removed from the list.

Parameters:

owner - Current Activityspace.

_sources - List of HashtableDataObjects of the Data Sources to lookup. This is of the same format as the result of the GetSubmitDataSources method.

Returns:

the original list of Data Sources with additional data added to each entry. The entries in the list will have additional entries for "type" (file or web), "url" (remote upload URL), and "wsid" (ID of the associated web service), as described in the SubmitDataSourceConstants class. "url" will be null for data sources that don't support remote upload.

IsWebDataSource

boolean IsWebDataSource(IPTDataSource _dataSource,
                        IPTSession _session)

Check if the provider for this data source supports web paths.

Parameters:

_dataSource - The data source to check.

_session - the current user session

Returns:

whether or not this data source supports web paths.