|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPathwaysRestAPIService
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 |
---|
boolean IsPathwaysEnabled()
java.lang.String GetPathwaysAPIBaseURL(IPTSession session)
session
- the current user session.
java.lang.String GetPathwaysAPIGatewayedURL(AActivitySpace space, IPTSession session)
session
- the current user session.
PathwaysViewsRestData[] GetViews()
PathwaysTagRestData[] GetTagCloud(java.lang.String view, java.lang.String format, java.lang.String query, java.lang.String tagCount)
view
- the Pathways view to use when retrieving the Tag Cloudformat
- the payload format of the responsequery
- the Pathways search querytagCount
- the maximum number of tags to return for the Tag Cloud
PathwaysSearchRestData[] DoSearch(PathwaysQueryArguments pathwaysQueryArguments)
view
- the Pathways view to use when retrieving the Tag Cloudformat
- the payload format of the responsequery
- the Pathways search querytagCount
- the maximum number of tags to return for the Tag CloudobjectTypes
- restrict the objects to search for in pathways
void AddRemoveTagRest(java.lang.String tname, java.lang.String fullId, int action, java.lang.String ptsource)
tname
- Name of the Tag on Which to take actionfullId
- Complete ID (CLASSID_DOCUMENTID) of the Document the tag is related toaction
- 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.void RenameTagRest(java.lang.String tname, java.lang.String fullId, java.lang.String ptsource, java.lang.String renametag)
tname
- the Source Tag Name to be used for renamingfullId
- Complete ID (CLASSID_DOCUMENTID) of the Document the tag is related toptsource
- 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 renamingint GetTotalCount()
boolean IsAdaptiveLayoutMode()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |