|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.helpers.PathwaysHelperService
public class PathwaysHelperService
This class handles common functionality related to Pathways integrations. NOTE: This class is threadsafe.
Field Summary | |
---|---|
static java.lang.String |
PATHWAYS_API_WEBSERVICE_UUID
This is used to lookup the Pathways API web service instance for making calls to Pathways. |
protected static int |
TIMEOUT
The timeout for caching the Web Service data, in seconds. |
Method Summary | |
---|---|
int |
GetAPIWebServiceID(IPTSession _session)
|
static IPathwaysHelper |
GetInstance()
|
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 |
protected int |
GetTimeout()
|
boolean |
IsErrorState()
|
boolean |
IsPathwaysInstalled(IPTSession _session)
|
protected void |
LoadPathwaysAPIWebService(IPTSession _session)
Load the Pathways API Web Service, if installed. |
void |
SetLegacySearchMode(boolean value)
|
static void |
SetTestInstance(IPathwaysHelper testHelper)
Unit tests should use this method to overwrite/teardown existing helper singleton. |
void |
StartErrorState()
When a Pathways search server issue occurs, this sets timeout value for when to use Pathways again |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PATHWAYS_API_WEBSERVICE_UUID
protected static final int TIMEOUT
Method Detail |
---|
public static IPathwaysHelper GetInstance()
public static void SetTestInstance(IPathwaysHelper testHelper)
protected void LoadPathwaysAPIWebService(IPTSession _session)
protected int GetTimeout()
public boolean IsPathwaysInstalled(IPTSession _session)
IsPathwaysInstalled
in interface IPathwaysHelper
_session
- the current user session.
public int GetAPIWebServiceID(IPTSession _session)
GetAPIWebServiceID
in interface IPathwaysHelper
_session
- the current user session.
public void StartErrorState()
StartErrorState
in interface IPathwaysHelper
public boolean IsErrorState()
IsErrorState
in interface IPathwaysHelper
public void SetLegacySearchMode(boolean value)
SetLegacySearchMode
in interface IPathwaysHelper
value
- the boolean value representing if the search is in fall back to legacy modepublic boolean GetLegacySearchMode()
GetLegacySearchMode
in interface IPathwaysHelper
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |