com.plumtree.server
Interface IPTSiteMapLink

public interface IPTSiteMapLink

IPTSiteMapLink

Author:

Self-Service Communities

Method Summary

java.lang.String	GetDescription() Get description of the current link
int	GetLinkClassID() Get the link class id, which defines the type of link.
int	GetLinkObjectID() Get the object id that this link refers to.
int	GetLinkPageID() Get the page id that this link refers to.
java.lang.String	GetLinkURL() Get URL of current link.
java.lang.String	GetName() Get name of the current link
int	GetObjectID() Get object id of the current link
int	GetParentFolderID() Get the folder id of the current link's parent
void	SetDescription(java.lang.String strValue) Set description of the current link
void	SetLinkClassID(int nValue) Set the current link's class id, which defines the type of link.
void	SetLinkObjectID(int nValue) Set the object id that this link refers to.
void	SetLinkPageID(int nValue) Set the page id that this link refers to.
void	SetLinkURL(java.lang.String strValue) Set URL of the current link.
void	SetName(java.lang.String strValue) Set name of the current link
void	SetParentFolderID(int nValue) Set the parent folder id.
void	Store() Store the current link to the database.

Method Detail

GetObjectID

int GetObjectID()

Get object id of the current link

Returns:

int - object id

GetName

java.lang.String GetName()

Get name of the current link

Returns:

String - name

SetName

void SetName(java.lang.String strValue)

Set name of the current link

Parameters:

strValue - - name

GetDescription

java.lang.String GetDescription()

Get description of the current link

Returns:

String - description

SetDescription

void SetDescription(java.lang.String strValue)

Set description of the current link

Parameters:

strValue - - description

GetLinkURL

java.lang.String GetLinkURL()

Get URL of current link. This only applies to web links.

Returns:

String - URL

SetLinkURL

void SetLinkURL(java.lang.String strValue)

Set URL of the current link. This only applies to web links, so it will only be saved if the current link is a web link.

Parameters:

strValue - - URL value

GetLinkClassID

int GetLinkClassID()

Get the link class id, which defines the type of link.

Returns:

int - link class id which can be one of the following: PT_CLASSIDS.PT_USER_ID PT_CLASSIDS.PT_CATALOGFOLDER_ID PT_CLASSIDS.PT_CATALOGCARD_ID PT_CLASSIDS.PT_COMMUNITY_ID PT_CLASSIDS.PT_SITEMAPWEBLINK_ID

SetLinkClassID

void SetLinkClassID(int nValue)

Set the current link's class id, which defines the type of link.

Parameters:

nValue - - link class id which can be one of the following: PT_CLASSIDS.PT_USER_ID PT_CLASSIDS.PT_CATALOGFOLDER_ID PT_CLASSIDS.PT_CATALOGCARD_ID PT_CLASSIDS.PT_COMMUNITY_ID PT_CLASSIDS.PT_SITEMAPWEBLINK_ID

GetLinkObjectID

int GetLinkObjectID()

Get the object id that this link refers to.

Returns:

int - object id

SetLinkObjectID

void SetLinkObjectID(int nValue)

Set the object id that this link refers to.

Parameters:

nValue - - object id

GetLinkPageID

int GetLinkPageID()

Get the page id that this link refers to. This only applies to links that refer to community pages.

Returns:

int

SetLinkPageID

void SetLinkPageID(int nValue)

Set the page id that this link refers to. This only applies to links that refer to community pages.

Parameters:

nValue -

Store

void Store()

Store the current link to the database.

GetParentFolderID

int GetParentFolderID()

Get the folder id of the current link's parent

Returns:

int - folder id

SetParentFolderID

void SetParentFolderID(int nValue)

Set the parent folder id. If the link is not new, this amounts to a move.

Parameters:

nValue - - parent folder id