com.plumtree.server
Interface IPTCommunityTemplate

All Superinterfaces:

IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTCommunityTemplate
extends IPTObject

Author:

Robert Zhang

Method Summary

void	AddPageTemplate(int nPageTemplateID) Adds a Page template to this Community template.
int	GetFooterID() Gets the ID of the Footer portlet if one is set.
int	GetHeaderID() Gets the ID of the Header portlet if one is set.
IPTQueryResult	QueryPageTemplates() Query for the Page templates in this Community template.
void	RemovePageTemplate(int nPageTemplateID) Removes a Page template from this Community template.
void	SetFooterID(int nFooterID) Sets a Footer for this Community template.
void	SetHeaderID(int nHeaderID) Sets a Header for this Community template.
void	UpdatePageTemplateOrder(int[] arPageTemplateIDs) Assigns a new Page template order.

Methods inherited from interface com.plumtree.server.IPTObject

GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified

Methods inherited from interface com.plumtree.server.IPTLocalizable

GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Methods inherited from interface com.plumtree.server.IPTServerContext

GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject

Methods inherited from interface com.plumtree.server.IPTStorable

Store

Method Detail

AddPageTemplate

void AddPageTemplate(int nPageTemplateID)

Adds a Page template to this Community template.

Parameters:

nPageTemplateID - ID of the Page template to add. At least SELECT access is required to the Page template object.

RemovePageTemplate

void RemovePageTemplate(int nPageTemplateID)

Removes a Page template from this Community template.

Parameters:

nPageTemplateID - ID of the Page template to remove.

QueryPageTemplates

IPTQueryResult QueryPageTemplates()

Query for the Page templates in this Community template.

Returns:

IPTQueryResult QueryResult with Page template containing the following columns: PT_PROPID_OBJECTID, PT_PROPID_PAGES_TOPICPOS, PT_PROPID_NAME, PT_PROPID_ISLOCALIZED, PT_PROPID_PAGETEMPLATE_DEFAULTPAGENAME, PT_PROPID_PAGES_TYPE, PT_PROPID_FOLDERID

GetHeaderID

int GetHeaderID()

Gets the ID of the Header portlet if one is set.

Returns:

ID of a Header portlet if one is set

SetHeaderID

void SetHeaderID(int nHeaderID)

Sets a Header for this Community template.

Parameters:

nHeaderID - ID of a Header portlet, need at least SELECT access to the portlet

GetFooterID

int GetFooterID()

Gets the ID of the Footer portlet if one is set.

Returns:

ID of Footer portlet if one is set

SetFooterID

void SetFooterID(int nFooterID)

Sets a Footer for this Community template.

Parameters:

nFooterID - ID of a Footer portlet, need at least SELECT access to the portlet

UpdatePageTemplateOrder

void UpdatePageTemplateOrder(int[] arPageTemplateIDs)

Assigns a new Page template order.

Parameters:

arPageTemplateIDs - Array of Page template IDs. IDs need to be unique and at least SELECT is needed to them.