com.plumtree.server
Interface IPTSubPortal

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTSubPortal
extends IPTObject


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
 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.
 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 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.
 
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

GetHeaderID

public int GetHeaderID()
Gets the ID of the Header Portlet
Returns:
int ID of the header portlet

SetHeaderID

public 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

public int GetFooterID()
Gets the ID of the Footer Portlet
Returns:
int ID of a footer portlet

SetFooterID

public 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

public 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

public 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

public 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

public 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

public 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

public void SetDefaultFirstPage(int nDefaultFirstPage)
Sets the ID of the page user's first see when they login (MyPage, Community, etc.)
Parameters:
nDefaultFirstPage -  

GetNavigationScheme

public 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

public 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

public int GetMandatoryLinksID()
Gets the ID of the SiteMapFolder storing Mandatory links.
Returns:
int ID of Mandatory links SiteMapFolder

SetMandatoryLinksID

public 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

public 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

public 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

QueryAdminFolders

public 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


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.