|
|||||||||
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
public abstract class ObjEditorModel
This is the Model class for the Editor Framework. This class assumes the framework is based on an IPTObject. Editors based on other Objects like for example Global Objects need to extend EditorModel directly. This class contains the IPTObject as a member variable. It initializes IPTObject when the editor starts and stores it in the DB when the user is done. Model classes should extend this class.
Field Summary | |
---|---|
static int |
EDITOR_CLASSID_UNKNOWN
Query String param default value: unknown class ID |
static int |
EDITOR_FOLDERID_UNKNOWN
Query String param default value: unknown folder ID |
static int |
EDITOR_OBJECTID_UNKNOWN
Query String param default value: unknown object ID |
static java.lang.String |
EDITOR_QS_BOL_QS_FORCESAVEINFOLDER
Query String param name: Create In Parent ID |
static java.lang.String |
EDITOR_QS_INT_CLASS_ID
Query String param name: Class ID |
static java.lang.String |
EDITOR_QS_INT_QS_FOLDER_ID
Query String param name: Folder ID |
static java.lang.String |
EDITOR_QS_INT_QS_OBJECT_ID
Query String param name: Object ID |
protected boolean |
m_bDisableDescription
For some objects, you can't set/change the description from the Editor. |
protected boolean |
m_bDisableSecurity
Some Objects don't support ACLs. |
protected boolean |
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. |
protected boolean |
m_bIsSysAdmin
Flag to know if the current user has system administration activity rights. |
protected int |
m_nClassID
Object being created or edited class ID |
protected int |
m_nFolderID
Folder ID where this object should be saved (has value only in create mode) |
protected int |
m_nFolderType
Folder type. |
protected int |
m_nObjectID
Object being created or edited ID (has value only in edit mode) |
protected IPTObject |
m_ptObject
Server object: Object being created or edited |
protected IPTSession |
m_Session
Server object: Plumtree Session for the current user |
protected java.lang.String |
m_sFolderName
Folder Name. |
static int |
OBJECT_NAME_TRUNCATE
Truncate object name after this number of chars. |
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 | |
---|---|
ObjEditorModel()
|
Method Summary | |
---|---|
protected boolean |
CheckEditorAccess(XPHashtable _htFormData)
Helper method to check the current user rights to this Object Editor. |
boolean |
CheckEditorAccessAndStart(XPHashtable _htFormData)
That method is called by the EditorStartControl. |
protected void |
CheckFolderType()
Helper method to check retrieve the folder type. |
boolean |
DisableSecurity()
Returns true if the current Object doesn't support ACLs. |
void |
DoTaskOnComeBackFromSubEditor()
This method will be called when you come back to the main Editor from a sub Editor. |
void |
Finish()
That method is called by the EditorFinishControl. |
boolean |
ForceSaveInFolder()
Returns the Folder ID in which the Object will be saved. |
int |
GetClassID()
Returns the Class ID corresponding to the object being created or edited. |
int |
GetFolderID()
Returns the Folder ID in which the Object will be saved. |
java.lang.String |
GetFolderName()
Returns the folder name. |
boolean |
GetIsSysAdmin()
Returns the value of the m_bIsSysAdmin member variable. |
int |
GetMigrationStatus()
Returns the current Object's migration status. |
IPTObject |
GetObject()
Returns the the IPTObject being created or edited. |
java.lang.String |
GetObjectDescription()
Returns the description of the IPTObject being created or edited. |
int |
GetObjectID()
Returns the ID of the IPTObject being created or edited. |
java.lang.String |
GetObjectName()
Returns the name of the IPTObject being created or edited. |
java.lang.String |
GetParentFolderPath()
Returns the path to the folder where the object has been saved. |
IPTSession |
GetPTSession()
Returns the IPTSession for the current user. |
void |
Init(AActivitySpace parent)
Inits the Model with the IPTSession. |
protected void |
InitIsSysAdminFlag()
Helper method to init the isSysAdmin flag. |
protected void |
InitPTObject(XPHashtable _htFormData)
Helper method to initialize the PTObject being created or edited. |
boolean |
IsDescriptionDisabled()
Returns true if the object description cannot be set/changed from the Editor. |
boolean |
IsMigrationApproved()
Returns true if the migration has already been approved for the current object. |
protected void |
SaveMigrationStatus()
Helper method to Save the migration status on the object. |
int |
SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument. |
void |
SetDisableDescription(boolean _bDisableDescription)
Sets the value of the m_bDisableDescription member variable. |
void |
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. |
void |
SetMemberVariablesFromQS(XPHashtable _htFormData)
Helper method for the StartEditor method. |
void |
SetMigrationStatus(int _nMigrationStatus)
Sets the current Object's migration status. |
void |
StartKeywords()
Helper method to start the keywords section. |
void |
StartLocNamesList()
Helper method to start the localized names and description list. |
void |
StartMigrationHistory()
Helper method to start the migration history page. |
void |
StartObjectProp()
Helper method to start the object property page. |
void |
StartSecurityList()
Helper method to start the security page. |
protected void |
StoreObject()
Helper method to Store the Object. |
Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel |
---|
Cancel, CleanupAllData, CleanupTempData, Create, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, DoTaskOnStartEditor, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetName, 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.uiinfrastructure.editor.IEditorModelRO |
---|
GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject |
---|
GetName |
Field Detail |
---|
public static final java.lang.String EDITOR_QS_INT_CLASS_ID
public static final java.lang.String EDITOR_QS_INT_QS_OBJECT_ID
public static final java.lang.String EDITOR_QS_INT_QS_FOLDER_ID
public static final java.lang.String EDITOR_QS_BOL_QS_FORCESAVEINFOLDER
public static final int EDITOR_CLASSID_UNKNOWN
public static final int EDITOR_OBJECTID_UNKNOWN
public static final int EDITOR_FOLDERID_UNKNOWN
protected IPTObject m_ptObject
protected IPTSession m_Session
public static final int OBJECT_NAME_TRUNCATE
protected java.lang.String m_sFolderName
protected boolean m_bDisableSecurity
protected boolean m_bForceSavedInSuppliedFolder
protected boolean m_bIsSysAdmin
protected int m_nClassID
protected int m_nFolderID
protected int m_nFolderType
protected boolean m_bDisableDescription
protected int m_nObjectID
Constructor Detail |
---|
public ObjEditorModel()
Method Detail |
---|
public boolean CheckEditorAccessAndStart(XPHashtable _htFormData)
CheckEditorAccessAndStart
in class EditorModel
_htFormData
-
XPException
public boolean DisableSecurity()
public void Finish()
Finish
in interface IRepostModel
Finish
in class EditorModel
XPException
public boolean ForceSaveInFolder()
public int GetClassID()
GetClassID
in interface IObjEditorModelRO
GetClassID()
public int GetFolderID()
public boolean IsDescriptionDisabled()
IsDescriptionDisabled
in interface IDescriptionModelRO
IsDescriptionDisabled()
public void SetDisableDescription(boolean _bDisableDescription)
public java.lang.String GetFolderName()
public boolean GetIsSysAdmin()
GetIsSysAdmin
in interface IMigrationModelRO
GetIsSysAdmin()
public int GetMigrationStatus()
public IPTObject GetObject()
GetObject
in interface IObjEditorModelRO
GetObject()
public java.lang.String GetObjectDescription()
GetObjectDescription
in interface IObjEditorModelRO
GetObjectDescription()
public int GetObjectID()
GetObjectID
in interface IObjEditorModelRO
GetObjectID()
public java.lang.String GetObjectName()
GetObjectName
in interface IObjEditorModelRO
GetObjectName()
public IPTSession GetPTSession()
GetPTSession
in interface IObjEditorModelRO
GetPTSession()
public java.lang.String GetParentFolderPath()
GetParentFolderPath
in interface IObjEditorModelRO
GetParentFolderPath()
public void Init(AActivitySpace parent)
Init
in interface IModel
Init
in class EditorModel
parent
- public boolean IsMigrationApproved()
IsMigrationApproved
in interface IMigrationModelRO
IsMigrationApproved()
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
SavePage
in interface IRepostModel
SavePage
in class EditorModel
_sPageName
- _htFormData
-
public void SetMemberVariablesFromQS(XPHashtable _htFormData)
_htFormData
- public void SetMigrationStatus(int _nMigrationStatus)
_nMigrationStatus
- public void StartLocNamesList()
public void StartMigrationHistory()
public void StartObjectProp()
public void StartKeywords()
public void StartSecurityList()
protected boolean CheckEditorAccess(XPHashtable _htFormData)
_htFormData
- Form data
protected void CheckFolderType()
protected void InitIsSysAdminFlag()
protected void InitPTObject(XPHashtable _htFormData)
_htFormData
- protected void SaveMigrationStatus()
protected void StoreObject()
XPException
public void SetEditorToReadOnly()
public void DoTaskOnComeBackFromSubEditor()
DoTaskOnComeBackFromSubEditor
in class EditorModel
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |