com.ptc.wvs.server.ui
Class RepHelper

java.lang.Object
  com.ptc.wvs.server.ui.RepHelper

All Implemented Interfaces:

RemoteAccess

public class RepHelper

extends Object

implements RemoteAccess

The server side methods to handle requests from Representer

Supported API: false

Extendable: false

Field Summary

static String

RESOURCE

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

RepHelper()

Method Summary

private static void	addMarkupsToZip(Viewable viewable, QueryResult qr, ZipOutputStream zos, String etbFileName, String charset, boolean includeMkDesc)
static void	copyMarkups(Vector markupList, String objectReference, boolean setOwnerAndLock) copies Markups to Viewable Supported API: false
static void	copyRepresentations(Vector repList, String objectReference, boolean includeMarkups, boolean setOwnerAndLock, boolean renameDups) copies Representations to Representable Supported API: false
static Boolean	deleteRepresentation(String repReference) deletes a representatioin Supported API: false
static Boolean	doesRepNameExist(String objectReference, String repName)
static void	doSaveZIP(HTTPRequest request, HTTPResponse response) Process the saving of a representation to a zip/edz file Supported API: false
static String[]	getDescribedByEPMDocuments(String objectReference) get a list of DescribedBy EPMDocuments object ids Supported API: false
static String[]	getMarkups(String objectReference) get a list of all markups object ids Supported API: false
static Vector	getOutOfDateList(String oid, Locale locale) get a list of objects that have made this representation out of date Supported API: false
static Object[]	getRepresentationHeading(String objectReference, boolean full, Locale locale)
static String[]	getRepresentations(String objectReference, boolean includeViewable) get a list of all representations object ids Supported API: false
static String	getSaveZIPGatewayURL() Gets the Gateway URL to save a representation as a zip/edz Supported API: false
static Boolean[]	isCreateNew(String objectReference) Determines is Representation can be generated for this object Supported API: false
static Boolean	isPartPublishable(String objectReference) Determines if the (associated) part is publishable from the UI Supported API: false
static Boolean	loadMarkups(String inDir, String poid, Vector options) create a set of Markups from input directory data Supported API: false
static Boolean	loadRepresentation(String inDir, String poid, boolean republishable, String repName, String repDesc, boolean repDefault, boolean createThumbnail, boolean storeEDZ) create a Representation from input directory data, using fixed common options Supported API: false
static Boolean	loadRepresentation(String inDir, String poid, boolean republishable, String repName, String repDesc, boolean repDefault, boolean createThumbnail, boolean storeEDZ, Vector options)
static Boolean	loadRepresentation(String inDir, String poid, boolean republishable, Vector options) create a Representation from input directory data, using a Vector of options Supported API: false
static Boolean	makeDefaultRepresentation(String objectReference, String repReference)
static void	saveAsZIP(Representation rep, boolean outputJar, boolean includeAnnotations, OutputStream os) general method a save a representation to an OutputStream Supported API: false
static void	saveAsZIP(Representation rep, boolean outputJar, boolean includeAnnotations, OutputStream os, boolean deleteIgnoreOnMerge, boolean includeMkDesc)
static Boolean	saveAsZIPFile(String oid, boolean outputJar, boolean includeAnnotations, String fileName) Save a representation to a zip/jar file name Supported API: false
static void	saveMarkupsAsZIP(Viewable viewable, QueryResult qr, boolean outputJar, OutputStream os, String charset, boolean includeMkDesc)
static Boolean	saveMarkupsAsZIPFile(String oid, boolean outputJar, String fileName, String charset) Save markups of a Viewable to a zip/jar file name Supported API: false
static String	updateLocation(String type, String oid1, String oid2, String location, boolean updateThumb) Process updating of location in representation and on WTPart structures Supported API: false
static void	updateThumbnail(String oid) Process updating of thumbnail image Supported API: false

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

public static final String RESOURCE

See Also:

Constant Field Values

Constructor Detail

RepHelper

public RepHelper()

Method Detail

deleteRepresentation

public static Boolean deleteRepresentation(String repReference)

deletes a representatioin

Supported API: false

Parameters:

repReference - The represenation to delete

Returns:

Boolean true if object deleted

doesRepNameExist

public static Boolean doesRepNameExist(String objectReference,
                                       String repName)

makeDefaultRepresentation

public static Boolean makeDefaultRepresentation(String objectReference,
                                                String repReference)

getRepresentationHeading

public static Object[] getRepresentationHeading(String objectReference,
                                                boolean full,
                                                Locale locale)

isPartPublishable

public static Boolean isPartPublishable(String objectReference)

Determines if the (associated) part is publishable from the UI

Supported API: false

Returns:

Boolean TRUE if part can be published

isCreateNew

public static Boolean[] isCreateNew(String objectReference)

Determines is Representation can be generated for this object

Supported API: false

Returns:

Boolean[0] true if object can be published from an EPMDoc

copyRepresentations

public static void copyRepresentations(Vector repList,
                                       String objectReference,
                                       boolean includeMarkups,
                                       boolean setOwnerAndLock,
                                       boolean renameDups)

copies Representations to Representable

Supported API: false

Parameters:

repList - Vector of oject reference string of representations to be copied

includeMarkups - true if markups should be copied as well

setOwnerAndLock - true if markups owner and lock state should be copied

renameDups - true if duplicate names should be renamed

copyMarkups

public static void copyMarkups(Vector markupList,
                               String objectReference,
                               boolean setOwnerAndLock)

copies Markups to Viewable

Supported API: false

Parameters:

markupList - Vector of oject reference string of markups to be copied

setOwnerAndLock - true if markups owner and lock state should be copied

getDescribedByEPMDocuments

public static String[] getDescribedByEPMDocuments(String objectReference)

get a list of DescribedBy EPMDocuments object ids

Supported API: false

Returns:

String[] list of EPMDocument object ids

getRepresentations

public static String[] getRepresentations(String objectReference,
                                          boolean includeViewable)

get a list of all representations object ids

Supported API: false

Returns:

String[] list of Representation object ids

getMarkups

public static String[] getMarkups(String objectReference)

get a list of all markups object ids

Supported API: false

Returns:

String[] list of WTMarkup object ids

getSaveZIPGatewayURL

public static String getSaveZIPGatewayURL()

Gets the Gateway URL to save a representation as a zip/edz

Supported API: false

Returns:

String the gateway URL

doSaveZIP

public static void doSaveZIP(HTTPRequest request,
                             HTTPResponse response)
                      throws WTException,
                             PropertyVetoException,
                             IOException

Process the saving of a representation to a zip/edz file

Supported API: false

Throws:

WTException

PropertyVetoException

IOException

saveAsZIP

public static void saveAsZIP(Representation rep,
                             boolean outputJar,
                             boolean includeAnnotations,
                             OutputStream os)
                      throws WTException,
                             PropertyVetoException,
                             IOException

general method a save a representation to an OutputStream

Supported API: false

Throws:

WTException

PropertyVetoException

IOException

saveAsZIP

public static void saveAsZIP(Representation rep,
                             boolean outputJar,
                             boolean includeAnnotations,
                             OutputStream os,
                             boolean deleteIgnoreOnMerge,
                             boolean includeMkDesc)
                      throws WTException,
                             PropertyVetoException,
                             IOException

Throws:

WTException

PropertyVetoException

IOException

saveMarkupsAsZIP

public static void saveMarkupsAsZIP(Viewable viewable,
                                    QueryResult qr,
                                    boolean outputJar,
                                    OutputStream os,
                                    String charset,
                                    boolean includeMkDesc)
                             throws WTException,
                                    PropertyVetoException,
                                    IOException

Throws:

WTException

PropertyVetoException

IOException

addMarkupsToZip

private static void addMarkupsToZip(Viewable viewable,
                                    QueryResult qr,
                                    ZipOutputStream zos,
                                    String etbFileName,
                                    String charset,
                                    boolean includeMkDesc)
                             throws WTException,
                                    PropertyVetoException,
                                    IOException

Throws:

WTException

PropertyVetoException

IOException

saveAsZIPFile

public static Boolean saveAsZIPFile(String oid,
                                    boolean outputJar,
                                    boolean includeAnnotations,
                                    String fileName)

Save a representation to a zip/jar file name

Supported API: false

saveMarkupsAsZIPFile

public static Boolean saveMarkupsAsZIPFile(String oid,
                                           boolean outputJar,
                                           String fileName,
                                           String charset)

Save markups of a Viewable to a zip/jar file name

Supported API: false

updateLocation

public static String updateLocation(String type,
                                    String oid1,
                                    String oid2,
                                    String location,
                                    boolean updateThumb)

Process updating of location in representation and on WTPart structures

Supported API: false

updateThumbnail

public static void updateThumbnail(String oid)

Process updating of thumbnail image

Supported API: false

loadRepresentation

public static Boolean loadRepresentation(String inDir,
                                         String poid,
                                         boolean republishable,
                                         String repName,
                                         String repDesc,
                                         boolean repDefault,
                                         boolean createThumbnail,
                                         boolean storeEDZ)

create a Representation from input directory data, using fixed common options

Supported API: false

loadRepresentation

public static Boolean loadRepresentation(String inDir,
                                         String poid,
                                         boolean republishable,
                                         String repName,
                                         String repDesc,
                                         boolean repDefault,
                                         boolean createThumbnail,
                                         boolean storeEDZ,
                                         Vector options)

loadRepresentation

public static Boolean loadRepresentation(String inDir,
                                         String poid,
                                         boolean republishable,
                                         Vector options)

create a Representation from input directory data, using a Vector of options

Supported API: false

loadMarkups

public static Boolean loadMarkups(String inDir,
                                  String poid,
                                  Vector options)

create a set of Markups from input directory data

Supported API: false

getOutOfDateList

public static Vector getOutOfDateList(String oid,
                                      Locale locale)

get a list of objects that have made this representation out of date

Supported API: false

Returns:

Vector containing String[] of object oid's and display ids null returned if not out of date