com.plumtree.portalpages.ext.providers.soap.documentsubmitadvanced
Class SOAPCardSubmitAdvancedModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.ext.providers.soap.documentsubmitadvanced.SOAPCardSubmitAdvancedModel

All Implemented Interfaces:

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

public class SOAPCardSubmitAdvancedModel
extends ObjEditorModel
implements ISOAPCardSubmitAdvancedModelRO

Author:

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

Field Summary

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

SOAPCardSubmitAdvancedModel()

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	DoTaskOnChangePage(java.lang.String _sNewSpaceName, java.lang.String _sNewPageName) This method can be implemented by classes extending this one.
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
int	GetCardSubmitType() returns the CardSubmission type supported by the webservice
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
boolean	GetSupportsUpload() Returns true if the specified data source supports remote document upload.
boolean	GetUploadSubmitted() returns whether the doc has already been submitted to the upload service
java.lang.String	GetUploadWSURL() Returns the webservice's upload url if it supports uploads and it is set.
int	GetWebServiceID()
void	Init(AActivitySpace parent) Inits the Model with the IPTSession.
void	ResetCardPath()
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	SetUploadSubmittedFlag(boolean _submitted)
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)
int	SubmitCard(java.lang.String _path, java.lang.String _type, java.lang.String _docID)
void	SubmitCardWithPropertyBag(int[] arFolderIDs, java.lang.String strLanguage, int nDocTypeID, int nDataSourceID, IXPPropertyBag pbagCardProp)
void	UpdatePropertiesForDocUpload(java.lang.String _id, java.lang.String _server)

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

Constructor Detail

SOAPCardSubmitAdvancedModel

public SOAPCardSubmitAdvancedModel()

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

GetWebServiceID

public int GetWebServiceID()

GetSupportsUpload

public boolean GetSupportsUpload()

Returns true if the specified data source supports remote document upload.

Specified by:

GetSupportsUpload in interface ISOAPCardSubmitAdvancedModelRO

Returns:

boolean

SetUploadSubmittedFlag

public void SetUploadSubmittedFlag(boolean _submitted)

GetUploadSubmitted

public boolean GetUploadSubmitted()

Description copied from interface: ISOAPCardSubmitAdvancedModelRO

returns whether the doc has already been submitted to the upload service

Specified by:

GetUploadSubmitted in interface ISOAPCardSubmitAdvancedModelRO

Returns:

GetUploadWSURL

public java.lang.String GetUploadWSURL()

Returns the webservice's upload url if it supports uploads and it is set.

Specified by:

GetUploadWSURL in interface ISOAPCardSubmitAdvancedModelRO

Returns:

String

GetCardDescription

public java.lang.String GetCardDescription()

Description copied from interface: ISOAPCardSubmitAdvancedModelRO

returns the current Card Description

Specified by:

GetCardDescription in interface ISOAPCardSubmitAdvancedModelRO

Returns:

See Also:

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

GetCardName

public java.lang.String GetCardName()

Description copied from interface: ISOAPCardSubmitAdvancedModelRO

returns the current Card Name

Specified by:

GetCardName in interface ISOAPCardSubmitAdvancedModelRO

Returns:

See Also:

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

ResetCardPath

public void ResetCardPath()

GetCardPath

public java.lang.String GetCardPath()

Description copied from interface: ISOAPCardSubmitAdvancedModelRO

returns the current Card Path

Specified by:

GetCardPath in interface ISOAPCardSubmitAdvancedModelRO

Returns:

See Also:

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

GetCardSubmitType

public int GetCardSubmitType()

Description copied from interface: ISOAPCardSubmitAdvancedModelRO

returns the CardSubmission type supported by the webservice

Specified by:

GetCardSubmitType in interface ISOAPCardSubmitAdvancedModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.editors.folder.ISOAPCardSubmitAdvancedModel#GetCardSubmitType()

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

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

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(java.lang.String _path,
                      java.lang.String _type,
                      java.lang.String _docID)

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

UpdatePropertiesForDocUpload

public void UpdatePropertiesForDocUpload(java.lang.String _id,
                                         java.lang.String _server)

SaveMainPage

protected int SaveMainPage(XPHashtable _htFormData)

Saves the data on the Main page.

Parameters:

_htFormData -

Returns:

DoTaskOnChangePage

public void DoTaskOnChangePage(java.lang.String _sNewSpaceName,
                               java.lang.String _sNewPageName)

Description copied from class: EditorModel

This method can be implemented by classes extending this one. It will be executed each time the user changes page on the left navigation menu.

Overrides:

DoTaskOnChangePage in class EditorModel

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