|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.editor.EditorModel com.plumtree.portaluiinfrastructure.editor.ObjEditorModel com.plumtree.portalpages.admin.editors.subportal.SubPortalModel
public class SubPortalModel
This class contains the IPTSubPortal server object, as well as the set and get methods on that object. This class is called by the SubPortalRepostControl class to perform the changes on the Object and by the Section classes to display the latest values on the page.
Field Summary | |
---|---|
static int |
NO_MANDATORY_LINKS
Default value for mandatory links ID. |
static java.lang.String |
STR_MVC_CLASS_NAME
Unique identifier for this class |
Fields inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel |
---|
EDITOR_CLASSID_UNKNOWN, EDITOR_FOLDERID_UNKNOWN, EDITOR_OBJECTID_UNKNOWN, EDITOR_QS_BOL_QS_FORCESAVEINFOLDER, EDITOR_QS_INT_CLASS_ID, EDITOR_QS_INT_QS_FOLDER_ID, EDITOR_QS_INT_QS_OBJECT_ID, m_bDisableDescription, m_bDisableSecurity, m_bForceSavedInSuppliedFolder, m_bIsSysAdmin, m_nClassID, m_nFolderID, m_nFolderType, m_nObjectID, m_ptObject, m_Session, m_sFolderName, OBJECT_NAME_TRUNCATE |
Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel |
---|
m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType |
Constructor Summary | |
---|---|
SubPortalModel()
|
Method Summary | |
---|---|
void |
Cancel()
Implement some code to execute when the user clicks on "Cancel". |
java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
void |
DoTaskAfterStore()
Code executed after the object is stored. |
void |
DoTaskBeforeStore()
Initializes IPTSubPortal with the member variables just before we store the object in the DB. |
void |
DoTaskOnComeBackFromSubEditor()
This method will be called when you come back to the main Editor from a sub Editor. |
void |
DoTaskOnStartEditor(XPHashtable _htFormData)
Initializes the property type member variable with the one from IPTProperty in Edit mode and the default value in create mode. |
void |
Finish()
That method is called by the EditorFinishControl. |
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 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 Community tree control. |
protected java.lang.String |
GetCommunityThemesURL()
|
int |
GetDefaultFirstPage()
Returns the default object ID based on the page type specified. |
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 Login name. |
int |
GetHeaderID()
Returns the header ID. |
boolean |
GetHomeCommunityError()
Returns whether there was an error initializing the Home Community. |
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. |
void |
InitializeGuestLoginPlugIn()
Helper method to initialize the plug-in section for Login Settings (the Guest Login object of this subportal) |
void |
InitializeSiteMapPlugIn()
Helper method to initialize the plug-in section for navigation link creation |
void |
RefreshItemFromTree(int intObjectType)
This method gets the selected items from the tree, setting member variables for ObjectID and name of the object selected. |
void |
RefreshSelectedGuestFromTree()
This method gets the selected guest from the tree, setting member variables for ObjectID and name of the guest selected. |
protected int |
SaveBannerPage(XPHashtable _htFormData)
Saves the data on the Choose Header & Footer page. |
protected int |
SaveFeaturesPage(XPHashtable _htFormData)
Saves the data on the SubPortal Features page. |
protected int |
SaveLayoutSettingsPage(XPHashtable _htFormData)
Saves the data on the Adaptive Layout Settings page. |
protected int |
SaveLoginSettingsPage(XPHashtable _htFormData)
Saves the data on the Login Settings page. |
protected int |
SaveNavPage(XPHashtable _htFormData)
Saves the data on the Choose Navigation Design page. |
int |
SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument. |
void |
SetAccessType(int _intAccessType)
Sets the The type of subportal access (MyPages, Communities, Knowledge Directory) supported by this subportal. |
void |
SetCommSubSpaceID(java.lang.String _strCommSubSpaceID)
Returns the subspace ID used by the Community tree control. |
void |
SetDefaultFirstPage(int _intDefaultFirstPage)
Sets the default object ID based on the page type specified. |
void |
SetDefaultFirstPageType(int _intDefaultFirstPageType)
Sets which page the users will see upon logging in to the subportal: a MyPage, a Community, or a Directory page. |
void |
SetFolderSubSpaceID(java.lang.String _strFolderSubSpaceID)
Returns the subspace ID used by the Folder tree control. |
void |
SetFolderUnclassified(boolean bFolderUnclassified)
Returns whether a newly created folder resides in the unclassified area of the object admin hierarchy * @param bFolderUnclassified The bFolderUnclassified to set |
void |
SetFooterID(int _intFooterID)
Sets the Footer ID. |
void |
SetGuestTreeSubSpaceID(java.lang.String subspaceID)
Sets the subspace ID used by the guest tree. |
void |
SetHeaderID(int _intHeaderID)
Sets the header ID. |
void |
SetHomeCommunityError(boolean _bHomeCommunityError)
Sets the home Community Error. |
void |
SetHomeCommunityID(int homeCommunityID)
Sets the home Community ID. |
void |
SetHomeCommunityName(java.lang.String homeCommunityName)
Sets the home Community Name. |
void |
SetHomeFolderID(int homeFolderID)
Sets the home Folder ID. |
void |
SetHomeFolderName(java.lang.String homeFolderName)
Sets the home Folder Name. |
void |
SetLayoutEnabled(boolean _bLayoutEnabled)
Sets whether or not adaptive layouts are enabled for this subportal. |
void |
SetLayoutOptions(java.lang.String _strOptions)
|
void |
SetNavigationScheme(int _intNavigationScheme)
Sets the Navigation scheme for the subportal. |
void |
SetRelatedResourcesAccessTypes(int _intRelatedResourcesAccessTypes)
Sets what related resources are accessible to users of this subportal. |
void |
StartSelectPTFolder()
Helper method to start the Select PTObject List. |
void |
StartSelectPTFooter()
Helper method to start the Select PTObject List. |
void |
StartSelectPTHeader()
Helper method to start the Select PTObject List. |
Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel |
---|
CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, InitPTObject, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject |
Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel |
---|
CleanupAllData, CleanupTempData, DoTaskOnChangePage, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetHideLeftNav, GetIsEditorReadOnly, GetRedirectAfterFinish, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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, GetHideLeftNav, GetIsEditorReadOnly |
Field Detail |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final int NO_MANDATORY_LINKS
Constructor Detail |
---|
public SubPortalModel()
Method Detail |
---|
public java.lang.Object Create()
EditorModel
Create
in interface IManagedObject
Create
in class EditorModel
IManagedObject.Create()
public void DoTaskOnStartEditor(XPHashtable _htFormData)
DoTaskOnStartEditor
in class EditorModel
_htFormData
-
XPException
public void Finish()
ObjEditorModel
Finish
in interface IRepostModel
Finish
in class ObjEditorModel
EditorModel.Finish()
public void DoTaskBeforeStore()
DoTaskBeforeStore
in class EditorModel
XPException
public void DoTaskAfterStore()
DoTaskAfterStore
in class EditorModel
public void Cancel()
EditorModel
Cancel
in class EditorModel
EditorModel.Cancel()
public void DoTaskOnComeBackFromSubEditor()
DoTaskOnComeBackFromSubEditor
in class ObjEditorModel
public ASURL GetASURLToCommunity(java.lang.String _sSubSpaceKey)
GetASURLToCommunity
in interface ISubPortalModelRO
_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.
public ASURL GetASURLToFolder(java.lang.String _sSubSpaceKey)
GetASURLToFolder
in interface ISubPortalModelRO
_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.
public ASURL GetASURLToAdminFolder(java.lang.String _sSubSpaceKey)
GetASURLToAdminFolder
in interface ISubPortalModelRO
_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.
public void RefreshItemFromTree(int intObjectType)
intObjectType
- intObjectType - 0 for Community, 1 for Folderspublic void RefreshSelectedGuestFromTree()
public void StartSelectPTFolder()
public void StartSelectPTFooter()
public void StartSelectPTHeader()
public void InitializeSiteMapPlugIn()
public void InitializeGuestLoginPlugIn()
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
SavePage
in interface IRepostModel
SavePage
in class ObjEditorModel
_sPageName
- _htFormData
-
protected int SaveFeaturesPage(XPHashtable _htFormData)
_htFormData
-
protected int SaveBannerPage(XPHashtable _htFormData)
_htFormData
-
protected int SaveNavPage(XPHashtable _htFormData)
_htFormData
-
protected int SaveLoginSettingsPage(XPHashtable _htFormData)
_htFormData
-
protected int SaveLayoutSettingsPage(XPHashtable _htFormData)
_htFormData
-
public void SetAccessType(int _intAccessType)
_intAccessType
- public void SetCommSubSpaceID(java.lang.String _strCommSubSpaceID)
_strCommSubSpaceID
- public void SetDefaultFirstPage(int _intDefaultFirstPage)
_intDefaultFirstPage
- public void SetDefaultFirstPageType(int _intDefaultFirstPageType)
_intDefaultFirstPageType
- public void SetFolderSubSpaceID(java.lang.String _strFolderSubSpaceID)
_strFolderSubSpaceID
- public void SetFooterID(int _intFooterID)
_intFooterID
- public void SetHeaderID(int _intHeaderID)
_intHeaderID
- public void SetNavigationScheme(int _intNavigationScheme)
_intNavigationScheme
- public void SetRelatedResourcesAccessTypes(int _intRelatedResourcesAccessTypes)
_intRelatedResourcesAccessTypes
- public void SetLayoutEnabled(boolean _bLayoutEnabled)
_bLayoutEnabled
- whether or not layouts are enabled.public void SetHomeCommunityError(boolean _bHomeCommunityError)
_bHomeCommunityError
- The boolean to set Home Community Error to.public java.lang.String GetLayoutOptions()
GetLayoutOptions
in interface ISubPortalModelRO
public void SetLayoutOptions(java.lang.String _strOptions)
_strOptions
- the m_strLayoutOptions to setpublic boolean GetHomeCommunityError()
public int GetHomeCommunityID()
GetHomeCommunityID
in interface ISubPortalModelRO
public void SetHomeCommunityID(int homeCommunityID)
homeCommunityID
- The home Community ID to setpublic void SetHomeCommunityName(java.lang.String homeCommunityName)
homeCommunityName
- The home Community Name to setpublic java.lang.String GetHomeCommunityName()
GetHomeCommunityName
in interface ISubPortalModelRO
public void SetHomeFolderID(int homeFolderID)
homeFolderID
- The homeFolderID to setpublic int GetHomeFolderID()
GetHomeFolderID
in interface ISubPortalModelRO
public void SetHomeFolderName(java.lang.String homeFolderName)
homeFolderName
- The home Folder Name to setpublic java.lang.String GetHomeFolderName()
GetHomeFolderName
in interface ISubPortalModelRO
public int GetAccessType()
GetAccessType
in interface ISubPortalModelRO
public java.lang.String GetCommSubSpaceID()
GetCommSubSpaceID
in interface ISubPortalModelRO
public int GetDefaultFirstPage()
GetDefaultFirstPage
in interface ISubPortalModelRO
public int GetDefaultFirstPageType()
GetDefaultFirstPageType
in interface ISubPortalModelRO
public java.lang.String GetFolderSubSpaceID()
GetFolderSubSpaceID
in interface ISubPortalModelRO
public int GetFooterID()
GetFooterID
in interface ISubPortalModelRO
public int GetHeaderID()
GetHeaderID
in interface ISubPortalModelRO
public java.lang.String GetStyleSheet()
GetStyleSheet
in interface ISubPortalModelRO
public IXPDictionary GetStyleSheetOptions()
GetStyleSheetOptions
in interface ISubPortalModelRO
public boolean GetIsNewGuestLogin()
GetIsNewGuestLogin
in interface ISubPortalModelRO
public java.lang.String GetGuestUserName()
GetGuestUserName
in interface ISubPortalModelRO
public int GetGuestUserID()
GetGuestUserID
in interface ISubPortalModelRO
public java.lang.String GetGuestTreeSubSpaceID()
GetGuestTreeSubSpaceID
in interface ISubPortalModelRO
public void SetGuestTreeSubSpaceID(java.lang.String subspaceID)
public boolean GetGuestRedirectToLogin()
GetGuestRedirectToLogin
in interface ISubPortalModelRO
public boolean GetRedirectOnLogout()
GetRedirectOnLogout
in interface ISubPortalModelRO
public int GetSSOVendor()
GetSSOVendor
in interface ISubPortalModelRO
public int GetDefaultSSOVendor()
GetDefaultSSOVendor
in interface ISubPortalModelRO
public java.lang.String GetName()
GetName
in interface ISubPortalModelRO
GetName
in interface IMVCObject
GetName
in class EditorModel
public int GetNavigationScheme()
GetNavigationScheme
in interface ISubPortalModelRO
public int GetRelatedResourcesAccessTypes()
GetRelatedResourcesAccessTypes
in interface ISubPortalModelRO
public boolean GetLayoutEnabled()
GetLayoutEnabled
in interface ISubPortalModelRO
public boolean GetFolderUnclassified()
GetFolderUnclassified
in interface ISubPortalModelRO
public void SetFolderUnclassified(boolean bFolderUnclassified)
protected java.lang.String GetCommunityThemesURL()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |