com.plumtree.server
Interface IPTSiteMapFolderInfo

public interface IPTSiteMapFolderInfo

IPTSiteMapFolderInfo

Author:

Self-Service Communities

Method Summary

int	GetAccessLevel() Get the current user's access level to the current folder.
java.lang.String	GetDescription() Get the localized description of the current folder.
java.lang.String	GetName() Get the localized name of the current folder.
int	GetObjectID() Get the object id of the current folder.
IPTQueryResult	QueryLinks() Get a cached copy of the link inside the current folder.
IPTQueryResult	QuerySubfolders() Query for the child folders of the current folder.

Method Detail

QueryLinks

IPTQueryResult QueryLinks()

Get a cached copy of the link inside the current folder. Names are localized.

Returns:

IPTQueryResult - query result with the following PROPIDS: PT_PROPID_OBJECTID PT_PROPID_SITEMAP_GID PT_PROPID_NAME PT_PROPID_DESCRIPTION PT_PROPID_SITEMAP_LINKURL PT_PROPID_SITEMAP_LINKCLASSID PT_PROPID_SITEMAP_LINKOBJECTID PT_PROPID_SITEMAP_LINKPAGEID PT_PROPID_SITEMAP_LINKPAGENAME

GetName

java.lang.String GetName()

Get the localized name of the current folder.

Returns:

String - localized name

GetObjectID

int GetObjectID()

Get the object id of the current folder.

Returns:

int - object id

GetDescription

java.lang.String GetDescription()

Get the localized description of the current folder.

Returns:

String - localized description

QuerySubfolders

IPTQueryResult QuerySubfolders()

Query for the child folders of the current folder. This function returns a cached copy.

Returns:

IPTQueryResult - query result with the following PROPIDS PT_PROPID_OBJECTID PT_PROPID_NAME PT_PROPID_DESCRIPTION

GetAccessLevel

int GetAccessLevel()

Get the current user's access level to the current folder.

Returns:

int - access level, of type PT_ACCESS_LEVELS