com.plumtree.server
Interface IPTSubPortal

All Superinterfaces:

IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTSubPortal
extends IPTObject

Version:

$Revision$

Author:

Robert Zhang

Method Summary

int	GetAccessType() Gets the AccessType bitmask.
int	GetDefaultFirstPage() Gets the ID of the page user's first see when they login (MyPage, Community, etc.)
int	GetDefaultFirstPageType() Gets the type of page user's first see when they login (MyPage, Community, etc.)
int	GetFooterID() Gets the ID of the Footer Portlet
int	GetHeaderID() Gets the ID of the Header Portlet
boolean	GetLayoutEnabled()
java.lang.String	GetLayoutOptions()
int	GetMandatoryLinksID() Gets the ID of the SiteMapFolder storing Mandatory links.
int	GetNavigationScheme() Gets the Navigation Scheme ID for user's in this subportal.
int	GetRelatedResourcesAccessType() Gets the access types to Related Resources.
java.lang.String	GetStyleSheet() Gets the Stylesheet of the subportal.
IPTQueryResult	QueryAdminFolders() Query for Admin Folders where this SubPortal is applied
void	SetAccessType(int nAccessType) Sets the AccessType bitmask
void	SetDefaultFirstPage(int nDefaultFirstPage) Sets the ID of the page user's first see when they login (MyPage, Community, etc.)
void	SetDefaultFirstPageType(int nDefaultFirstPageType) Sets the type of page user's first see when they login (MyPage, Community, etc.)
void	SetFooterID(int nFooterID) Sets the ID of a Footer Portlet
void	SetHeaderID(int nHeaderID) Sets the ID of the header portlet
void	SetLayoutEnabled(boolean bEnabled) Sets whether or not layout mode is enabled for this subportal/ Experience Definition.
void	SetLayoutOptions(java.lang.String strOptions) Sets the Layout Options selected for this subportal.
void	SetMandatoryLinksID(int nMandatoryLinksID) Sets the ID of the SiteMapFolder storing Mandatory links.
void	SetNavigationScheme(int nNavigationScheme) Sets the Navigation Scheme ID for user's in this subportal.
void	SetRelatedResourcesAccessType(int nRRAccessType) Sets the access types to Related Resources.
void	SetStyleSheet(java.lang.String sStyleSheet) Sets the Stylesheet of the subportal.

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

GetHeaderID

int GetHeaderID()

Gets the ID of the Header Portlet

Returns:

int ID of the header portlet

SetHeaderID

void SetHeaderID(int nHeaderID)

Sets the ID of the header portlet

Parameters:

nHeaderID - ID of a header portlet, need at least SELECT to the portlet object.

GetFooterID

int GetFooterID()

Gets the ID of the Footer Portlet

Returns:

int ID of a footer portlet

SetFooterID

void SetFooterID(int nFooterID)

Sets the ID of a Footer Portlet

Parameters:

nFooterID - ID of a footer portlet, need at least SELECT to the portlet object.

GetAccessType

int GetAccessType()

Gets the AccessType bitmask.

Returns:

int Integer bitmask, bitwise AND with constants in PT_SUBPORTAL_ACCESS_TYPES to get specific values.

See Also:

PT_SUBPORTAL_ACCESS_TYPES

SetAccessType

void SetAccessType(int nAccessType)

Sets the AccessType bitmask

Parameters:

nAccessType - Integer bitmask, set bits by ORing with PT_SUBPORTAL_ACCESS_TYPES constants

See Also:

PT_SUBPORTAL_ACCESS_TYPES

GetDefaultFirstPageType

int GetDefaultFirstPageType()

Gets the type of page user's first see when they login (MyPage, Community, etc.)

Returns:

int

See Also:

PT_SUBPORTAL_ACCESS_TYPES

SetDefaultFirstPageType

void SetDefaultFirstPageType(int nDefaultFirstPageType)

Sets the type of page user's first see when they login (MyPage, Community, etc.)

Parameters:

nDefaultFirstPageType - One of the constant int values defined in PT_SUBPORTAL_ACCESS_TYPES

See Also:

PT_SUBPORTAL_ACCESS_TYPES

GetDefaultFirstPage

int GetDefaultFirstPage()

Gets the ID of the page user's first see when they login (MyPage, Community, etc.)

Returns:

int One of the constant int values defined in PT_SUBPORTAL_ACCESS_TYPES

SetDefaultFirstPage

void SetDefaultFirstPage(int nDefaultFirstPage)

Sets the ID of the page user's first see when they login (MyPage, Community, etc.)

Parameters:

nDefaultFirstPage -

GetNavigationScheme

int GetNavigationScheme()

Gets the Navigation Scheme ID for user's in this subportal.

Returns:

int ID of a Navigation Scheme, IDs defined in UI.

SetNavigationScheme

void SetNavigationScheme(int nNavigationScheme)

Sets the Navigation Scheme ID for user's in this subportal.

Parameters:

nNavigationScheme - ID of a Navigation Scheme, IDs defined in UI.

GetMandatoryLinksID

int GetMandatoryLinksID()

Gets the ID of the SiteMapFolder storing Mandatory links.

Returns:

int ID of Mandatory links SiteMapFolder

SetMandatoryLinksID

void SetMandatoryLinksID(int nMandatoryLinksID)

Sets the ID of the SiteMapFolder storing Mandatory links.

Parameters:

nMandatoryLinksID - ID of Mandatory links SiteMapFolder, need at least SELECT access to the SiteMapFolder object.

GetRelatedResourcesAccessType

int GetRelatedResourcesAccessType()

Gets the access types to Related Resources.

Returns:

int Bitmask to specify access to different related resource types defined in PT_RELATED_RESOURCES_ACCESS_TYPES.

See Also:

PT_RELATED_RESOURCES_ACCESS_TYPES

SetRelatedResourcesAccessType

void SetRelatedResourcesAccessType(int nRRAccessType)

Sets the access types to Related Resources.

Parameters:

nRRAccessType - Bitmask to specify access to different related resource types defined in PT_RELATED_RESOURCES_ACCESS_TYPES.

See Also:

PT_RELATED_RESOURCES_ACCESS_TYPES

GetStyleSheet

java.lang.String GetStyleSheet()

Gets the Stylesheet of the subportal.

Returns:

String Stylesheet file name.

SetStyleSheet

void SetStyleSheet(java.lang.String sStyleSheet)

Sets the Stylesheet of the subportal.

Parameters:

sStyleSheet - Stylesheet file name.

QueryAdminFolders

IPTQueryResult QueryAdminFolders()

Query for Admin Folders where this SubPortal is applied

Returns:

IPTQueryResult QueryResult with the PT_PROPID_OBJECTID, PT_PROPID_NAME and PT_PROPID_ISLOCALIZED columns

See Also:

PT_PROPIDS

GetLayoutEnabled

boolean GetLayoutEnabled()

Returns:

boolean Whether or not adaptive layout mode is enabled for this subportal/ Experience Definition.

SetLayoutEnabled

void SetLayoutEnabled(boolean bEnabled)

Sets whether or not layout mode is enabled for this subportal/ Experience Definition.

Parameters:

bEnabled - whether or not layout mode is enabled.

GetLayoutOptions

java.lang.String GetLayoutOptions()

Returns:

String concatenated list of selection options for each layout type for this subportal.

SetLayoutOptions

void SetLayoutOptions(java.lang.String strOptions)

Sets the Layout Options selected for this subportal.

Parameters:

strOptions - the List of Options for this subportal.