com.plumtree.portalpages.admin.editors.webservice
Class WebServiceModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.webservice.WebServiceModel

All Implemented Interfaces:

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

public class WebServiceModel
extends ObjEditorModel
implements IWebServiceModelRO

Author:

adolfoc

Field Summary

static java.lang.String	STR_MVC_CLASS_NAME Object Name
static int	WSMODE_AWS
static int	WSMODE_CWS
static int	WSMODE_INTRINSIC_PORTLET
static int	WSMODE_MWS
static int	WSMODE_NONE The additional display modes this WebService Editor can be in.
static int	WSMODE_PAGELET
static int	WSMODE_PORTLET
static int	WSMODE_PWS
static int	WSMODE_SWS

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

WebServiceModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskBeforeStore() That method contains the code that should be executed just before the object is stored in the DB.
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.
protected int	GetEnsembleRemoteServer()
java.lang.String	GetName() Returns the Class name.
int	GetWSMode() Returns the nWSMode.
java.lang.String	GetWSObjectMiniHelp()
java.lang.String	GetWSObjectTitle()
XPArrayList	GetWSViews() Returns the arraylist of views that are registered IWSSubModels...
void	RegisterWSPage(java.lang.String strDPName) This method is used to register a new WSPluginDP with this WebService main model.
void	RegisterWSSubModel(java.lang.String strPluginModelStorageName) This method is used to register a new submodel with this WebService main model.
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.
protected void	SetupPageletSettings() This method sets various required pagelet settings, such as always sending the csp-login token.
void	SetWSMode(int nWSMode) Sets the nWSMode.
void	UpdateWSSubModels()

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, DoTaskAfterStore, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, 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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Object Name

See Also:

Constant Field Values

WSMODE_NONE

public static final int WSMODE_NONE

The additional display modes this WebService Editor can be in. This mostly depends on the Web Service Type.

See Also:

Constant Field Values

WSMODE_PORTLET

public static final int WSMODE_PORTLET

See Also:

Constant Field Values

WSMODE_INTRINSIC_PORTLET

public static final int WSMODE_INTRINSIC_PORTLET

See Also:

Constant Field Values

WSMODE_AWS

public static final int WSMODE_AWS

See Also:

Constant Field Values

WSMODE_CWS

public static final int WSMODE_CWS

See Also:

Constant Field Values

WSMODE_SWS

public static final int WSMODE_SWS

See Also:

Constant Field Values

WSMODE_PWS

public static final int WSMODE_PWS

See Also:

Constant Field Values

WSMODE_MWS

public static final int WSMODE_MWS

See Also:

Constant Field Values

WSMODE_PAGELET

public static final int WSMODE_PAGELET

See Also:

Constant Field Values

Constructor Detail

WebServiceModel

public WebServiceModel()

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

Description copied from class: EditorModel

That method contains the code that should be executed just before the object is stored in the DB.

Overrides:

DoTaskBeforeStore in class EditorModel

See Also:

EditorModel.DoTaskBeforeStore()

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

See Also:

com.plumtree.uiinfrastructure.editor.EditorModel#DoTaskOnStartEditor(_htFormData)

GetName

public java.lang.String GetName()

Description copied from class: EditorModel

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

See Also:

IMVCObject.GetName()

GetWSMode

public int GetWSMode()

Returns the nWSMode.

Returns:

int

GetWSObjectTitle

public java.lang.String GetWSObjectTitle()

GetWSObjectMiniHelp

public java.lang.String GetWSObjectMiniHelp()

GetWSViews

public XPArrayList GetWSViews()

Returns the arraylist of views that are registered IWSSubModels...

RegisterWSPage

public void RegisterWSPage(java.lang.String strDPName)

This method is used to register a new WSPluginDP with this WebService main model. This is done so that plugin pages can be hidden and shown automatically depending on the WSMODE.

RegisterWSSubModel

public void RegisterWSSubModel(java.lang.String strPluginModelStorageName)

This method is used to register a new submodel with this WebService main model. This is done so that submodels can have access to the Remote Server base URL which is necessary for them to display. All submodels that are registered must support the IWSSubModel interface.

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Description copied from class: ObjEditorModel

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Overrides:

SavePage in class ObjEditorModel

Returns:

int Page status for server side validation

See Also:

IRepostModel.SavePage(String, XPHashtable)

SetWSMode

public void SetWSMode(int nWSMode)

Sets the nWSMode.

Parameters:

nWSMode - The nWSMode to set

UpdateWSSubModels

public void UpdateWSSubModels()

SetupPageletSettings

protected void SetupPageletSettings()

This method sets various required pagelet settings, such as always sending the csp-login token.

GetEnsembleRemoteServer

protected int GetEnsembleRemoteServer()

Returns:

the Object ID of the Ensemble Remote Server.

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:

com.plumtree.portaluiinfrastructure.editor.ObjEditorModel#SetMemberVariablesFromQS(com.plumtree.openfoundation.util.XPHashtable)