com.plumtree.portalpages.admin.editors.datasource
Class DSModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.datasource.DSModel

All Implemented Interfaces:

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

Direct Known Subclasses:

DataSourceModel, SOAPDSModel

public abstract class DSModel
extends ObjEditorModel
implements IDSModelRO

This class contains the common model elements for datasources.

Author:

JohnH

Field Summary

protected int	m_intURLType
protected int	m_intWebServiceID
static int	PMODE_CREATE
static int	PMODE_EDIT
static int	PMODE_INVALID The following static members define the possible modes this editor can be in.

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

DSModel()

Method Summary

void	DoTaskAfterStore() Code executed after the object is stored.
void	DoTaskBeforeStore() Code executed before the object is stored.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Code executed when the Editor is starting.
int	GetCreatorID() Returns the creatorID.
int	GetPMode() Returns the nPMode.
int	GetURLType() Returns the URL type for the data source.
int	GetWebServiceID() Returns the Web Service ID for the data source.
abstract boolean	IsWebServiceChangeable() Returns whether the WebService is changeable from the DataSource Editor.
abstract boolean	IsWebServiceRemovable() Returns whether the WebService is removable from the DataSource Editor.
int	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.
void	SetMemberVariablesFromQS(XPHashtable _htFormData) Helper method for the StartEditor method.
void	SetURLType(int uRLType) Sets the URL type for the data source.
void	SetWebServiceID(int webServiceID) Sets the Web Service ID for the data source.

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

CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, DoTaskOnComeBackFromSubEditor, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, InitPTObject, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

Cancel, CleanupAllData, CleanupTempData, Create, DoTaskOnChangePage, 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.portaluiinfrastructure.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

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

m_intURLType

protected int m_intURLType

m_intWebServiceID

protected int m_intWebServiceID

PMODE_INVALID

public static final int PMODE_INVALID

The following static members define the possible modes this editor can be in.

See Also:

Constant Field Values

PMODE_CREATE

public static final int PMODE_CREATE

See Also:

Constant Field Values

PMODE_EDIT

public static final int PMODE_EDIT

See Also:

Constant Field Values

Constructor Detail

DSModel

public DSModel()

Method Detail

DoTaskAfterStore

public void DoTaskAfterStore()

Code executed after the object is stored.

Overrides:

DoTaskAfterStore in class EditorModel

DoTaskBeforeStore

public void DoTaskBeforeStore()

Code executed before the object is stored.

Overrides:

DoTaskBeforeStore in class EditorModel

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Code executed when the Editor is starting.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

GetURLType

public int GetURLType()

Returns the URL type for the data source. This value is either PT_URL_TYPES.PT_URL_TYPE_SIMPLE_FIELD_MAPPING or PT_URL_TYPES. PT_URL_TYPE_DATASOURCE_GENERATED

Specified by:

GetURLType in interface IDSModelRO

Returns:

int

SetURLType

public void SetURLType(int uRLType)

Sets the URL type for the data source. This value is either PT_URL_TYPES. PT_URL_TYPE_SIMPLE_FIELD_MAPPING or PT_URL_TYPES. PT_URL_TYPE_DATASOURCE_GENERATED

Parameters:

uRLType - The uRLType to set

GetWebServiceID

public int GetWebServiceID()

Returns the Web Service ID for the data source.

Specified by:

GetWebServiceID in interface IDSModelRO

Returns:

int

SetWebServiceID

public void SetWebServiceID(int webServiceID)

Sets the Web Service ID for the data source.

Parameters:

webServiceID - The webServiceID to set

SaveMainPage

public int SaveMainPage(XPHashtable _htFormData)

Saves the data on the Main page.

Parameters:

_htFormData -

Returns:

int Page status for server side validation

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

SetMemberVariablesFromQS

public void SetMemberVariablesFromQS(XPHashtable _htFormData)

Description copied from class: ObjEditorModel

Helper method for the StartEditor method. Fill out the member variables with data from QS.

Overrides:

SetMemberVariablesFromQS in class ObjEditorModel

See Also:

ObjEditorModel.SetMemberVariablesFromQS(XPHashtable)

GetPMode

public int GetPMode()

Returns the nPMode.

Returns:

int

GetCreatorID

public int GetCreatorID()

Returns the creatorID.

Returns:

int

IsWebServiceChangeable

public abstract boolean IsWebServiceChangeable()

Returns whether the WebService is changeable from the DataSource Editor.

Returns:

boolean

IsWebServiceRemovable

public abstract boolean IsWebServiceRemovable()

Returns whether the WebService is removable from the DataSource Editor.

Returns:

boolean