com.plumtree.portalpages.admin.editors.webservice.plugins
Class AdvSettingsPluginModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.portalpages.admin.editors.webservice.plugins.AdvSettingsPluginModel

All Implemented Interfaces:

IWSSubModel, IAdvSettingsPluginModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class AdvSettingsPluginModel
extends EditorHelperModel
implements IAdvSettingsPluginModelRO, IWSSubModel

Author:

adolfoc

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel

m_asOwner

Constructor Summary

AdvSettingsPluginModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskBeforeWSStore() Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.
void	DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID, java.lang.String strRemoteServerName, java.lang.String strRemoteServerBaseURL) Called when the Remote Server is changed.
void	DoTaskOnWSModeUpdate(int nNewWSMode) Called when the Web Service type is changed.
boolean	GetCardSubmitFilePath() Whether or not to support card submission via file path (CWS Only).
boolean	GetCardSubmitRemoteUI() Whether or not to support card submission via remote UI (CWS Only).
java.lang.String	GetName() Returns the Class name.
boolean	GetRefreshButton() Whether or not portlets from this web service should show the refresh button
boolean	GetSendAlignment() Whether to send alignment to portlets.
boolean	GetSendCommunityACL() Whether or not to send a community ACL to the portlet.
boolean	GetSendLocale() Whether or not to send a locale to the portlet.
boolean	GetSendLoginToken() Whether or not to send a login token to the portlet.
boolean	GetSendPageID() Whether or not to send a pageid to the portlet.
boolean	GetSendSubportalID() Whether to send subportal id to portlets.
boolean	GetSendTimezone() Whether or not to send a timezone to the portlet.
boolean	GetSharedSession() Whether each portlet has its own HTTP session, or shares sessions with other portlets on the same remote server
boolean	GetSupportsACLImport() Whether or not this web service supports ACL Import
boolean	GetSupportsMirroring() Whether or not this web service supports folder mirroring
boolean	GetSupportsUpload() Whether or not this web service supports Document Upload
int	GetTokenTimeout() The duration of the timeout token (in minutes)
java.lang.String	GetValidationFunction() This returns the name of the client-side validation function that the model wants added to the page-level validation funtion.
int	GetWSMode() Returns our current WS display mode from the WebServiceModel.WSMODE enumeration.
void	InitWSModel(IPTWebService ptWebService) Initializes the sub-model.
int	SaveSection(XPHashtable _htFormData) Code to save the section represented by this Model.
void	SetSendPageID(boolean bSendPageID) Whether or not to send a pageid to the portlet.
void	SetTokenTimeout(int nTokenTimeout) The duration of the timeout token (in minutes)

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

CleanupAllData, CleanupTempData, Init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

AdvSettingsPluginModel

public AdvSettingsPluginModel()

Method Detail

Create

public java.lang.Object Create()

Description copied from class: EditorHelperModel

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 EditorHelperModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

DoTaskBeforeWSStore

public void DoTaskBeforeWSStore()

Description copied from interface: IWSSubModel

Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.

Specified by:

DoTaskBeforeWSStore in interface IWSSubModel

See Also:

IWSSubModel.DoTaskBeforeWSStore()

DoTaskOnRemoteServerUpdate

public void DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID,
                                       java.lang.String strRemoteServerName,
                                       java.lang.String strRemoteServerBaseURL)

Description copied from interface: IWSSubModel

Called when the Remote Server is changed. This is mostly used to update the base-url displayed before URL edit boxes.

Specified by:

DoTaskOnRemoteServerUpdate in interface IWSSubModel

See Also:

IWSSubModel.DoTaskOnRemoteServerUpdate(String, String, String)

DoTaskOnWSModeUpdate

public void DoTaskOnWSModeUpdate(int nNewWSMode)

Description copied from interface: IWSSubModel

Called when the Web Service type is changed.

Specified by:

DoTaskOnWSModeUpdate in interface IWSSubModel

See Also:

IWSSubModel.DoTaskOnWSModeUpdate(int)

GetCardSubmitFilePath

public boolean GetCardSubmitFilePath()

Whether or not to support card submission via file path (CWS Only).

Specified by:

GetCardSubmitFilePath in interface IAdvSettingsPluginModelRO

GetCardSubmitRemoteUI

public boolean GetCardSubmitRemoteUI()

Whether or not to support card submission via remote UI (CWS Only).

Specified by:

GetCardSubmitRemoteUI in interface IAdvSettingsPluginModelRO

GetName

public java.lang.String GetName()

Description copied from class: EditorHelperModel

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorHelperModel

Returns:

String

See Also:

IMVCObject.GetName()

GetSendCommunityACL

public boolean GetSendCommunityACL()

Whether or not to send a community ACL to the portlet.

Specified by:

GetSendCommunityACL in interface IAdvSettingsPluginModelRO

GetSendLoginToken

public boolean GetSendLoginToken()

Whether or not to send a login token to the portlet.

Specified by:

GetSendLoginToken in interface IAdvSettingsPluginModelRO

GetSendPageID

public boolean GetSendPageID()

Whether or not to send a pageid to the portlet.

Specified by:

GetSendPageID in interface IAdvSettingsPluginModelRO

GetSendTimezone

public boolean GetSendTimezone()

Whether or not to send a timezone to the portlet.

Specified by:

GetSendTimezone in interface IAdvSettingsPluginModelRO

GetSendLocale

public boolean GetSendLocale()

Whether or not to send a locale to the portlet.

Specified by:

GetSendLocale in interface IAdvSettingsPluginModelRO

GetSupportsMirroring

public boolean GetSupportsMirroring()

Whether or not this web service supports folder mirroring

Specified by:

GetSupportsMirroring in interface IAdvSettingsPluginModelRO

GetSupportsUpload

public boolean GetSupportsUpload()

Whether or not this web service supports Document Upload

Specified by:

GetSupportsUpload in interface IAdvSettingsPluginModelRO

GetSupportsACLImport

public boolean GetSupportsACLImport()

Whether or not this web service supports ACL Import

Specified by:

GetSupportsACLImport in interface IAdvSettingsPluginModelRO

GetTokenTimeout

public int GetTokenTimeout()

The duration of the timeout token (in minutes)

Specified by:

GetTokenTimeout in interface IAdvSettingsPluginModelRO

GetRefreshButton

public boolean GetRefreshButton()

Whether or not portlets from this web service should show the refresh button

Specified by:

GetRefreshButton in interface IAdvSettingsPluginModelRO

GetSharedSession

public boolean GetSharedSession()

Whether each portlet has its own HTTP session, or shares sessions with other portlets on the same remote server

Specified by:

GetSharedSession in interface IAdvSettingsPluginModelRO

Returns:

int

GetSendSubportalID

public boolean GetSendSubportalID()

Whether to send subportal id to portlets.

Specified by:

GetSendSubportalID in interface IAdvSettingsPluginModelRO

GetSendAlignment

public boolean GetSendAlignment()

Whether to send alignment to portlets.

Specified by:

GetSendAlignment in interface IAdvSettingsPluginModelRO

GetValidationFunction

public java.lang.String GetValidationFunction()

Description copied from interface: IWSSubModel

This returns the name of the client-side validation function that the model wants added to the page-level validation funtion. Models return null or "" if they don't have a validation function.

Specified by:

GetValidationFunction in interface IWSSubModel

See Also:

IWSSubModel.GetValidationFunction()

GetWSMode

public int GetWSMode()

Returns our current WS display mode from the WebServiceModel.WSMODE enumeration.

Specified by:

GetWSMode in interface IAdvSettingsPluginModelRO

InitWSModel

public void InitWSModel(IPTWebService ptWebService)

Description copied from interface: IWSSubModel

Initializes the sub-model. Provides an opportunity for the submodel to load it's state from the WebService.

Specified by:

InitWSModel in interface IWSSubModel

See Also:

com.plumtree.portalpages.admin.editors.webservice.IWSSubModel#InitWSModel()

SaveSection

public int SaveSection(XPHashtable _htFormData)

Description copied from class: EditorHelperModel

Code to save the section represented by this Model.

Specified by:

SaveSection in class EditorHelperModel

Parameters:

_htFormData - Form posted data.

Returns:

int Status for server side validation

See Also:

EditorHelperModel.SaveSection(XPHashtable)

SetSendPageID

public void SetSendPageID(boolean bSendPageID)

Whether or not to send a pageid to the portlet.

SetTokenTimeout

public void SetTokenTimeout(int nTokenTimeout)

The duration of the timeout token (in minutes)