com.plumtree.server
Interface IPTPageTemplate

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTPageTemplate
extends IPTObject

IPTPageTemplate


Method Summary
 void AddGadgetEx(int nGadgetID, int nGadgetColumn)
          Add a gadget to a column in the current page template.
 void AssignGadgetsEx(int[] arrGadgetIDs, int nGadgetColumn)
          Assign a list of gadgets to a column in the current page template.
 java.lang.String GetDefaultPageName()
          Get the default page name for the current page template.
 int GetJobType()
          Get the job type.
 int GetPageType()
          Get the page type for the current page template.
 IPTQueryResult QueryGadgets()
          Query for all the gadgets in the current page template.
 void RemoveGadget(int nGadgetID)
          Remove one gadget from the current page template.
 void SetDefaultPageName(java.lang.String strValue)
          Set the default page name for the current page template.
 void SetJobType(int nValue)
          Set the job type.
 void SetPageType(int nValue)
          Set the page type for the current page template.
 
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
 

Method Detail

AssignGadgetsEx

public void AssignGadgetsEx(int[] arrGadgetIDs,
                            int nGadgetColumn)
Assign a list of gadgets to a column in the current page template. It adds this list to the gadgets that are already in this column.
Parameters:
arrGadgetIDs - - array of gadget ids that are to be added
nGadgetColumn - - column id in which to place all the gadgets

AddGadgetEx

public void AddGadgetEx(int nGadgetID,
                        int nGadgetColumn)
Add a gadget to a column in the current page template. It adds this gadget to the gadgets that are already in this column.
Parameters:
nGadgetID - - gadget id that is to be added
nGadgetColumn - - column id in which to place the gadget

RemoveGadget

public void RemoveGadget(int nGadgetID)
Remove one gadget from the current page template.
Parameters:
nGadgetID - - gadget id of the gadget to remove

QueryGadgets

public IPTQueryResult QueryGadgets()
Query for all the gadgets in the current page template.
Returns:
IPTQueryResult with the following PROPIDS: PT_PROPID_OBJECTID PT_PROPID_MYPORTAL_TOPICPOS PT_PROPID_GADGET_COLUMN PT_PROPID_NAME PT_PROPID_DESCRIPTION PT_PROPID_ISLOCALIZED PT_PROPID_FOLDERID PT_PROPID_GADGET_ALIGNMENT PT_PROPID_GADGET_GADGETTYPE PT_PROPID_GADGET_FLAGS

GetDefaultPageName

public java.lang.String GetDefaultPageName()
Get the default page name for the current page template. This is only used name is used as the creation name for newly created pages that use this page template.
Returns:
String - page name

SetDefaultPageName

public void SetDefaultPageName(java.lang.String strValue)
Set the default page name for the current page template. This is only used name is used as the creation name for newly created pages that use this page template.
Parameters:
strValue - - page name

GetPageType

public int GetPageType()
Get the page type for the current page template.
Returns:
int - page type, which are defined in the UI

SetPageType

public void SetPageType(int nValue)
Set the page type for the current page template. An ABO will be needed to update all the pages that use this page in order for this to reflected everywhere.
Parameters:
nValue - - page type, which are defined in the UI

GetJobType

public int GetJobType()
Get the job type.
Returns:
int - job type, from PT_PAGE_TEMPLATE_JOB_TYPES

SetJobType

public void SetJobType(int nValue)
Set the job type.
Parameters:
nValue - - job type, from PT_PAGE_TEMPLATE_JOB_TYPES


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.