com.plumtree.portalpages.browsing.editors.document
Class CardEditorModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.browsing.editors.document.CardEditorModel

All Implemented Interfaces:

ICardEditorModelRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class CardEditorModel
extends ObjEditorModel
implements ICardEditorModelRO

Author:

StephenC This class contains the IPTCard server object, as well as the set and get methods on that object. This class is called by the CardEditorRepostControl to perform the changes on the Object and by the Views CardEditorMainView, CardEditorMainSettingsView, and CardEditorLinkSettings Section to display the latest values on the page.

Field Summary

protected IPTCardPropertyValues	m_ptCardPropertyValues
IPTCardRefreshAgent	m_ptCardRefreshAgent
protected XPSortedDictionary	m_xpBasicProperties
protected XPSortedDictionary	m_xpCardInformation
protected XPSortedDictionary	m_xpCustomProperties
static java.lang.String	STR_MVC_CLASS_NAME

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

CardEditorModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskBeforeStore() Initializes IPTProperty with the property type member variable just before we store the object in the DB.
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.
XPSortedDictionary	GetBasicCardProperties()
XPSortedDictionary	GetCardInformation()
int	GetClassID() Returns the Class ID corresponding to the object being created or edited.
java.lang.String	GetCrawlerTag()
java.lang.String	GetCreated()
XPSortedDictionary	GetCustomCardProperties()
int	GetDocType()
java.lang.String	GetLastModified()
java.lang.String	GetName() Returns the Class name.
int	GetObjectID() Returns the ID of the IPTObject being created or edited.
java.lang.String	GetObjectUUID()
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
java.lang.String	GetURL()
void	LoadCardProperties()
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.

Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, DoTaskOnComeBackFromSubEditor, Finish, ForceSaveInFolder, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, 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

Cancel, CleanupAllData, CleanupTempData, DoTaskAfterStore, 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

GetObject, GetObjectDescription, 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

m_ptCardRefreshAgent

public IPTCardRefreshAgent m_ptCardRefreshAgent

m_ptCardPropertyValues

protected IPTCardPropertyValues m_ptCardPropertyValues

m_xpBasicProperties

protected XPSortedDictionary m_xpBasicProperties

m_xpCardInformation

protected XPSortedDictionary m_xpCardInformation

m_xpCustomProperties

protected XPSortedDictionary m_xpCustomProperties

Constructor Detail

CardEditorModel

public CardEditorModel()

Method Detail

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()

DoTaskBeforeStore

public void DoTaskBeforeStore()

Initializes IPTProperty with the property type member variable just before we store the object in the DB. Also sets 2 other values to default.

Overrides:

DoTaskBeforeStore in class EditorModel

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 -

GetBasicCardProperties

public XPSortedDictionary GetBasicCardProperties()

Specified by:

GetBasicCardProperties in interface ICardEditorModelRO

GetCardInformation

public XPSortedDictionary GetCardInformation()

Specified by:

GetCardInformation in interface ICardEditorModelRO

Returns:

GetCreated

public java.lang.String GetCreated()

Specified by:

GetCreated in interface ICardEditorModelRO

Returns:

GetCustomCardProperties

public XPSortedDictionary GetCustomCardProperties()

Specified by:

GetCustomCardProperties in interface ICardEditorModelRO

Returns:

GetDocType

public int GetDocType()

Specified by:

GetDocType in interface ICardEditorModelRO

Returns:

GetLastModified

public java.lang.String GetLastModified()

Specified by:

GetLastModified in interface ICardEditorModelRO

Returns:

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

GetSpaceID

public java.lang.String GetSpaceID()

Get the SpaceID of the parent Activity Space

Returns:

int m_asOwner.GetSpaceID();

GetURL

public java.lang.String GetURL()

Specified by:

GetURL in interface ICardEditorModelRO

Returns:

LoadCardProperties

public void LoadCardProperties()

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

SaveMainPage

protected void SaveMainPage(XPHashtable _htFormData)

Saves the data on the Main page.

Parameters:

_htFormData -

GetCrawlerTag

public java.lang.String GetCrawlerTag()

Specified by:

GetCrawlerTag in interface ICardEditorModelRO

Returns:

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()

GetObjectID

public int GetObjectID()

Description copied from class: ObjEditorModel

Returns the ID of the IPTObject being created or edited.

Specified by:

GetObjectID in interface ICardEditorModelRO

Specified by:

GetObjectID in interface IObjEditorModelRO

Overrides:

GetObjectID in class ObjEditorModel

Returns:

int

See Also:

ObjEditorModel.GetObjectID()

GetObjectUUID

public java.lang.String GetObjectUUID()

Specified by:

GetObjectUUID in interface ICardEditorModelRO

Returns:

GetClassID

public int GetClassID()

Description copied from class: ObjEditorModel

Returns the Class ID corresponding to the object being created or edited.

Specified by:

GetClassID in interface ICardEditorModelRO

Specified by:

GetClassID in interface IObjEditorModelRO

Overrides:

GetClassID in class ObjEditorModel

Returns:

int

See Also:

ILocNamesModelRO.GetClassID()