com.plumtree.server
Interface IPTSubPortalInfo

public interface IPTSubPortalInfo

Author:

Robert Zhang

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
boolean	GetLayoutEnabled()
java.lang.String	GetLayoutOptions()
int	GetMandatoryLinksID() Gets the ID of the SiteMapFolder storing Mandatory links.
java.lang.String	GetName()
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

int GetObjectID()

Returns:

int

GetName

java.lang.String GetName()

Returns:

String

GetHeaderID

int GetHeaderID()

Gets the ID of the Header Portlet

Returns:

int ID of the header portlet

GetFooterID

int GetFooterID()

Gets the ID of the Footer Portlet

Returns:

int ID of a footer portlet

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

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

GetDefaultFirstPageID

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

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

int GetMandatoryLinksID()

Gets the ID of the SiteMapFolder storing Mandatory links.

Returns:

int ID of Mandatory links SiteMapFolder

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

GetStyleSheet

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

GetLayoutEnabled

boolean GetLayoutEnabled()

Returns:

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

GetLayoutOptions

java.lang.String GetLayoutOptions()

Returns:

String of Options for each layout type of this Subportal Experience Definition.