com.plumtree.portalpages.admin.editors.subportal
Interface ISubPortalModelRO

All Superinterfaces:

IEditorModelRO, IModelRO, IMVCObject, IObjEditorModelRO

All Known Implementing Classes:

SubPortalModel

public interface ISubPortalModelRO
extends IObjEditorModelRO

This interface is implemented by SubPortalModel. It contains all the read-only mothods of SubPortalModel. The Views only have access to the interface.

Author:

Julie Fournier

Method Summary

int	GetAccessType() Returns the The type of subportal access (MyPages, Communities, Knowledge Directory) supported by this subportal.
ASURL	GetASURLToAdminFolder(java.lang.String _sSubSpaceKey) Return the ASURL object going to the Admin Folder Editor as a sub Editor.
ASURL	GetASURLToCommunity(java.lang.String _sSubSpaceKey) Return the ASURL object going to the Community Editor as a sub Editor.
ASURL	GetASURLToFolder(java.lang.String _sSubSpaceKey) Return the ASURL object going to the Folder Editor as a sub Editor.
java.lang.String	GetCommSubSpaceID() Returns the subspace ID used by the tree control.
int	GetDefaultFirstPage() Returns the first page ID based on the page type specifiede.
int	GetDefaultFirstPageType() Returns which page the users will see upon logging in to the subportal: a MyPage, a Community, or a Directory page.
int	GetDefaultSSOVendor() Return the default SSO Vendor setting from PTConfig.xml.
java.lang.String	GetFolderSubSpaceID() Returns the subspace ID used by the Folder tree control.
boolean	GetFolderUnclassified() Returns whether a newly created folder resides in the unclassified area of the object admin hierarchy
int	GetFooterID() Returns the Footer ID.
boolean	GetGuestRedirectToLogin() Returns the Guest Redirect To Login setting.
java.lang.String	GetGuestTreeSubSpaceID() Returns the subspace ID used by the guest tree.
int	GetGuestUserID() Returns the Guest User ID.
java.lang.String	GetGuestUserName() Returns the Guest Username.
int	GetHeaderID() Returns the header ID.
int	GetHomeCommunityID() Returns the home Community ID.
java.lang.String	GetHomeCommunityName() Returns the home Community Name.
int	GetHomeFolderID() Returns the home Folder ID.
java.lang.String	GetHomeFolderName() Returns the home Folder Name.
boolean	GetIsNewGuestLogin() Returns true if the subportal has a PTGuestLogin associated to it, or false otherwise.
boolean	GetLayoutEnabled()
java.lang.String	GetLayoutOptions()
java.lang.String	GetName() Returns the Class name.
int	GetNavigationScheme() Returns the Navigation scheme for the subportal.
boolean	GetRedirectOnLogout() Returns the Redirect On Logout setting.
int	GetRelatedResourcesAccessTypes() Returns what related resources are accessible to users of this subportal.
int	GetSSOVendor() Returns the SSO Vendor setting of the subportal if it exists or the default SSO Vendor setting from PTConfig.xml if the subportal has no SSO Vendor setting set.
java.lang.String	GetStyleSheet() Returns the Stylesheet name.
IXPDictionary	GetStyleSheetOptions() Returns the available Stylesheet names.

Methods inherited from interface com.plumtree.portaluiinfrastructure.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Method Detail

GetHomeCommunityID

int GetHomeCommunityID()

Returns the home Community ID.

Returns:

int

GetHomeCommunityName

java.lang.String GetHomeCommunityName()

Returns the home Community Name.

Returns:

String

GetHomeFolderID

int GetHomeFolderID()

Returns the home Folder ID.

Returns:

int

GetHomeFolderName

java.lang.String GetHomeFolderName()

Returns the home Folder Name.

Returns:

String

GetASURLToCommunity

ASURL GetASURLToCommunity(java.lang.String _sSubSpaceKey)

Return the ASURL object going to the Community Editor as a sub Editor.

Parameters:

_sSubSpaceKey - Key for the sub Editor. If we are going to a new sub Editor, the key can be null and we will just pass in the default key. If we are going back to an existing sub Editor, it should be the sub Editor key.

Returns:

ASURL

GetASURLToFolder

ASURL GetASURLToFolder(java.lang.String _sSubSpaceKey)

Return the ASURL object going to the Folder Editor as a sub Editor.

Parameters:

_sSubSpaceKey - Key for the sub Editor. If we are going to a new sub Editor, the key can be null and we will just pass in the default key. If we are going back to an existing sub Editor, it should be the sub Editor key.

Returns:

ASURL

GetAccessType

int GetAccessType()

Returns the The type of subportal access (MyPages, Communities, Knowledge Directory) supported by this subportal. Valid values are any mask combination of PT_SUBPORTAL_ACCESSTYPES Defaults to communities

Returns:

int

GetCommSubSpaceID

java.lang.String GetCommSubSpaceID()

Returns the subspace ID used by the tree control. This is used to ensure that trees that already exist in memory are reused instead of recreated.

Returns:

String

GetDefaultFirstPage

int GetDefaultFirstPage()

Returns the first page ID based on the page type specifiede. If the page type is PT_SUBPORTAL_COMMUNITIES_ACCESS, then the first page ID will be the Community ID that is set to appear as default. An analogous result will occur with Directory. In the case MyPages, this function will throw an error, because the Users will always be referred to their main MyPage

Returns:

int

GetDefaultFirstPageType

int GetDefaultFirstPageType()

Returns which page the users will see upon logging in to the subportal: a MyPage, a Community, or a Directory page. Valid values are enumerated in PT_SUBPORTAL_ACCESS_TYPES.

Returns:

int

GetFolderSubSpaceID

java.lang.String GetFolderSubSpaceID()

Returns the subspace ID used by the Folder tree control. This is used to ensure that trees that already exist in memory are reused instead of recreated.

Returns:

String

GetFooterID

int GetFooterID()

Returns the Footer ID. If the specified Footer ID doesn't exist, the UI will revert to the default banner, which cannot be deleted.

Returns:

int

GetHeaderID

int GetHeaderID()

Returns the header ID. If the specified Header ID doesn't exist, the UI will revert to the default banner, which cannot be deleted.

Returns:

int

GetStyleSheet

java.lang.String GetStyleSheet()

Returns the Stylesheet name.

Returns:

String

GetStyleSheetOptions

IXPDictionary GetStyleSheetOptions()

Returns the available Stylesheet names.

Returns:

IXPDictionary

GetIsNewGuestLogin

boolean GetIsNewGuestLogin()

Returns true if the subportal has a PTGuestLogin associated to it, or false otherwise.

Returns:

boolean

GetGuestUserName

java.lang.String GetGuestUserName()

Returns the Guest Username.

Returns:

String

GetGuestUserID

int GetGuestUserID()

Returns the Guest User ID.

Returns:

int

GetGuestTreeSubSpaceID

java.lang.String GetGuestTreeSubSpaceID()

Returns the subspace ID used by the guest tree. This is used to ensure that trees that already exist in memory are reused instead of recreated.

Returns:

String

GetGuestRedirectToLogin

boolean GetGuestRedirectToLogin()

Returns the Guest Redirect To Login setting.

Returns:

boolean

GetRedirectOnLogout

boolean GetRedirectOnLogout()

Returns the Redirect On Logout setting.

Returns:

boolean

GetSSOVendor

int GetSSOVendor()

Returns the SSO Vendor setting of the subportal if it exists or the default SSO Vendor setting from PTConfig.xml if the subportal has no SSO Vendor setting set.

Returns:

int

GetDefaultSSOVendor

int GetDefaultSSOVendor()

Return the default SSO Vendor setting from PTConfig.xml.

Returns:

int

GetName

java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Returns:

String

GetNavigationScheme

int GetNavigationScheme()

Returns the Navigation scheme for the subportal. Valid values are enumerated in PT_NAVIGATION_SCHEMES.

Returns:

int

GetRelatedResourcesAccessTypes

int GetRelatedResourcesAccessTypes()

Returns what related resources are accessible to users of this subportal. The value is any mask combination of PT_RELATED_RESOURCES_ACCESS_TYPES.

Returns:

int

GetLayoutEnabled

boolean GetLayoutEnabled()

Returns:

whether or not layouts are enabled for this subportal.

GetLayoutOptions

java.lang.String GetLayoutOptions()

Returns:

The list of Layout Options selected for this subportal.

GetFolderUnclassified

boolean GetFolderUnclassified()

Returns whether a newly created folder resides in the unclassified area of the object admin hierarchy

Returns:

boolean

GetASURLToAdminFolder

ASURL GetASURLToAdminFolder(java.lang.String _sSubSpaceKey)

Return the ASURL object going to the Admin Folder Editor as a sub Editor.

Parameters:

_sSubSpaceKey - Key for the sub Editor. If we are going to a new sub Editor, the key can be null and we will just pass in the default key. If we are going back to an existing sub Editor, it should be the sub Editor key.

Returns:

ASURL