com.plumtree.server
Interface IPTPageTemplate

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTPageTemplate
extends IPTObject

IPTPageTemplate

Author:
Self-Service Communities

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.
 IPTLocalizable GetDefaultPageLocalizable()
          Gets an interface to the object that gets and sets the localized Default Page Names.
 java.lang.String GetDefaultPageName()
          Get the primary default page name for the current page template.
 java.lang.String GetDefaultPagePrimaryLang()
          The primary language of the object is the language that the primary name and primary description are in.
 boolean GetIsDefaultPageLocalized()
          Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations.
 int GetJobType()
          Get the job type.
 java.lang.String GetLocalizedDefaultPageName()
          Return the default page name of this object localized to the language of the current user
 java.lang.Object[][] GetLocalizedDefaultPageNames()
          Returns the localized default page names for this object as a 2D array.
 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 primary default page name for the current page template.
 void SetDefaultPagePrimaryLang(java.lang.String Value)
          The primary language of the object is the language that the primary name and primary description are in.
 void SetIsDefaultPageLocalized(boolean Value)
          Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations.
 void SetJobType(int nValue)
          Set the job type.
 void SetLocalizedDefaultPageNames(java.lang.Object[][] Value)
          Sets the localized default page names for this object.
 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
 
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

AssignGadgetsEx

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

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

void RemoveGadget(int nGadgetID)
Remove one gadget from the current page template.

Parameters:
nGadgetID - - gadget id of the gadget to remove

QueryGadgets

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

GetDefaultPageLocalizable

IPTLocalizable GetDefaultPageLocalizable()
Gets an interface to the object that gets and sets the localized Default Page Names.

Returns:
IPTLocalizable - interface to get/set localized Default Page Names

GetDefaultPageName

java.lang.String GetDefaultPageName()
Get the primary 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

void SetDefaultPageName(java.lang.String strValue)
Set the primary 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

GetLocalizedDefaultPageNames

java.lang.Object[][] GetLocalizedDefaultPageNames()
Returns the localized default page names for this object as a 2D array. The purpose of each column is identified by the constants in PT_LOCALIZED_STRINGS_INDICES.

Returns:
the localized default page names
See Also:
PT_LOCALIZED_STRINGS_INDICES

SetLocalizedDefaultPageNames

void SetLocalizedDefaultPageNames(java.lang.Object[][] Value)
Sets the localized default page names for this object.

Parameters:
Value - an array containing the data about localized default page names. The columns in the 2D array are identified by the constants in PT_LOCALIZED_STRINGS_INDICES.
See Also:
PT_LOCALIZED_STRINGS_INDICES

GetLocalizedDefaultPageName

java.lang.String GetLocalizedDefaultPageName()
Return the default page name of this object localized to the language of the current user

Returns:
the localized default page name

GetIsDefaultPageLocalized

boolean GetIsDefaultPageLocalized()
Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations. That is, the object is marked to be localized, but localization hasn't been done yet.

Returns:
does the object support localization?

SetIsDefaultPageLocalized

void SetIsDefaultPageLocalized(boolean Value)
Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations. That is, the object is marked to be localized, but localization hasn't been done yet. Note that if an object supports localization, and SetIsLocalized(false) is called, all localized strings will be removed from the object.

Parameters:
Value - boolean indicating whether this object should support localization.

GetDefaultPagePrimaryLang

java.lang.String GetDefaultPagePrimaryLang()
The primary language of the object is the language that the primary name and primary description are in. Other metadata about the object (which cannot be localized) is also expected to be in this language.

Returns:
the primary language

SetDefaultPagePrimaryLang

void SetDefaultPagePrimaryLang(java.lang.String Value)
The primary language of the object is the language that the primary name and primary description are in. Other metadata about the object (which cannot be localized) is also expected to be in this language.

Parameters:
Value - the primary language

GetPageType

int GetPageType()
Get the page type for the current page template.

Returns:
int - page type, which are defined in the UI

SetPageType

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

int GetJobType()
Get the job type.

Returns:
int - job type, from PT_PAGE_TEMPLATE_JOB_TYPES

SetJobType

void SetJobType(int nValue)
Set the job type.

Parameters:
nValue - - job type, from PT_PAGE_TEMPLATE_JOB_TYPES


Copyright 2008 Plumtree Software Inc. All Rights Reserved.