com.plumtree.portaluiinfrastructure.restconsumerframework.pathways
Interface IPathwaysRestAPIService

All Known Implementing Classes:

PathwaysRestAPIService

public interface IPathwaysRestAPIService

Author:

BobbyT

Method Summary

void	AddRemoveTagRest(java.lang.String tname, java.lang.String fullId, int action, java.lang.String ptsource) This Method is used to Add/Remove a Pathways Tag on a particular document.
PathwaysSearchRestData[]	DoSearch(PathwaysQueryArguments pathwaysQueryArguments) Returns a list of search results from a Pathways search query.
java.lang.String	GetPathwaysAPIBaseURL(IPTSession session) Gets the Pathways API base URL from the Pathways API Web Service object
java.lang.String	GetPathwaysAPIGatewayedURL(AActivitySpace space, IPTSession session) Gets the Pathways API Gatewayed URL from the Pathways API Web Service object This is used when making Pathways API calls on the client side via JSON.
PathwaysTagRestData[]	GetTagCloud(java.lang.String view, java.lang.String format, java.lang.String query, java.lang.String tagCount) Returns a Tag Cloud from a Pathways search query.
int	GetTotalCount() Returns the total count of search results returned
PathwaysViewsRestData[]	GetViews() Returns a list of Pathways Views from Pathways Rest API.
boolean	IsAdaptiveLayoutMode() Returns if the current user experience supports adaptive layout mode
boolean	IsPathwaysEnabled() Checks if Pathways service is enabled from the config settings.
void	RenameTagRest(java.lang.String tname, java.lang.String fullId, java.lang.String ptsource, java.lang.String renametag) This Method is used to Rename a Pathways Tag on a particular document.

Method Detail

IsPathwaysEnabled

boolean IsPathwaysEnabled()

Checks if Pathways service is enabled from the config settings.

Returns:

true if Pathways is enabled, otherwise false.

GetPathwaysAPIBaseURL

java.lang.String GetPathwaysAPIBaseURL(IPTSession session)

Gets the Pathways API base URL from the Pathways API Web Service object

Parameters:

session - the current user session.

Returns:

the URL to the Pathways API Web Service, null if service is not installed.

GetPathwaysAPIGatewayedURL

java.lang.String GetPathwaysAPIGatewayedURL(AActivitySpace space,
                                            IPTSession session)

Gets the Pathways API Gatewayed URL from the Pathways API Web Service object This is used when making Pathways API calls on the client side via JSON.

Parameters:

session - the current user session.

Returns:

the gatewayed URL to the Pathways API Web Service, null if service is not installed.

GetViews

PathwaysViewsRestData[] GetViews()

Returns a list of Pathways Views from Pathways Rest API.

Returns:

a list of PathwaysViewsRestData

GetTagCloud

PathwaysTagRestData[] GetTagCloud(java.lang.String view,
                                  java.lang.String format,
                                  java.lang.String query,
                                  java.lang.String tagCount)

Returns a Tag Cloud from a Pathways search query.

Parameters:

view - the Pathways view to use when retrieving the Tag Cloud

format - the payload format of the response

query - the Pathways search query

tagCount - the maximum number of tags to return for the Tag Cloud

Returns:

DoSearch

PathwaysSearchRestData[] DoSearch(PathwaysQueryArguments pathwaysQueryArguments)

Returns a list of search results from a Pathways search query.

Parameters:

view - the Pathways view to use when retrieving the Tag Cloud

format - the payload format of the response

query - the Pathways search query

tagCount - the maximum number of tags to return for the Tag Cloud

objectTypes - restrict the objects to search for in pathways

Returns:

array of PathwaysSearchRestData

AddRemoveTagRest

void AddRemoveTagRest(java.lang.String tname,
                      java.lang.String fullId,
                      int action,
                      java.lang.String ptsource)

This Method is used to Add/Remove a Pathways Tag on a particular document. This uses Pathways REST API to connect to Pathways and execute the requested action.

Parameters:

tname - Name of the Tag on Which to take action

fullId - Complete ID (CLASSID_DOCUMENTID) of the Document the tag is related to

action - Action Operation to perform on the tag, 0 = Add, 1 = Delete, 2 = Edit (delete old tag and add new tag)

ptsource - Source of the Object, for Portal it is 'PTPORTAL' and collab it is 'PTCOLLAB'. More sources are in PathwaysConstants.

RenameTagRest

void RenameTagRest(java.lang.String tname,
                   java.lang.String fullId,
                   java.lang.String ptsource,
                   java.lang.String renametag)

This Method is used to Rename a Pathways Tag on a particular document. This uses Pathways REST API to connect to Pathways and execute the requested action.

Parameters:

tname - the Source Tag Name to be used for renaming

fullId - Complete ID (CLASSID_DOCUMENTID) of the Document the tag is related to

ptsource - Source of the Object, for Portal it is 'PTPORTAL' and collab it is 'PTCOLLAB'. More sources are in PathwaysConstants.

renametag - the Target Tag Name to be used for renaming

GetTotalCount

int GetTotalCount()

Returns the total count of search results returned

IsAdaptiveLayoutMode

boolean IsAdaptiveLayoutMode()

Returns if the current user experience supports adaptive layout mode

Returns: