com.plumtree.server
Interface IPTSubPortalInfo


public interface IPTSubPortalInfo


Method Summary
 int GetAccessType()
          Gets the AccessType bitmask.
 int GetDefaultFirstPageID()
          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 GetObjectID()
           
 int GetRelatedResourcesAccessType()
          Gets the access types to Related Resources.
 java.lang.String GetStyleSheet()
          Gets the Stylesheet, stored as an administrative portlet preference on the header portlet assigned to this SubPortal (if any).
 

Method Detail

GetObjectID

public int GetObjectID()
Returns:
int

GetHeaderID

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

GetFooterID

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

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

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

GetDefaultFirstPageID

public int GetDefaultFirstPageID()
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

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.

GetMandatoryLinksID

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

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

GetStyleSheet

public java.lang.String GetStyleSheet()
Gets the Stylesheet, stored as an administrative portlet preference on the header portlet assigned to this SubPortal (if any).
Returns:
String Stylesheet file name


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.