Plumtree Portal UI  
 

ObjEditorModel Members

ObjEditorModel overview

Public Static Fields

EDITOR_CLASSID_UNKNOWN Query String param default value: unknown class ID
EDITOR_FOLDERID_UNKNOWN Query String param default value: unknown folder ID
EDITOR_OBJECTID_UNKNOWN Query String param default value: unknown object ID
EDITOR_QS_BOL_QS_FORCESAVEINFOLDER Query String param name: Create In Parent ID
EDITOR_QS_INT_CLASS_ID Query String param name: Class ID
EDITOR_QS_INT_QS_FOLDER_ID Query String param name: Folder ID
EDITOR_QS_INT_QS_OBJECT_ID Query String param name: Object ID
OBJECT_NAME_TRUNCATE Truncate object name after this number of chars.

Public Instance Constructors

ObjEditorModel Constructor Initializes a new instance of the ObjEditorModel class.

Public Instance Fields

m_asOwner (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 

Public Instance Methods

Cancel (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
CheckEditorAccessAndStart That method is called by the EditorStartControl. It creates a new IPTObject in create mode and retrieves the existing IPTObject in edit mode.
CleanupAllData (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
CleanupTempData (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
Create (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
DisableSecurity Returns true if the current Object doesn't support ACLs.
DoTaskAfterStore (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
DoTaskBeforeStore (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
DoTaskOnChangePage (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
DoTaskOnComeBackFromSubEditor This method will be called when you come back to the main Editor from a sub Editor.
DoTaskOnStartEditor (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
Finish That method is called by the EditorFinishControl. It takes care of storing the IPTObject in the DB when the user finishes the Editor.
ForceSaveInFolder Returns the Folder ID in which the Object will be saved.
GetClassID Returns the Class ID corresponding to the object being created or edited.
GetCloseOnDone (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetCurrentRepostAction (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetDeleteOnCancel (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetEditorType (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetEnableApplyButton (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetFolderID Returns the Folder ID in which the Object will be saved.
GetFolderName Returns the folder name.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetHideLeftNav (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetIsEditorReadOnly (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetIsSysAdmin Returns the value of the m_bIsSysAdmin member variable.
GetMigrationStatus Returns the current Object's migration status.
GetName (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetObject Returns the the IPTObject being created or edited.
GetObjectDescription Returns the description of the IPTObject being created or edited.
GetObjectID Returns the ID of the IPTObject being created or edited.
GetObjectName Returns the name of the IPTObject being created or edited.
GetParentFolderPath Returns the path to the folder where the object has been saved.
GetPTSession Returns the IPTSession for the current user.
GetRedirectAfterFinish (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
GetType (inherited from Object)Gets the Type of the current instance.
GetUserHasAccessToEditor (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
Init Inits the Model with the IPTSession.
IsDescriptionDisabled Returns true if the object description cannot be set/changed from the Editor.
IsMigrationApproved Returns true if the migration has already been approved for the current object.
SavePage Calls the right save function according to the page name passed in argument.
SetCloseOnDone (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
SetDeleteOnCancel (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
SetDisableDescription Sets the value of the m_bDisableDescription member variable.
SetEditorToReadOnly Helper method to set the read-only flag to true and display a warning on every page to remind the user his changes will not be saved.
SetEditorType (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
SetEnableApplyButton (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
SetHideLeftNav (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
SetMemberVariablesFromQS Helper method for the StartEditor method. Fill out the member variables with data from QS.
SetMigrationStatus Sets the current Object's migration status.
SetPageStatus (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
SetUserHasAccessToEditor (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
StartKeywords Helper method to start the keywords section.
StartLocNamesList Helper method to start the localized names and description list.
StartMigrationHistory Helper method to start the migration history page.
StartObjectProp Helper method to start the object property page.
StartSecurityList Helper method to start the security page.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Fields

m_bCloseOnDone (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
m_bDeleteOnCancel (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
m_bDisableDescription For some objects, you can't set/change the description from the Editor.
m_bDisableSecurity Some Objects don't support ACLs. We don't display the Security page for those Objects.
m_bEnableApplyButton (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
m_bForceSavedInSuppliedFolder This var is set if this editor is opened by a parent editor (although not being a sub editor), and the requires the edited object to be stored in a certain folder. E.g is when creating a subcommunity within a community, always want the subcommonity to be created in the parent community's folder. The parent editor passes in the ForceSaveIn parameter to set this.
m_bHideLeftNav (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
m_bIsEditorReadOnly (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
m_bIsSysAdmin Flag to know if the current user has system administration activity rights. We need it to know when to display the migration checkbox.
m_bUserHasAccessToEditor (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
m_nClassID Object being created or edited class ID
m_nEditorType (inherited from com.plumtree.uiinfrastructure.editor.EditorModel) 
m_nFolderID Folder ID where this object should be saved (has value only in create mode)
m_nFolderType Folder type.
m_nObjectID Object being created or edited ID (has value only in edit mode)
m_ptObject Server object: Object being created or edited
m_Session Server object: Plumtree Session for the current user
m_sFolderName Folder Name.

Protected Instance Methods

CheckEditorAccess Helper method to check the current user rights to this Object Editor.
CheckFolderType Helper method to check retrieve the folder type.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
InitIsSysAdminFlag Helper method to init the isSysAdmin flag.
InitPTObject Helper method to initialize the PTObject being created or edited.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
SaveMigrationStatus Helper method to Save the migration status on the object.
StoreObject Helper method to Store the Object.

See Also

ObjEditorModel Class | com.plumtree.portaluiinfrastructure.editor Namespace