com.plumtree.portalpages.browsing.search.network
Interface INetworkSearchModelRO

All Superinterfaces:

IModelRO, IMVCObject

All Known Implementing Classes:

NetworkSearchModel

public interface INetworkSearchModelRO
extends IModelRO

Author:

JosephSi

Method Summary

boolean	AreAllResultSetsValid()
java.lang.String	GetDescriptionForResultFromSource(int sourceId, int resultId)
java.lang.String	GetErrorFromSource(int sourceId)
HTMLElement	GetErrorLinkFromSource(int sourceID) certain errors lead to the generation of a link to a config page where the problem can be fixed, in which case this returns the link.
int	GetFirstDisplayedResultFromSource(int sourceId)
int	GetFirstDisplayedResultOverall()
java.lang.String	GetFormattedError(int sourceId)
HTMLImg	GetImageForResultFromSource(int sourceId, int resultId)
XPHashtable	GetLocationPreferencesForUser() check to see if the user has any stored preferences regarding which sources to check.
int	GetNumberResults()
int	GetNumDisplayedResultsFromSource(int sourceId)
int	GetNumDisplayedResultsOverall()
int	GetNumResultsFromSource(int sourceId)
int	GetNumResultsOverall()
int	GetNumSources()
int	GetPageNum()
IXPList	GetSearchedSources()
java.lang.String	GetSearchString()
boolean	GetSearchStringTruncated() A flag indicating whether we had to truncate the user's search string to NetworkSearchModel.MAX_SEARCHSTRING_LENGTH characters
int	GetSourceID(int index)
java.lang.String	GetSourceName(int index)
java.lang.String	GetTitleForResultFromSource(int sourceId, int resultId)
java.lang.String	GetUnencodedSearchString() gets search string without html encoding (we need this to avoid double-encoding, since some of the HTMLElement classes do the encoding for you
HTMLAnchor	GetURLForResultFromSource(int sourceId, int resultId, boolean popup)
java.lang.String	GetViewMode()
boolean	IsDisabled(int objectID) returns true if the fed portal's associated web service has been disabled
boolean	isResultSetValid(int sourceId)
void	SetNumberResults(int num)

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Method Detail

isResultSetValid

boolean isResultSetValid(int sourceId)

Parameters:

sourceId -

Returns:

GetFormattedError

java.lang.String GetFormattedError(int sourceId)

Parameters:

sourceId -

Returns:

AreAllResultSetsValid

boolean AreAllResultSetsValid()

Returns:

GetDescriptionForResultFromSource

java.lang.String GetDescriptionForResultFromSource(int sourceId,
                                                   int resultId)

Parameters:

sourceId -

resultId -

Returns:

GetErrorFromSource

java.lang.String GetErrorFromSource(int sourceId)

Parameters:

sourceId -

Returns:

GetFirstDisplayedResultFromSource

int GetFirstDisplayedResultFromSource(int sourceId)

Parameters:

sourceId -

Returns:

GetFirstDisplayedResultOverall

int GetFirstDisplayedResultOverall()

Returns:

GetImageForResultFromSource

HTMLImg GetImageForResultFromSource(int sourceId,
                                    int resultId)

Parameters:

sourceId -

resultId -

Returns:

GetNumDisplayedResultsFromSource

int GetNumDisplayedResultsFromSource(int sourceId)

Parameters:

sourceId -

Returns:

GetNumDisplayedResultsOverall

int GetNumDisplayedResultsOverall()

Returns:

GetNumResultsFromSource

int GetNumResultsFromSource(int sourceId)

Parameters:

sourceId -

Returns:

GetNumResultsOverall

int GetNumResultsOverall()

Returns:

GetNumSources

int GetNumSources()

Returns:

GetPageNum

int GetPageNum()

Returns:

GetSearchString

java.lang.String GetSearchString()

Returns:

GetUnencodedSearchString

java.lang.String GetUnencodedSearchString()

gets search string without html encoding (we need this to avoid double-encoding, since some of the HTMLElement classes do the encoding for you

GetSearchedSources

IXPList GetSearchedSources()

Returns:

GetSourceID

int GetSourceID(int index)

Parameters:

index -

Returns:

GetSourceName

java.lang.String GetSourceName(int index)

Parameters:

index -

Returns:

GetTitleForResultFromSource

java.lang.String GetTitleForResultFromSource(int sourceId,
                                             int resultId)

Parameters:

sourceId -

resultId -

Returns:

GetURLForResultFromSource

HTMLAnchor GetURLForResultFromSource(int sourceId,
                                     int resultId,
                                     boolean popup)

Parameters:

sourceId -

resultId -

Returns:

GetViewMode

java.lang.String GetViewMode()

Returns:

GetLocationPreferencesForUser

XPHashtable GetLocationPreferencesForUser()

check to see if the user has any stored preferences regarding which sources to check. Note: returns null if there are no such preferences

GetSearchStringTruncated

boolean GetSearchStringTruncated()

A flag indicating whether we had to truncate the user's search string to NetworkSearchModel.MAX_SEARCHSTRING_LENGTH characters

IsDisabled

boolean IsDisabled(int objectID)

returns true if the fed portal's associated web service has been disabled

GetErrorLinkFromSource

HTMLElement GetErrorLinkFromSource(int sourceID)

certain errors lead to the generation of a link to a config page where the problem can be fixed, in which case this returns the link. Otherwise, this method will return null

SetNumberResults

void SetNumberResults(int num)

GetNumberResults

int GetNumberResults()