com.plumtree.portalpages.ext.providers.incomingnetworksearch
Class NetSearchModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.ext.providers.incomingnetworksearch.NetSearchModel

All Implemented Interfaces:

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

public class NetSearchModel
extends ObjEditorModel
implements INetSearchModelRO

This class is the model for the Federated Search (inbound) editor

Author:

JohnH

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME The 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

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

Constructor Summary

NetSearchModel()

Method Summary

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.
boolean	GetAllowGuestAccess() Returns true if Guests are allowed to search this serving networked portal.
int	GetExpirationMinutes() Returns the duration in minutes before links returned by a network search become invalid.
java.lang.Object[]	GetExposedAuthSources() Returns the Auth Sources containing users that will be allowed to search this serving networked portal.
java.lang.Object[]	GetExposedUserGroups() Returns the User Groups containing users that will be allowed to search this serving network portal.
java.lang.String	GetFederatedPortalIdentity() Returns the identity other portals will use when addressing this serving networked portal.
java.lang.String	GetName() Returns the Class name.
java.lang.String	GetPortalAuthPassword() Returns the password used by a requesting portal to validate its identity with this serving networked portal.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetAllowGuestAccess(boolean bAllowGuestAccess) Sets whether Guests are allowed to search this serving networked portal.
void	SetExpirationMinutes(int expirationMinutes) Sets the duration in minutes before links returned by a network search become invalid.
void	SetExposedAuthSources(java.lang.Object[] exposedAuthSources) Sets the Auth Sources containing users that will be allowed to search this serving networked portal.
void	SetExposedUserGroups(java.lang.Object[] exposedUserGroups) Sets the User Groups containing users that will be allowed to search this serving network portal.
void	SetFederatedPortalIdentity(java.lang.String federatedPortalIdentity) Sets the identity other portals will use when addressing this serving networked portal.
void	SetPortalAuthPassword(java.lang.String portalAuthPassword) Sets the password used by a requesting portal to validate its identity with this serving networked portal.
void	StartSelectPTAuthSrc() Helper method to start the Select PTObject List.
void	StartSelectPTGroup() Helper method to start the Select PTObject List.

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

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

Cancel, CleanupAllData, CleanupTempData, 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

The unique identifier for the class

See Also:

Constant Field Values

Constructor Detail

NetSearchModel

public NetSearchModel()

Method Detail

SetAllowGuestAccess

public void SetAllowGuestAccess(boolean bAllowGuestAccess)

Sets whether Guests are allowed to search this serving networked portal.

Parameters:

allowGuestAccess - The allowGuestAccess to set

GetAllowGuestAccess

public boolean GetAllowGuestAccess()

Returns true if Guests are allowed to search this serving networked portal.

Specified by:

GetAllowGuestAccess in interface INetSearchModelRO

Returns:

boolean

SetExpirationMinutes

public void SetExpirationMinutes(int expirationMinutes)

Sets the duration in minutes before links returned by a network search become invalid.

Parameters:

expirationMinutes - The expirationMinutes to set

GetExpirationMinutes

public int GetExpirationMinutes()

Returns the duration in minutes before links returned by a network search become invalid.

Specified by:

GetExpirationMinutes in interface INetSearchModelRO

Returns:

int

SetExposedAuthSources

public void SetExposedAuthSources(java.lang.Object[] exposedAuthSources)

Sets the Auth Sources containing users that will be allowed to search this serving networked portal.

Parameters:

exposedAuthSources - The exposedAuthSources to set

GetExposedAuthSources

public java.lang.Object[] GetExposedAuthSources()

Returns the Auth Sources containing users that will be allowed to search this serving networked portal.

Specified by:

GetExposedAuthSources in interface INetSearchModelRO

Returns:

Object[]

SetExposedUserGroups

public void SetExposedUserGroups(java.lang.Object[] exposedUserGroups)

Sets the User Groups containing users that will be allowed to search this serving network portal.

Parameters:

exposedUserGroups - The exposedUserGroups to set

GetExposedUserGroups

public java.lang.Object[] GetExposedUserGroups()

Returns the User Groups containing users that will be allowed to search this serving network portal.

Specified by:

GetExposedUserGroups in interface INetSearchModelRO

Returns:

Object[]

SetFederatedPortalIdentity

public void SetFederatedPortalIdentity(java.lang.String federatedPortalIdentity)

Sets the identity other portals will use when addressing this serving networked portal.

Parameters:

federatedPortalIdentity - The FederatedPortalIdentity to set

GetFederatedPortalIdentity

public java.lang.String GetFederatedPortalIdentity()

Returns the identity other portals will use when addressing this serving networked portal.

Specified by:

GetFederatedPortalIdentity in interface INetSearchModelRO

Returns:

String

SetPortalAuthPassword

public void SetPortalAuthPassword(java.lang.String portalAuthPassword)

Sets the password used by a requesting portal to validate its identity with this serving networked portal.

Parameters:

portalAuthPassword - The portalAuthPassword to set

GetPortalAuthPassword

public java.lang.String GetPortalAuthPassword()

Returns the password used by a requesting portal to validate its identity with this serving networked portal.

Specified by:

GetPortalAuthPassword in interface INetSearchModelRO

Returns:

String

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

StartSelectPTAuthSrc

public void StartSelectPTAuthSrc()

Helper method to start the Select PTObject List.

StartSelectPTGroup

public void StartSelectPTGroup()

Helper method to start the Select PTObject List.