com.ptc.wvs.client.beans
Class Markup

java.lang.Object
  com.ptc.wvs.client.beans.Markup

public class Markup

extends Object

Field Summary

private String	ErrorPrefix
private StringBuffer	result
private static boolean	SERVER
private static String	SERVER_CLASS
private static boolean	VERBOSE
private static WVSProperties	wvsProperties

Constructor Summary

Markup()

Method Summary

boolean	copyMkFile(String fromFile, String toFile)
boolean	createAnnotationSet(String WCID, String name, String description, String tag, Locale locale) Creates a new annotation set Supported API: false
static byte[]	decodeString(byte[] inBytes)
boolean	deleteAllAnnotationSets(String objectReference, Locale locale) Deletes All annotation sets Supported API: false
boolean	deleteAnnotationSet(String objectReference, Locale locale) Deletes an annotation set Supported API: false
boolean	getAnnotationTable(String WCID, String selectedID, String annTemplate, String emkTemplate, String lockTemplate) Returns the annotation set table (definition of the markups) for the specified representation Supported API: false
boolean	getAnnotationTableForClipboard(String WCIDS) Returns the annotation set table (definition of the markups) for the objects on the clipboard Supported API: false
String	getMarkupTempDir()
String	getMarkupUrl(String objectReference, String fileType) Returns the URL to the specific Markup Supported API: false
String	getResult()
String	getResultNoErrorPrefix()
String	getSaveURL(String info, String WCID, String userName, String passWord, String authorization, String portNo)
String	getSaveURL(String info, String WCID, String userName, String passWord, String authorization, String portNo, String file)
String	getTempFileName(String directory, String extension)
String	getViewFile(String markupref)
String	getViewStyle(String markupref)
boolean	isVerbose()
boolean	lockAnnotationSet(String objectReference, Locale locale) Locks an annotation set Supported API: false
boolean	processETB(String etbData) Extracts the data from the ETB file and associates it to the markup as additional info Supported API: false
private static int	raiseToPower(int i, int j)
boolean	saveMarkupContent(String objectReference, String name, String description, String fSpec, String fileType, Locale locale) Saves the content of the markup Supported API: false
boolean	setAllowCopyForward(String objectReference, boolean allowCopy, Locale locale) Set the allow copy forward flag on the Markup Supported API: false
void	setResult(String answer)
boolean	unlockAnnotationSet(String objectReference, Locale locale) Unlocks an annotation set Supported API: false
boolean	writeToFile(String fSpec, byte[] decodeData)

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_CLASS

private static final String SERVER_CLASS

SERVER

private static final boolean SERVER

ErrorPrefix

private final String ErrorPrefix

See Also:

Constant Field Values

result

private StringBuffer result

wvsProperties

private static WVSProperties wvsProperties

VERBOSE

private static boolean VERBOSE

Constructor Detail

Markup

public Markup()

Method Detail

isVerbose

public boolean isVerbose()

getResult

public String getResult()

getResultNoErrorPrefix

public String getResultNoErrorPrefix()

setResult

public void setResult(String answer)

getAnnotationTable

public boolean getAnnotationTable(String WCID,
                                  String selectedID,
                                  String annTemplate,
                                  String emkTemplate,
                                  String lockTemplate)

Returns the annotation set table (definition of the markups) for the specified representation

Supported API: false

Parameters:

WCID - The object reference of the Representation

selectedID - Indicate a specific Markup in the table

annTemplate - The annotation template

emkTemplate - The markup template

lockTemplate - The lock template

Returns:

boolean success if true

getAnnotationTableForClipboard

public boolean getAnnotationTableForClipboard(String WCIDS)

Returns the annotation set table (definition of the markups) for the objects on the clipboard

Supported API: false

Parameters:

WCIDS - The object references on the clipboard

Returns:

boolean success if true

getMarkupUrl

public String getMarkupUrl(String objectReference,
                           String fileType)

Returns the URL to the specific Markup

Supported API: false

Parameters:

objectReference - The object reference of the Markup

fileType - Either ast or gif

Returns:

String URL string to markup

createAnnotationSet

public boolean createAnnotationSet(String WCID,
                                   String name,
                                   String description,
                                   String tag,
                                   Locale locale)

Creates a new annotation set

Supported API: false

Parameters:

WCID - The object reference of the Representation

name - The name of the new markup

description - The description of the new markup

tag - Additional information

Returns:

boolean true if success

lockAnnotationSet

public boolean lockAnnotationSet(String objectReference,
                                 Locale locale)

Locks an annotation set

Supported API: false

Parameters:

objectReference - The object reference of the Markup

Returns:

boolean true if success

unlockAnnotationSet

public boolean unlockAnnotationSet(String objectReference,
                                   Locale locale)

Unlocks an annotation set

Supported API: false

Parameters:

objectReference - The object reference of the Markup

Returns:

boolean true if success

setAllowCopyForward

public boolean setAllowCopyForward(String objectReference,
                                   boolean allowCopy,
                                   Locale locale)

Set the allow copy forward flag on the Markup

Supported API: false

Parameters:

objectReference - The object reference of the Markup

allowCopy - the new copy state to be set

Returns:

boolean true if success

deleteAnnotationSet

public boolean deleteAnnotationSet(String objectReference,
                                   Locale locale)

Deletes an annotation set

Supported API: false

Parameters:

objectReference - The object reference of the Markup

Returns:

boolean true if success

deleteAllAnnotationSets

public boolean deleteAllAnnotationSets(String objectReference,
                                       Locale locale)

Deletes All annotation sets

Supported API: false

Parameters:

objectReference - The object reference

Returns:

boolean true if success

saveMarkupContent

public boolean saveMarkupContent(String objectReference,
                                 String name,
                                 String description,
                                 String fSpec,
                                 String fileType,
                                 Locale locale)

Saves the content of the markup

Supported API: false

Parameters:

objectReference - The object reference of the Markup

name - The name of the Markup

description - The description of the Markup

fSpec - The file containing the markup

fileType - Either ast or gif

Returns:

boolean true if success

processETB

public boolean processETB(String etbData)

Extracts the data from the ETB file and associates it to the markup as additional info

Supported API: false

Returns:

boolean true if success

getViewStyle

public String getViewStyle(String markupref)

getViewFile

public String getViewFile(String markupref)

decodeString

public static byte[] decodeString(byte[] inBytes)

writeToFile

public boolean writeToFile(String fSpec,
                           byte[] decodeData)

getTempFileName

public String getTempFileName(String directory,
                              String extension)

copyMkFile

public boolean copyMkFile(String fromFile,
                          String toFile)

getMarkupTempDir

public String getMarkupTempDir()

getSaveURL

public String getSaveURL(String info,
                         String WCID,
                         String userName,
                         String passWord,
                         String authorization,
                         String portNo)

getSaveURL

public String getSaveURL(String info,
                         String WCID,
                         String userName,
                         String passWord,
                         String authorization,
                         String portNo,
                         String file)

raiseToPower

private static int raiseToPower(int i,
                                int j)