com.plumtree.portalpages.ext.providers.www.documentsubmitadvanced
Class WWWCardSubmitAdvancedModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.ext.providers.www.documentsubmitadvanced.WWWCardSubmitAdvancedModel

All Implemented Interfaces:

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

public class WWWCardSubmitAdvancedModel
extends ObjEditorModel
implements IWWWCardSubmitAdvancedModelRO

Author:

StephenC This class contains the IPTCard server object, and the methods involved in submitting a card.

Field Summary

boolean	m_bOverrideDescription
boolean	m_bOverrideName
int	m_nDataSourceID
int	m_nParentFolderID
IPTFolder	m_ptParentFolder
java.lang.String	m_strCardDescription
java.lang.String	m_strCardName
java.lang.String	m_strCardPath
static java.lang.String	QS_PARENT_FOLDER
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

WWWCardSubmitAdvancedModel()

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.
void	DoTaskAfterStore() Code executed after the object is stored.
void	DoTaskBeforeStore() Code executed after the object is stored.
void	DoTaskOnStartEditor(XPHashtable _htFormData) That method contains the code that should be executed just after the object has been initialized when the new editor is started.
void	GenerateCardNameAndDescription()
java.lang.String	GetCardDescription() returns the current Card Description
java.lang.String	GetCardName() returns the current Card Name
java.lang.String	GetCardPath() returns the current Card Path
java.lang.String	GetName() Returns the Class 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
protected int	SaveMainPage(XPHashtable _htFormData) Saves the data on the Main page.
protected int	SaveNamePage(XPHashtable _htFormData) Saves the data on the Name page.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetDefaultCardRefreshSettings(int nCardID)
void	StartSelectPTObject() Helper method to start the Select PTObject List.
int	SubmitCard()
void	SubmitCard(int[] arFolderIDs, java.lang.String strLanguage, java.lang.String strPath, int nDocTypeID, int nDataSourceID)
void	SubmitCardWithPropertyBag(int[] arFolderIDs, java.lang.String strLanguage, int nDocTypeID, int nDataSourceID, IXPPropertyBag pbagCardProp)

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

CheckEditorAccess, CheckFolderType, DisableSecurity, DoTaskOnComeBackFromSubEditor, Finish, 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

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

QS_PARENT_FOLDER

public static final java.lang.String QS_PARENT_FOLDER

See Also:

Constant Field Values

m_ptParentFolder

public IPTFolder m_ptParentFolder

m_strCardDescription

public java.lang.String m_strCardDescription

m_strCardName

public java.lang.String m_strCardName

m_strCardPath

public java.lang.String m_strCardPath

m_bOverrideDescription

public boolean m_bOverrideDescription

m_bOverrideName

public boolean m_bOverrideName

m_nDataSourceID

public int m_nDataSourceID

m_nParentFolderID

public int m_nParentFolderID

Constructor Detail

WWWCardSubmitAdvancedModel

public WWWCardSubmitAdvancedModel()

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.

Throws:

XPException

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

DoTaskAfterStore

public void DoTaskAfterStore()

Code executed after the object is stored.

Overrides:

DoTaskAfterStore in class EditorModel

DoTaskBeforeStore

public void DoTaskBeforeStore()

Code executed after the object is stored.

Overrides:

DoTaskBeforeStore in class EditorModel

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Description copied from class: EditorModel

That method contains the code that should be executed just after the object has been initialized when the new editor is started.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

GenerateCardNameAndDescription

public void GenerateCardNameAndDescription()

GetCardDescription

public java.lang.String GetCardDescription()

Description copied from interface: IWWWCardSubmitAdvancedModelRO

returns the current Card Description

Specified by:

GetCardDescription in interface IWWWCardSubmitAdvancedModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.editors.folder.IWWWCardSubmitAdvancedModelRO#GetCardDescription()

GetCardName

public java.lang.String GetCardName()

Description copied from interface: IWWWCardSubmitAdvancedModelRO

returns the current Card Name

Specified by:

GetCardName in interface IWWWCardSubmitAdvancedModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.editors.folder.IWWWCardSubmitAdvancedModelRO#GetCardName()

GetCardPath

public java.lang.String GetCardPath()

Description copied from interface: IWWWCardSubmitAdvancedModelRO

returns the current Card Path

Specified by:

GetCardPath in interface IWWWCardSubmitAdvancedModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.editors.folder.IWWWCardSubmitAdvancedModelRO#GetCardPath()

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

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

SetDefaultCardRefreshSettings

public void SetDefaultCardRefreshSettings(int nCardID)

Parameters:

nCardID -

StartSelectPTObject

public void StartSelectPTObject()

Helper method to start the Select PTObject List.

SubmitCard

public int SubmitCard()

Returns:

SubmitCard

public void SubmitCard(int[] arFolderIDs,
                       java.lang.String strLanguage,
                       java.lang.String strPath,
                       int nDocTypeID,
                       int nDataSourceID)

Parameters:

arFolderIDs -

strLanguage -

strPath -

nDocTypeID -

nDataSourceID -

SubmitCardWithPropertyBag

public void SubmitCardWithPropertyBag(int[] arFolderIDs,
                                      java.lang.String strLanguage,
                                      int nDocTypeID,
                                      int nDataSourceID,
                                      IXPPropertyBag pbagCardProp)

Parameters:

arFolderIDs -

strLanguage -

nDocTypeID -

nDataSourceID -

pbagCardProp -

Throws:

XPException

SaveMainPage

protected int SaveMainPage(XPHashtable _htFormData)

Saves the data on the Main page.

Parameters:

_htFormData -

Returns:

SaveNamePage

protected int SaveNamePage(XPHashtable _htFormData)

Saves the data on the Name page.

Parameters:

_htFormData -

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