com.ptc.wvs.common.ui
Class Representer

java.lang.Object
  com.ptc.wvs.common.ui.Representer

public class Representer

extends Object

Methods associated with the manipulation of Representations from the UI

Supported API: false

Field Summary

private static boolean	SERVER
private static String	SERVER_CLASS

Constructor Summary

Representer()

Method Summary

void	copyMarkups(Vector markupList, String objectReference, boolean setOwnerAndLock) copies Markups to Viewable Supported API: false
void	copyRepresentations(Vector repList, String objectReference, boolean includeMarkups, boolean setOwnerAndLock, boolean renameDups) copies Representations to Representable Supported API: false
boolean	deleteRepresentation(String repRef) Deletes a Representation Supported API: false
boolean	doesRepNameExist(String objectReference, String repName) Determines if the representation exists and is related to the representable Supported API: false
String[]	getDescribedByEPMDocuments(String objectReference) get a list of DescribedBy EPMDocuments object ids Supported API: false
String[]	getMarkups(String objectReference) get a list of all markups object ids Supported API: false
Vector	getOutOfDateList(String objectReference, Locale locale) get a list of objects that have made this representation out of date Supported API: false
Object[]	getRepresentationHeading(String objectReference) Returns the heading for the view markup page Supported API: false
Object[]	getRepresentationHeading(String objectReference, boolean full, Locale locale) Returns the heading for the view markup page Supported API: false
String[]	getRepresentations(String objectReference) get a list of all representations object ids Supported API: false
String[]	getRepresentations(String objectReference, boolean includeViewable) get a list of all representations object ids Supported API: false
String	getSaveZIPGatewayURL() Gets the Gateway URL to save a representation as a zip/edz Supported API: false
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
boolean	loadMarkups(String inDir, String poid, Vector options) create a set of Markups from input directory data
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
boolean	loadRepresentation(String inDir, String poid, boolean republishable, String repName, String repDesc, boolean repDefault, boolean createThumbnail, boolean storeEDZ, Vector options) create a Representation from input directory data, using fixed common options
boolean	loadRepresentation(String inDir, String poid, boolean republishable, Vector options) create a Representation from input directory data, using a Vector of options
boolean	makeDefaultRepresentation(String objectRef, String repRef) Makes the specified Representation the default of the Represebtable Supported API: false
boolean	saveAsZIPFile(String oid, boolean outputJar, boolean includeAnnotations, String fileName) Save a Representation as a ZIP or JAR file
boolean	saveMarkupsAsZIPFile(String oid, boolean outputJar, String fileName, String charset) Save Markups as a ZIP or JAR file
String	updateLocation(String type, String oid1, String oid2, String location, boolean updateThumb) Update location information for either a component in a representation or a part in a WTPart structure Supported API: false
void	updateThumbnail(String oid) Update thumbnail image

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

Constructor Detail

Representer

public Representer()

Method Detail

deleteRepresentation

public boolean deleteRepresentation(String repRef)

Deletes a Representation

Supported API: false

Parameters:

repRef - The object reference of the representation to be deleted

Returns:

boolean true if successful

makeDefaultRepresentation

public boolean makeDefaultRepresentation(String objectRef,
                                         String repRef)

Makes the specified Representation the default of the Represebtable

Supported API: false

Parameters:

objectRef - The object reference of the representable

repRef - The object reference of the representation

Returns:

boolean true if successful

doesRepNameExist

public boolean doesRepNameExist(String objectReference,
                                String repName)

Determines if the representation exists and is related to the representable

Supported API: false

Returns:

boolean true if it does exist

getRepresentationHeading

public Object[] getRepresentationHeading(String objectReference)

Returns the heading for the view markup page

Supported API: false

Returns:

Object[] The heading, Booelan if representable, Boolean if viewable

getRepresentationHeading

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

Returns the heading for the view markup page

Supported API: false

Parameters:

full - provide a fuller heading, eg for ProductView

Returns:

Object[] The heading, Booelan if representable, Boolean if viewable

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 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 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 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 String[] getDescribedByEPMDocuments(String objectReference)

get a list of DescribedBy EPMDocuments object ids

Supported API: false

Returns:

String[] list of EPMDocument object ids

getRepresentations

public String[] getRepresentations(String objectReference)

get a list of all representations object ids

Supported API: false

Returns:

String[] list of Representation object ids

getRepresentations

public 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 String[] getMarkups(String objectReference)

get a list of all markups object ids

Supported API: false

Returns:

String[] list of WTMarkup object ids

getSaveZIPGatewayURL

public String getSaveZIPGatewayURL()

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

Supported API: false

Returns:

String the gateway URL

updateLocation

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

Update location information for either a component in a representation or a part in a WTPart structure

Supported API: false

updateThumbnail

public void updateThumbnail(String oid)

Update thumbnail image

saveAsZIPFile

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

Save a Representation as a ZIP or JAR file

saveMarkupsAsZIPFile

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

Save Markups as a ZIP or JAR file

loadRepresentation

public 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

loadRepresentation

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

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

loadRepresentation

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

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

loadMarkups

public boolean loadMarkups(String inDir,
                           String poid,
                           Vector options)

create a set of Markups from input directory data

getOutOfDateList

public Vector getOutOfDateList(String objectReference,
                               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