com.plumtree.portaluiinfrastructure.helpers
Interface IPathwaysHelper

All Known Implementing Classes:

PathwaysHelperService

public interface IPathwaysHelper

The IPathwaysHelper handles common functionality related to Pathways integrations.

Method Summary

int	GetAPIWebServiceID(IPTSession _session)
boolean	GetLegacySearchMode() This is for advanced search, since it will fall back to legacy search if a search request is not valid for a pathways search even though it's enabled and without error
boolean	IsErrorState()
boolean	IsPathwaysInstalled(IPTSession _session)
void	SetLegacySearchMode(boolean value)
void	StartErrorState() When a Pathways search server issue occurs, this sets timeout value for when to use Pathways again

Method Detail

IsPathwaysInstalled

boolean IsPathwaysInstalled(IPTSession _session)

Parameters:

_session - the current user session.

Returns:

whether or not Ensemble is installed.

GetAPIWebServiceID

int GetAPIWebServiceID(IPTSession _session)

Parameters:

_session - the current user session.

Returns:

the ID of the Pathways API web service. -1 if it is not installed.

StartErrorState

void StartErrorState()

When a Pathways search server issue occurs, this sets timeout value for when to use Pathways again

IsErrorState

boolean IsErrorState()

Returns:

whether or not Pathways timeout has expired. Returns true if the time out still occurs and false if the timeout expired and we can try Pathways again.

SetLegacySearchMode

void SetLegacySearchMode(boolean value)

Parameters:

value - the boolean value representing if the search is in fall back to legacy mode

GetLegacySearchMode

boolean GetLegacySearchMode()

This is for advanced search, since it will fall back to legacy search if a search request is not valid for a pathways search even though it's enabled and without error

Returns:

the boolean value if the search is currently defaulting to legacy mode