com.plumtree.portaluiinfrastructure.helpers
Class CollaborationHelperService

java.lang.Object
  com.plumtree.portaluiinfrastructure.helpers.CollaborationHelperService

All Implemented Interfaces:

ICollaborationHelper

public class CollaborationHelperService
extends java.lang.Object
implements ICollaborationHelper

Author:

Administrator

Field Summary

static java.lang.String	COLLAB_WEB_SERVICE_UUID This is used to lookup the Collab web service instance.
protected static int	TIMEOUT The timeout for caching the web service data, in seconds.

Method Summary

static ICollaborationHelper	getInstance()
int	GetWebServiceID(IPTSession _session)
boolean	IsCollaborationInstalled(IPTSession _session)
protected void	LoadCollaborationWebService(IPTSession _session) Load the collab web service, if installed.
static void	setTestInstance(ICollaborationHelper testHelper) Unit tests should use this method to overwrite/teardown existing helper singleton.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COLLAB_WEB_SERVICE_UUID

public static final java.lang.String COLLAB_WEB_SERVICE_UUID

This is used to lookup the Collab web service instance. "Notification Gateway Entry" is the actual name of web service I grabbed this UUID from, when you install the collaboration.pte.

See Also:

Constant Field Values

TIMEOUT

protected static final int TIMEOUT

The timeout for caching the web service data, in seconds.

See Also:

Constant Field Values

Method Detail

getInstance

public static ICollaborationHelper getInstance()

Returns:

The singleton PT config helper.

setTestInstance

public static void setTestInstance(ICollaborationHelper testHelper)

Unit tests should use this method to overwrite/teardown existing helper singleton. DO NOT USE for production code. NOTE: When finished with a unit test, this should be set back to null so as not to interfere with other tests.

LoadCollaborationWebService

protected void LoadCollaborationWebService(IPTSession _session)

Load the collab web service, if installed. This handles cache timeouts and lazy initialization.

IsCollaborationInstalled

public boolean IsCollaborationInstalled(IPTSession _session)

Specified by:

IsCollaborationInstalled in interface ICollaborationHelper

Parameters:

_session - the current user session.

Returns:

whether or not Collab is installed.

GetWebServiceID

public int GetWebServiceID(IPTSession _session)

Specified by:

GetWebServiceID in interface ICollaborationHelper

Parameters:

_session - the current user session.

Returns:

the ID of the Web Service ID. -1 if it is not installed.