com.plumtree.portalpages.ext.providers.outgoingnetworksearch
Class OutgoingNSModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.ext.providers.outgoingnetworksearch.OutgoingNSModel

All Implemented Interfaces:

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

public class OutgoingNSModel
extends ObjEditorModel
implements IOutgoingNSModelRO

This class implements the model for the Federated Search Listener object.

Author:

JohnH

Field Summary

static int	MAPLIST_NUMCOLUMNS The number of columns in the multicolumn list
static int	MAPLIST_PTOBJECTPOSITION The position for the PT Object column in the multicolumn list
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.
static java.lang.String	STR_MVC_CLASS_NAME Unique identifier for the class

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

m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

OutgoingNSModel()

Method Summary

boolean	CheckEditorAccessAndStart(XPHashtable _htFormData) Retrieves the Web Service ID and initializes the Data Source.
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 before the object is stored.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Code executed when the Editor is starting.
int	GetCreatorID() Returns the creatorID.
java.lang.String	GetName() Returns the Class name.
int	GetPMode() Returns the nPMode.
java.lang.String	GetPortalAuthPassword() Returns the portal authentication password.
java.lang.String	GetThisPortalIdentity() Returns the string that uniquely identifies this portal to incoming portals.
java.lang.Object[]	GetUserGroups() Returns the User Groups used in the groups to names map.
java.lang.Object[]	GetUserNames() Returns the user names used in the groups to names map.
int	GetWebServiceID() Returns the webServiceID.
boolean	GetXUIEnabled() Returns the m_bXUIEnabled.
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	SetPortalAuthPassword(java.lang.String portalAuthPassword) Sets the portal authentication password.
void	SetThisPortalIdentity(java.lang.String thisPortalIdentity) Sets the the string that uniquely identifies this portal to incoming portals.
void	SetUserGroups(java.lang.Object[] userGroups) Sets the user groups used in the groups to user names map.
void	SetUserNames(java.lang.Object[] userNames) Sets the user names used in the groups to names map.
void	SetWebServiceID(int webServiceID) Sets the webServiceID.
void	StartSelectPTGroup() Helper method to start the Select PTObject List.

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, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

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

Cancel, CleanupAllData, CleanupTempData, DoTaskOnChangePage, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, 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, GetHideLeftNav, GetIsEditorReadOnly

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Unique identifier for the class

See Also:

Constant Field Values

MAPLIST_NUMCOLUMNS

public static final int MAPLIST_NUMCOLUMNS

The number of columns in the multicolumn list

See Also:

Constant Field Values

MAPLIST_PTOBJECTPOSITION

public static final int MAPLIST_PTOBJECTPOSITION

The position for the PT Object column in the multicolumn list

See Also:

Constant Field Values

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

OutgoingNSModel

public OutgoingNSModel()

Method Detail

SetPortalAuthPassword

public void SetPortalAuthPassword(java.lang.String portalAuthPassword)

Sets the portal authentication password.

Parameters:

portalAuthPassword - The portalAuthPassword to set

GetPortalAuthPassword

public java.lang.String GetPortalAuthPassword()

Returns the portal authentication password.

Specified by:

GetPortalAuthPassword in interface IOutgoingNSModelRO

Returns:

String

SetThisPortalIdentity

public void SetThisPortalIdentity(java.lang.String thisPortalIdentity)

Sets the the string that uniquely identifies this portal to incoming portals.

Parameters:

thisPortalIdentity - The thisPortalIdentity to set

GetThisPortalIdentity

public java.lang.String GetThisPortalIdentity()

Returns the string that uniquely identifies this portal to incoming portals.

Specified by:

GetThisPortalIdentity in interface IOutgoingNSModelRO

Returns:

String

SetUserGroups

public void SetUserGroups(java.lang.Object[] userGroups)

Sets the user groups used in the groups to user names map.

Parameters:

userGroups - The userGroups to set

GetUserGroups

public java.lang.Object[] GetUserGroups()

Returns the User Groups used in the groups to names map.

Specified by:

GetUserGroups in interface IOutgoingNSModelRO

Returns:

Object[]

SetUserNames

public void SetUserNames(java.lang.Object[] userNames)

Sets the user names used in the groups to names map.

Parameters:

userNames - The userNames to set

GetUserNames

public java.lang.Object[] GetUserNames()

Returns the user names used in the groups to names map.

Specified by:

GetUserNames in interface IOutgoingNSModelRO

Returns:

Object[]

SetWebServiceID

public void SetWebServiceID(int webServiceID)

Sets the webServiceID.

Parameters:

webServiceID - The webServiceID to set

GetWebServiceID

public int GetWebServiceID()

Returns the webServiceID.

Specified by:

GetWebServiceID in interface IOutgoingNSModelRO

Returns:

int

CheckEditorAccessAndStart

public boolean CheckEditorAccessAndStart(XPHashtable _htFormData)

Retrieves the Web Service ID and initializes the Data Source.

Overrides:

CheckEditorAccessAndStart in class ObjEditorModel

Parameters:

_htFormData -

Returns:

boolean Is true if the current user has the rights to access this Editor.

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 before the object is stored.

Overrides:

DoTaskBeforeStore in class EditorModel

Throws:

XPException

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Code executed when the Editor is starting.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

Throws:

XPException

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

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

StartSelectPTGroup

public void StartSelectPTGroup()

Helper method to start the Select PTObject List.

GetXUIEnabled

public boolean GetXUIEnabled()

Returns the m_bXUIEnabled.

Specified by:

GetXUIEnabled in interface IOutgoingNSModelRO

Returns:

boolean

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