com.tsgrp.opencontent.workshare.util

Class WorkshareCompareUtil

java.lang.Object

com.tsgrp.opencontent.workshare.util.WorkshareCompareUtil

public class WorkshareCompareUtil
extends java.lang.Object

Utility class for WorkshareCompare functionality in OC

Copyright © Technology Services Group, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	apiURL
protected static java.lang.String	workshareCompareVersionDoc Determines if the user wants to compare a document to the most recent major or minor version.

Constructor Summary

Constructors

Constructor and Description
WorkshareCompareUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	cacheComparison(java.lang.String docId, java.lang.String prevDocId) Takes in the current document ID and the previous version document ID and creates a repo object whose content is the comparison, of the two document IDs.
static byte[]	executeComparison(java.lang.String ticket, java.lang.String primaryId, java.lang.String modifiedId)
static java.lang.String	getApiURL() String that contains the URL for the API
static java.lang.String	getCachedCompareContent(java.lang.String ticket, java.lang.String docId) Takes in a document ID and returns a workshare compare document ID.
protected static byte[]	getContentByteArray(java.lang.String ticket, EnhancedCompleteObject eco)
static void	setApiURL(java.lang.String apiURL)
void	setWorkshareCompareVersionDoc(java.lang.String workshareCompareVersionDoc)

Methods inherited from class java.lang.Object

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

Field Detail

apiURL

protected static java.lang.String apiURL

workshareCompareVersionDoc

protected static java.lang.String workshareCompareVersionDoc

Determines if the user wants to compare a document to the most recent major or minor version.

Constructor Detail

WorkshareCompareUtil

public WorkshareCompareUtil()

Method Detail

getApiURL

public static java.lang.String getApiURL()

String that contains the URL for the API

setApiURL

public static void setApiURL(java.lang.String apiURL)

setWorkshareCompareVersionDoc

public void setWorkshareCompareVersionDoc(java.lang.String workshareCompareVersionDoc)

executeComparison

public static byte[] executeComparison(java.lang.String ticket,
                                       java.lang.String primaryId,
                                       java.lang.String modifiedId)

getCachedCompareContent

public static java.lang.String getCachedCompareContent(java.lang.String ticket,
                                                       java.lang.String docId)

Takes in a document ID and returns a workshare compare document ID. When this method is called, it calls a method to retrieve the previous document version ID. Once that ID is returned, it then calls a method to perform the document comparison.

Parameters:

ticket - OC ticket

docId - the original document ID

Returns:

Returns the document ID for the workshare compare document.

cacheComparison

public static boolean cacheComparison(java.lang.String docId,
                                      java.lang.String prevDocId)

Takes in the current document ID and the previous version document ID and creates a repo object whose content is the comparison, of the two document IDs. Comparison only takes place if the documents are in the same version tree.

Parameters:

docId - the original document ID

prevDocId - the previous major or minor version document ID

Returns:

True if the comparison document was cached successfully, false otherwise.

getContentByteArray

protected static byte[] getContentByteArray(java.lang.String ticket,
                                            EnhancedCompleteObject eco)