com.plumtree.portalpages.browsing.editors.folder
Class FolderEditorModel

java.lang.Object
  extended by com.plumtree.uiinfrastructure.editor.EditorModel
      extended by com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          extended by com.plumtree.portalpages.browsing.editors.folder.FolderEditorModel
All Implemented Interfaces:
IFolderEditorModelRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class FolderEditorModel
extends ObjEditorModel
implements IFolderEditorModelRO

Author:
StephenC This class contains the IPTProperty server object, as well as the set and get methods on that object. This class is called by the PropRepostControl to perform the changes on the Object and by the Views PropAdvView and PropMainView to display the latest values on the page.

Field Summary
static int CANCEL_PROPAGATE_ACL
           
static int NO_PROPAGATE_ACL
           
static java.lang.String STR_MVC_CLASS_NAME
           
static int UNKNOWN_PROPAGATE_ACL
           
static int YES_PROPAGATE_ACL
           
 
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
isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType
 
Constructor Summary
FolderEditorModel()
           
 
Method Summary
 boolean CheckEditorAccessAndStart(XPHashtable _htFormData)
          Implements some actions to perform on start.
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 boolean DoNotShowObject(int nIndex)
           
 void DoTaskAfterStore()
          That method contains the code that should be executed just after the object has been stored 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.
 int GetACLFlag()
           
 int GetBrowsingOrderBy()
          Returns the propID to order by when BROWSING
 IASQueryResult GetBrowsingOrderByProperties()
          Returns a query result of the card properties to sort by when BROWSING
 int GetClassificationFiltersOperator()
          returns the value of the Folder's ClassificationFiltersOperator Setting
 java.lang.String GetDataSourceName(int nDataSourceID)
          returns the name of a given datasource.
 int GetDefaultDataSource()
          returns the name of the Default DataSource for this folder.
 int GetEditingOrderBy()
          Returns the propID to order by when EDITING
 IASQueryResult GetFilteredDataSources()
          returns a list of data sources that support Card Submission
 java.lang.Object GetFolderSetting(int nValueName)
          returns the value of a particular Folder Setting
 java.lang.String GetName()
          Returns the Class name.
 java.lang.String GetParentDefaultDataSourceNameRecursive()
          returns the name of the Default DataSource for this folder.
 java.lang.String GetPrimaryDesc()
          returns primary name
 java.lang.String GetPrimaryName()
          returns primary name
 Redirect GetRedirectAfterFinish()
          Returns the Redirect object (this is were we need to go at the end of the Editor).
 java.lang.String GetSpaceID()
          Get the SpaceID of the parent Activity Space
 IASQueryResult GetSubFolders()
          Returns a query result of the sub-folders
 void Init(AActivitySpace parent)
          Inits the Model with the IPTSession.
 boolean IsRootFolder()
          returns whether this is the root folder
protected  void SaveDataSourcePage(XPHashtable _htFormData)
           
protected  void SaveMainPage(XPHashtable _htFormData)
          Saves the data on the Main page.
 int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
          Calls the right save function according to the page name passed in argument.
 void SetACLFlag(int _ACLFlag)
           
 void StartSelectPTObject()
          Helper method to start the Select PTObject List.
 
Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
CheckEditorAccess, CheckFolderType, DisableSecurity, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, InitIsSysAdminFlag, InitPTObject, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject
 
Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel
Cancel, CleanupAllData, CleanupTempData, DoTaskBeforeStore, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, 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, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly
 

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME
See Also:
Constant Field Values

YES_PROPAGATE_ACL

public static final int YES_PROPAGATE_ACL
See Also:
Constant Field Values

NO_PROPAGATE_ACL

public static final int NO_PROPAGATE_ACL
See Also:
Constant Field Values

CANCEL_PROPAGATE_ACL

public static final int CANCEL_PROPAGATE_ACL
See Also:
Constant Field Values

UNKNOWN_PROPAGATE_ACL

public static final int UNKNOWN_PROPAGATE_ACL
See Also:
Constant Field Values
Constructor Detail

FolderEditorModel

public FolderEditorModel()
Method Detail

CheckEditorAccessAndStart

public boolean CheckEditorAccessAndStart(XPHashtable _htFormData)
Implements some actions to perform on start.

Overrides:
CheckEditorAccessAndStart in class ObjEditorModel
Parameters:
_htFormData -
Returns:
boolean Is true if the current user has the rights to access this Editor.

Create

public java.lang.Object Create()
Description copied from class: EditorModel
This method is used by the ASManager to return new instances of managed objects.

Specified by:
Create in interface IManagedObject
Specified by:
Create in class EditorModel
Returns:
A new instance of the managed class (i.e. return new Foo();)
See Also:
IManagedObject.Create()

DoNotShowObject

public boolean DoNotShowObject(int nIndex)
See Also:
IObjectModelRO.DoNotShowObject(int)

DoTaskAfterStore

public void DoTaskAfterStore()
Description copied from class: EditorModel
That method contains the code that should be executed just after the object has been stored in the DB.

Overrides:
DoTaskAfterStore in class EditorModel

DoTaskOnComeBackFromSubEditor

public void DoTaskOnComeBackFromSubEditor()
This method will be called when you come back to the main Editor from a sub Editor.

Overrides:
DoTaskOnComeBackFromSubEditor in class ObjEditorModel

DoTaskOnStartEditor

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

Overrides:
DoTaskOnStartEditor in class EditorModel
Parameters:
_htFormData -

GetBrowsingOrderBy

public int GetBrowsingOrderBy()
Description copied from interface: IFolderEditorModelRO
Returns the propID to order by when BROWSING

Specified by:
GetBrowsingOrderBy in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetBrowsingOrderBy()

GetBrowsingOrderByProperties

public IASQueryResult GetBrowsingOrderByProperties()
Description copied from interface: IFolderEditorModelRO
Returns a query result of the card properties to sort by when BROWSING

Specified by:
GetBrowsingOrderByProperties in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetBrowsingOrderByProperties()

GetClassificationFiltersOperator

public int GetClassificationFiltersOperator()
Description copied from interface: IFolderEditorModelRO
returns the value of the Folder's ClassificationFiltersOperator Setting

Specified by:
GetClassificationFiltersOperator in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetClassificationFiltersOperator()

GetDataSourceName

public java.lang.String GetDataSourceName(int nDataSourceID)
Description copied from interface: IFolderEditorModelRO
returns the name of a given datasource.

Specified by:
GetDataSourceName in interface IFolderEditorModelRO
See Also:
com.plumtree.portalpages.browsing.editors.folder.IFolderEditorModelRO#GetDataSourceName()

GetDefaultDataSource

public int GetDefaultDataSource()
Description copied from interface: IFolderEditorModelRO
returns the name of the Default DataSource for this folder. (non-recursive)

Specified by:
GetDefaultDataSource in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetDefaultDataSource()

GetEditingOrderBy

public int GetEditingOrderBy()
Description copied from interface: IFolderEditorModelRO
Returns the propID to order by when EDITING

Specified by:
GetEditingOrderBy in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetBrowsingOrderBy()

GetFilteredDataSources

public IASQueryResult GetFilteredDataSources()
Description copied from interface: IFolderEditorModelRO
returns a list of data sources that support Card Submission

Specified by:
GetFilteredDataSources in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetFilteredDataSources()

GetFolderSetting

public java.lang.Object GetFolderSetting(int nValueName)
Description copied from interface: IFolderEditorModelRO
returns the value of a particular Folder Setting

Specified by:
GetFolderSetting in interface IFolderEditorModelRO
See Also:
com.plumtree.portalpages.browsing.editors.folder.IFolderEditorModelRO#GetFolderSetting()

GetName

public java.lang.String GetName()
Returns the Class name.

Specified by:
GetName in interface IMVCObject
Specified by:
GetName in class EditorModel
Returns:
String

GetParentDefaultDataSourceNameRecursive

public java.lang.String GetParentDefaultDataSourceNameRecursive()
Description copied from interface: IFolderEditorModelRO
returns the name of the Default DataSource for this folder. It will recursively search up the ancestors to get this.

Specified by:
GetParentDefaultDataSourceNameRecursive in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetParentDefaultDataSourceNameRecursive()

GetSpaceID

public java.lang.String GetSpaceID()
Get the SpaceID of the parent Activity Space

Returns:
int m_asOwner.GetSpaceID();

GetSubFolders

public IASQueryResult GetSubFolders()
Description copied from interface: IFolderEditorModelRO
Returns a query result of the sub-folders

Specified by:
GetSubFolders in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetSubFolders()

Init

public void Init(AActivitySpace parent)
Description copied from class: ObjEditorModel
Inits the Model with the IPTSession.

Specified by:
Init in interface IModel
Overrides:
Init in class ObjEditorModel
Parameters:
parent - the parent Activity Space
See Also:
com.plumtree.xpshared.activityspace.IModel#Init()

IsRootFolder

public boolean IsRootFolder()
Description copied from interface: IFolderEditorModelRO
returns whether this is the root folder

Specified by:
IsRootFolder in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.IsRootFolder()

GetPrimaryName

public java.lang.String GetPrimaryName()
Description copied from interface: IFolderEditorModelRO
returns primary name

Specified by:
GetPrimaryName in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetPrimaryName()

GetPrimaryDesc

public java.lang.String GetPrimaryDesc()
Description copied from interface: IFolderEditorModelRO
returns primary name

Specified by:
GetPrimaryDesc in interface IFolderEditorModelRO
See Also:
IFolderEditorModelRO.GetPrimaryDesc()

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument.

Specified by:
SavePage in interface IRepostModel
Overrides:
SavePage in class ObjEditorModel
Parameters:
_sPageName -
_htFormData -
Returns:
int Page status for server side validation

StartSelectPTObject

public void StartSelectPTObject()
Helper method to start the Select PTObject List.


SaveDataSourcePage

protected void SaveDataSourcePage(XPHashtable _htFormData)
Parameters:
_htFormData -

SaveMainPage

protected void SaveMainPage(XPHashtable _htFormData)
Saves the data on the Main page.

Parameters:
_htFormData -

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish()
Description copied from class: EditorModel
Returns the Redirect object (this is were we need to go at the end of the Editor). By default this is going to the previous AS (the one that opened this one). But Editors can override that method if they need to redirect somewhere else.

Specified by:
GetRedirectAfterFinish in interface IRepostModel
Overrides:
GetRedirectAfterFinish in class EditorModel
Returns:
Redirect
See Also:
IRepostModel.GetRedirectAfterFinish()

GetACLFlag

public int GetACLFlag()
Returns:

SetACLFlag

public void SetACLFlag(int _ACLFlag)



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.