com.ptc.wvs.common.ui
Class Visualizer

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

public class Visualizer

extends Object

Methods responsible for the viewing of Representations

Supported API: false

Field Summary

static int	CLIPBOARD_LINK
private static String	CONFIG_SERVER_CLASS
private static String	createDialogWindow
static int	DEFAULT_ICON
static int	DELETE_LINK
static int	HAS_MARKUP_ICON
static int	MAKE_DEFAULT
static int	NUMBER_OF_VISDATA
static int	PART_VIEW_LINK
static int	PRINT_LINK
static int	PRODUCTVIEW_LINK
static int	PRODUCTVIEWLITE_LINK
static int	PV_PS_LINK
static int	REFRESH_LINK
static int	REP_CONFIG_SPEC
static int	REP_DATE_CREATED
static int	REP_DESCRIPTION
static int	REP_NAME
static int	REPRESENTATIONS
static int	SAVE_ZIP_LINK
private static boolean	SERVER
private static String	SERVER_CLASS
static int	THUMBNAIL_LINK
static int	THUMBNAIL_VIEWER_LINK
private static String	thumbViewerJS
private static boolean	thumbViewerJSEachCall
private static WVSProperties	wvsProperties

Constructor Summary

Visualizer()

Method Summary

String	getAddToClipboardHTML(String representableRef, String representationRef) Returns the HTML to add an entry to the clipboard Supported API: false
String	getAddToClipboardHTML(String representableRef, String representationRef, Locale locale) Returns the HTML to add an entry to the clipboard Supported API: false
String	getAddToClipboardURL(String representableRef, String representationRef) Returns the URL to add an entry to the clipboard Supported API: false
Vector	getAllMarkupData(String representableObjectReference, String representationObjectReference) Returns information about all markups associated to a representable for manipulation by a UI.
Vector	getAllMarkupData(String representableObjectReference, String representationObjectReference, Locale locale) Returns information about all markups associated to a representable for manipulation by a UI.
Vector	getAllVisualizationData(String representableObjectReference) Returns information about all representations associated to a representable for manipulation by a UI.
Vector	getAllVisualizationData(String representableObjectReference, Locale locale) Returns information about all representations associated to a representable for manipulation by a UI.
static String[]	getClipboardData(String representableObjectReference, String representationObjectReference) Returns information for display in the clipboard for the specified representation of the representable Supported API: false
static String[]	getClipboardData(String representableObjectReference, String representationObjectReference, String ContainerOid, Locale locale) Returns information for display in the clipboard for the specified representation of the representable Supported API: false
static String	getCreateDialogWindow() Returns the JavaScript to create the Dialog Window function creationDialogWindow This should be called once per page Supported API: false
String	getDefaultThumbnailURL(String objectReference) Returns the URL to the Thumbnail Image for the default representation of the representable Supported API: false
static String	getDefaultViewHTML(String objectReference, Boolean displayThumbnail, Boolean forListing) Returns the HTML fragment for default representation of the representable which will launch ProductView Supported API: false
static String	getDefaultViewHTML(String objectReference, Boolean displayThumbnail, Boolean forListing, Locale locale) Returns the HTML fragment for default representation of the representable which will launch ProductView Supported API: false
static String	getDefaultViewURL(String objectReference) Returns the URL to the ProductView ED file for the default representation of the representable Supported API: false
String[]	getDefaultVisualizationData(String representableObjectReference, Boolean forListing) Returns a set of HTML fragments to allow the default representation to be manipulated by a UI.
String[]	getDefaultVisualizationData(String representableObjectReference, Boolean forListing, Locale locale) Returns a set of HTML fragments to allow the default representation to be manipulated by a UI.
String[]	getMarkupData(String objectReference, Locale locale) Returns markup data array ofr the markup obkect Supported API: false
String	getMarkupsURL(String objectReference) Returns the URL to add show the Markup page for an object Supported API: false
static String	getModifyPreferenceURL() Determines the current user Client Preference Supported API: false
static String	getPartStructureBasicURL(String objectReference, String configString, Integer levels) Returns the URL, for viewing the WTPart structure Supported API: false
static String[]	getPartStructureCreateRepFormHTML(String objectReference, Integer levels, Integer type, Locale locale) Returns HTML fragments for creating a representation for the WTPart structure.
static String	getPartStructureED(String objectReference, ConfigSpec configSpec, Integer levels) Returns ED file content for viewing the WTPart structure.
static String	getPartStructureED(String objectReference, String configString, Integer levels) Returns ED file content for viewing the WTPart structure.
static String[]	getPartStructureFormHTML(String objectReference, Integer levels, Integer type, Locale locale) Returns HTML fragments for viewing the WTPart structure.
static String	getPartStructureHTML(String objectReference, String configString, Integer levels) Returns the HTML fragment for viewing the WTPart structure Supported API: false
static String	getPartStructureHTML(String objectReference, String configString, Integer levels, Locale locale) Returns the HTML fragment for viewing the WTPart structure, the users current WTPartConfigSpec will be used.
static String	getPartStructureHTML(String objectReference, String configString, Integer levels, Locale locale, Boolean displayThumbnail, Boolean forListing) Returns the HTML fragment for viewing the WTPart structure, the users current WTPartConfigSpec will be used.
String	getPartStructurePublishHTML(String objectReference) Returns a set of HTML fragment to allow publishing of a deault representation from the HTML Product Structure page.
String[]	getPartStructurePVandViewThumbnailLinkHTML(String objectReference) Returns 2 HTML fragments to view in PV and view the thumbnail of the default representation from the HTML Product Structure page.
static WTKeyedMap	getPartStructurePVandViewThumbnailLinkHTML(WTCollection collection) Returns 2 HTML fragments to view in PV and view the thumbnail of the default representation from the HTML Product Structure page.
String	getPartStructurePVHTML(String objectReference) Returns a set of HTML fragment to allow ProductView to be launched from the NAME link on the HTML Product Structure page.
static WTKeyedMap	getPartStructurePVHTML(WTCollection collection) Returns a set of HTML fragment to allow ProductView to be launched from the NAME link on the HTML Product Structure page.
static String	getPartStructureURL(String objectReference, String configString, Integer levels) Returns the URL, including javascript new window, for viewing the WTPart structure Supported API: false
String	getPartStructureViewThumbnailLinkHTML(String objectReference) Returns a set of HTML fragment to view the thumbnail of the default representation from the HTML Product Structure page.
static WTKeyedMap	getPartStructureViewThumbnailLinkHTML(WTCollection collection) Returns a set of HTML fragment to view the thumbnail of the default representation from the HTML Product Structure page.
static String	getPreference(String key, String defaultValue) Retrieve the preference value Supported API: false
String	getPrintHTML(String representableRef, String representationRef) Returns the HTML to print a representation Supported API: false
String	getPrintHTML(String representableRef, String representationRef, Locale locale) Returns the HTML to print a representation Supported API: false
String	getPrintURL(String representableRef, String representationRef) Returns the URL to print a representation Supported API: false
static String	getPVConfigURL(String objectReference, String ContainerOid, boolean fromClip, Locale locale) Returns URL to get productview config information from Supported API: false
String	getRepresentationsURL(String objectReference) Returns the URL to add show the Representations page for an object Supported API: false
String	getThumbnailURL(String objectReference) Returns the URL to the Thumbnail Image for the representation Supported API: false
static String[]	getVisualizationData(String representableObjectReference, String representationObjectReference, Boolean forListing) Returns a set of HTML fragments to allow the specified representation to be manipulated by a UI.
static String[]	getVisualizationData(String representableObjectReference, String representationObjectReference, Boolean forListing, Locale locale) Returns a set of HTML fragments to allow the specified representation to be manipulated by a UI.
static boolean	isAdministrator(String objectReference) is the user an administrator (on the container) Supported API: false
static void	setPreference(String key, String value) Retrieve the preference value Supported API: false
static String	setSessionValue(String key, String value) Add to Session variable to the method server Supported API: false
static boolean	useStandardPVPreference() Determines the current user Client Preference Supported API: false

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

CONFIG_SERVER_CLASS

private static final String CONFIG_SERVER_CLASS

SERVER

private static final boolean SERVER

PRODUCTVIEW_LINK

public static final int PRODUCTVIEW_LINK

See Also:

Constant Field Values

THUMBNAIL_LINK

public static final int THUMBNAIL_LINK

See Also:

Constant Field Values

CLIPBOARD_LINK

public static final int CLIPBOARD_LINK

See Also:

Constant Field Values

PRINT_LINK

public static final int PRINT_LINK

See Also:

Constant Field Values

DEFAULT_ICON

public static final int DEFAULT_ICON

See Also:

Constant Field Values

HAS_MARKUP_ICON

public static final int HAS_MARKUP_ICON

See Also:

Constant Field Values

REP_NAME

public static final int REP_NAME

See Also:

Constant Field Values

REP_DESCRIPTION

public static final int REP_DESCRIPTION

See Also:

Constant Field Values

REP_CONFIG_SPEC

public static final int REP_CONFIG_SPEC

See Also:

Constant Field Values

REP_DATE_CREATED

public static final int REP_DATE_CREATED

See Also:

Constant Field Values

DELETE_LINK

public static final int DELETE_LINK

See Also:

Constant Field Values

REFRESH_LINK

public static final int REFRESH_LINK

See Also:

Constant Field Values

MAKE_DEFAULT

public static final int MAKE_DEFAULT

See Also:

Constant Field Values

REPRESENTATIONS

public static final int REPRESENTATIONS

See Also:

Constant Field Values

PART_VIEW_LINK

public static final int PART_VIEW_LINK

See Also:

Constant Field Values

PRODUCTVIEWLITE_LINK

public static final int PRODUCTVIEWLITE_LINK

See Also:

Constant Field Values

THUMBNAIL_VIEWER_LINK

public static final int THUMBNAIL_VIEWER_LINK

See Also:

Constant Field Values

PV_PS_LINK

public static final int PV_PS_LINK

See Also:

Constant Field Values

SAVE_ZIP_LINK

public static final int SAVE_ZIP_LINK

See Also:

Constant Field Values

NUMBER_OF_VISDATA

public static final int NUMBER_OF_VISDATA

See Also:

Constant Field Values

wvsProperties

private static WVSProperties wvsProperties

thumbViewerJSEachCall

private static boolean thumbViewerJSEachCall

thumbViewerJS

private static String thumbViewerJS

createDialogWindow

private static String createDialogWindow

Constructor Detail

Visualizer

public Visualizer()

Method Detail

getCreateDialogWindow

public static String getCreateDialogWindow()

Returns the JavaScript to create the Dialog Window function creationDialogWindow This should be called once per page

Supported API: false

Returns:

String JavaScript

getDefaultVisualizationData

public String[] getDefaultVisualizationData(String representableObjectReference,
                                            Boolean forListing)

Returns a set of HTML fragments to allow the default representation to be manipulated by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

forListing - Specifies if the resulting HTML is to be using in a listing

Returns:

String[] HTML fragments, can be extracted using the static int's

getDefaultVisualizationData

public String[] getDefaultVisualizationData(String representableObjectReference,
                                            Boolean forListing,
                                            Locale locale)

Returns a set of HTML fragments to allow the default representation to be manipulated by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

forListing - Specifies if the resulting HTML is to be using in a listing

locale - Specifies locale for ALT tags

Returns:

String[] HTML fragments, can be extracted using the static int's

getVisualizationData

public static String[] getVisualizationData(String representableObjectReference,
                                            String representationObjectReference,
                                            Boolean forListing)

Returns a set of HTML fragments to allow the specified representation to be manipulated by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

representationObjectReference - The object reference of the representation

forListing - Specifies if the resulting HTML is to be using in a listing

Returns:

String[] HTML fragments, can be extracted using the static int's

getVisualizationData

public static String[] getVisualizationData(String representableObjectReference,
                                            String representationObjectReference,
                                            Boolean forListing,
                                            Locale locale)

Returns a set of HTML fragments to allow the specified representation to be manipulated by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

representationObjectReference - The object reference of the representation

forListing - Specifies if the resulting HTML is to be using in a listing

locale - Specifies locale for ALT tags

Returns:

String[] HTML fragments, can be extracted using the static int's

getAllVisualizationData

public Vector getAllVisualizationData(String representableObjectReference)

Returns information about all representations associated to a representable for manipulation by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

Returns:

Vector vector of String[] containing HTML fragments return by getVisualizationData

getAllVisualizationData

public Vector getAllVisualizationData(String representableObjectReference,
                                      Locale locale)

Returns information about all representations associated to a representable for manipulation by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

locale - Specifies locale for ALT tags

Returns:

Vector vector of String[] containing HTML fragments return by getVisualizationData

getAllMarkupData

public Vector getAllMarkupData(String representableObjectReference,
                               String representationObjectReference)

Returns information about all markups associated to a representable for manipulation by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

representationObjectReference - The object reference of the representation

Returns:

Vector vector of String[] containing HTML fragments return by getMarkupData

getAllMarkupData

public Vector getAllMarkupData(String representableObjectReference,
                               String representationObjectReference,
                               Locale locale)

Returns information about all markups associated to a representable for manipulation by a UI.

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

representationObjectReference - The object reference of the representation

locale - Specifies locale for ALT tags

Returns:

Vector vector of String[] containing HTML fragments return by getMarkupData

getClipboardData

public static String[] getClipboardData(String representableObjectReference,
                                        String representationObjectReference)

Returns information for display in the clipboard for the specified representation of the representable

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

representationObjectReference - The object reference of the representation

Returns:

String[] HTML fragments, can be extracted using the static int's defined in com.ptc.wvs.client.beans.Clipboard

getClipboardData

public static String[] getClipboardData(String representableObjectReference,
                                        String representationObjectReference,
                                        String ContainerOid,
                                        Locale locale)

Returns information for display in the clipboard for the specified representation of the representable

Supported API: false

Parameters:

representableObjectReference - The object reference of the representable

representationObjectReference - The object reference of the representation

ContainerOid - The object reference of the container in the context this is added to clipboard

locale - Specifies locale

Returns:

String[] HTML fragments, can be extracted using the static int's defined in com.ptc.wvs.client.beans.Clipboard

getDefaultViewHTML

public static String getDefaultViewHTML(String objectReference,
                                        Boolean displayThumbnail,
                                        Boolean forListing)

Returns the HTML fragment for default representation of the representable which will launch ProductView

Supported API: false

Parameters:

objectReference - The object reference of the representable

displayThumbnail - If TRUE the thumbnail will be exposed in the html, if not, an icon will be displayed.

forListing - If TRUE, the HTML will be for a result table

Returns:

String HTML fragment

getDefaultViewHTML

public static String getDefaultViewHTML(String objectReference,
                                        Boolean displayThumbnail,
                                        Boolean forListing,
                                        Locale locale)

Returns the HTML fragment for default representation of the representable which will launch ProductView

Supported API: false

Parameters:

objectReference - The object reference of the representable

displayThumbnail - If TRUE the thumbnail will be exposed in the html, if not, an icon will be displayed.

forListing - If TRUE, the HTML will be for a result table

locale - Specifies locale for ALT tags

Returns:

String HTML fragment

getDefaultViewURL

public static String getDefaultViewURL(String objectReference)

Returns the URL to the ProductView ED file for the default representation of the representable

Supported API: false

Parameters:

objectReference - The object reference of the representable

Returns:

String URL to the ProductView ED file

getDefaultThumbnailURL

public String getDefaultThumbnailURL(String objectReference)

Returns the URL to the Thumbnail Image for the default representation of the representable

Supported API: false

Parameters:

objectReference - The object reference of the representable

Returns:

String URL to the Thumbnail image

getThumbnailURL

public String getThumbnailURL(String objectReference)

Returns the URL to the Thumbnail Image for the representation

Supported API: false

Parameters:

objectReference - The object reference of the representation

Returns:

String URL to the Thumbnail image

getAddToClipboardURL

public String getAddToClipboardURL(String representableRef,
                                   String representationRef)

Returns the URL to add an entry to the clipboard

Supported API: false

Parameters:

representableRef - The object reference of the representable

representationRef - The object reference of the representation

Returns:

String URL to add the entry to the clipboard

getAddToClipboardHTML

public String getAddToClipboardHTML(String representableRef,
                                    String representationRef)

Returns the HTML to add an entry to the clipboard

Supported API: false

Parameters:

representableRef - The object reference of the representable

representationRef - The object reference of the representation

Returns:

String HTML to add the entry to the clipboard

getAddToClipboardHTML

public String getAddToClipboardHTML(String representableRef,
                                    String representationRef,
                                    Locale locale)

Returns the HTML to add an entry to the clipboard

Supported API: false

Parameters:

representableRef - The object reference of the representable

representationRef - The object reference of the representation

locale - Specifies locale for ALT tags

Returns:

String HTML to add the entry to the clipboard

getPrintURL

public String getPrintURL(String representableRef,
                          String representationRef)

Returns the URL to print a representation

Supported API: false

Parameters:

representableRef - The object reference of the representable

representationRef - The object reference of the representation

Returns:

String URL to print a representation

getPrintHTML

public String getPrintHTML(String representableRef,
                           String representationRef)

Returns the HTML to print a representation

Supported API: false

Parameters:

representableRef - The object reference of the representable

representationRef - The object reference of the representation

Returns:

String HTML to print a representation

getPrintHTML

public String getPrintHTML(String representableRef,
                           String representationRef,
                           Locale locale)

Returns the HTML to print a representation

Supported API: false

Parameters:

representableRef - The object reference of the representable

representationRef - The object reference of the representation

locale - Specifies locale for ALT tags

Returns:

String HTML to print a representation

getRepresentationsURL

public String getRepresentationsURL(String objectReference)

Returns the URL to add show the Representations page for an object

Supported API: false

Parameters:

objectReference - The object reference whos Representations table is to be returned

Returns:

String URL to display table

getMarkupsURL

public String getMarkupsURL(String objectReference)

Returns the URL to add show the Markup page for an object

Supported API: false

Parameters:

objectReference - The object reference whos markups table is to be returned

Returns:

String URL to add the entry to the clipboard

getMarkupData

public String[] getMarkupData(String objectReference,
                              Locale locale)

Returns markup data array ofr the markup obkect

Supported API: false

Parameters:

objectReference - The object reference whos markups data is to be returned

locale - Specifies locale for ALT tags

Returns:

String[] Markup data

getPartStructureBasicURL

public static String getPartStructureBasicURL(String objectReference,
                                              String configString,
                                              Integer levels)

Returns the URL, for viewing the WTPart structure

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

configString - a String representation of the ConfigSpec or null

levels - Specifies number of levels to traverse, -1 = all

Returns:

String HTML fragment

getPartStructureURL

public static String getPartStructureURL(String objectReference,
                                         String configString,
                                         Integer levels)

Returns the URL, including javascript new window, for viewing the WTPart structure

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

configString - a String representation of the ConfigSpec or null

levels - Specifies number of levels to traverse, -1 = all

Returns:

String HTML fragment

getPartStructureHTML

public static String getPartStructureHTML(String objectReference,
                                          String configString,
                                          Integer levels)

Returns the HTML fragment for viewing the WTPart structure

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

configString - a String representation of the ConfigSpec or null

levels - Specifies number of levels to traverse, -1 = all

Returns:

String HTML fragment

getPartStructureHTML

public static String getPartStructureHTML(String objectReference,
                                          String configString,
                                          Integer levels,
                                          Locale locale)

Returns the HTML fragment for viewing the WTPart structure, the users current WTPartConfigSpec will be used.

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

configString - a String representation of the ConfigSpec or null

levels - Specifies number of levels to traverse, -1 = all

locale - Specifies locale for ALT tags

Returns:

String HTML fragment

getPartStructureHTML

public static String getPartStructureHTML(String objectReference,
                                          String configString,
                                          Integer levels,
                                          Locale locale,
                                          Boolean displayThumbnail,
                                          Boolean forListing)

Returns the HTML fragment for viewing the WTPart structure, the users current WTPartConfigSpec will be used. The thumbnail image can be displayed in the case of a WTProductConfiguration or a WTProductInstance2, in which case the thumbnail will be from the default representation on the associated WTProduct, ie. the thumbnail is only approximate

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

configString - a String representation of the ConfigSpec or null

levels - Specifies number of levels to traverse, -1 = all

locale - Specifies locale for ALT tags

displayThumbnail - If TRUE the thumbnail will be exposed in the html, if not, an icon will be displayed.

forListing - If TRUE, the HTML will be for a result table

Returns:

String HTML fragment

getPartStructureFormHTML

public static String[] getPartStructureFormHTML(String objectReference,
                                                Integer levels,
                                                Integer type,
                                                Locale locale)

Returns HTML fragments for viewing the WTPart structure. The returned String array contains the HTML to start a form in [0] and the HTML to end the form and provide a submit link in [1]. As the length the the config spec definition as a String is long for passing with a GET request this allows a POST request to be used. The actual config spec String should therefore be include in the HTML between the form start and form end as a hidden parameter "config_spec". If no config spec is specified then the users config spec from the database will be used. The returned HTML uses the javascript function createDialogWindow, therefore getCreateDialogWindow should have been used to add this to the page. If WVS is not enabled the returned Strings will be "".

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

levels - Specifies number of levels to traverse, -1 = all

type - Specifies visible type, 1=text only(default), 2=icon only, 3= text & icon

locale - Specifies locale for ALT tags

Returns:

String[] HTML fragments

getPartStructureCreateRepFormHTML

public static String[] getPartStructureCreateRepFormHTML(String objectReference,
                                                         Integer levels,
                                                         Integer type,
                                                         Locale locale)

Returns HTML fragments for creating a representation for the WTPart structure. The returned String array contains the HTML to start a form in [0] and the HTML to end the form and provide a submit link in [1]. As the length the the config spec definition as a String is long for passing with a GET request this allows a POST request to be used. The actual config spec String should therefore be include in the HTML between the form start and form end as a hidden parameter "config_spec". If no config spec is specified then the users config spec from the database will be used. The returned HTML uses the javascript function createDialogWindow, therefore getCreateDialogWindow should have been used to add this to the page. If WVS is not enabled the returned Strings will be "".

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

levels - Specifies number of levels to traverse, -1 = all

type - Specifies visible type, 1=text only(default), 2=icon only, 3= text & icon

locale - Specifies locale for ALT tags

Returns:

String[] HTML fragments

getPartStructureED

public static String getPartStructureED(String objectReference,
                                        String configString,
                                        Integer levels)

Returns ED file content for viewing the WTPart structure. When the HTML generated by getPartStructureHTML is invoked, ProductView will call, via a jsp, this method to get the actual ED file data.

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

configString - a String representation of the ConfigSpec or null

levels - Specifies number of levels to traverse, -1 = all

Returns:

String ED file

getPartStructureED

public static String getPartStructureED(String objectReference,
                                        ConfigSpec configSpec,
                                        Integer levels)

Returns ED file content for viewing the WTPart structure. When the HTML generated by getPartStructureHTML is invoked, ProductView will call, via a jsp, this method to get the actual ED file data.

Supported API: false

Parameters:

objectReference - The object reference of the WTPart

configSpec - the (WTPart)ConfigSpec or null

levels - Specifies number of levels to traverse, -1 = all

Returns:

String ED file

setSessionValue

public static String setSessionValue(String key,
                                     String value)

Add to Session variable to the method server

Supported API: false

Parameters:

key - the key object

value - the value object (null deletes the key)

Returns:

String session ID

useStandardPVPreference

public static boolean useStandardPVPreference()

Determines the current user Client Preference

Supported API: false

Returns:

boolean

getModifyPreferenceURL

public static String getModifyPreferenceURL()

Determines the current user Client Preference

Supported API: false

Returns:

String

getPreference

public static String getPreference(String key,
                                   String defaultValue)

Retrieve the preference value

Supported API: false

Parameters:

key - the key object

Returns:

The value of the preference

setPreference

public static void setPreference(String key,
                                 String value)
                          throws WTException

Retrieve the preference value

Supported API: false

Parameters:

key - the key object

Throws:

WTException

getPartStructurePVHTML

public String getPartStructurePVHTML(String objectReference)

Returns a set of HTML fragment to allow ProductView to be launched from the NAME link on the HTML Product Structure page. NOTE: this is not viewing the Part Structure, it is viewing the default representation

Supported API: false

Parameters:

objectReference - The object reference of the representable

Returns:

String HTML fragment

getPartStructureViewThumbnailLinkHTML

public String getPartStructureViewThumbnailLinkHTML(String objectReference)

Returns a set of HTML fragment to view the thumbnail of the default representation from the HTML Product Structure page. NOTE: this is not viewing the Part Structure, it is viewing the default representation

Supported API: false

Parameters:

objectReference - The object reference of the representable

Returns:

String HTML fragment

getPartStructurePVandViewThumbnailLinkHTML

public String[] getPartStructurePVandViewThumbnailLinkHTML(String objectReference)

Returns 2 HTML fragments to view in PV and view the thumbnail of the default representation from the HTML Product Structure page. NOTE: this is not viewing the Part Structure, it is viewing the default representation

Supported API: false

Parameters:

objectReference - The object reference of the representable

Returns:

String HTML fragment2 [0] PV url, [1] view thumbnail url

getPartStructurePublishHTML

public String getPartStructurePublishHTML(String objectReference)

Returns a set of HTML fragment to allow publishing of a deault representation from the HTML Product Structure page. NOTE: this is not publishing the Part Structure, it is publishing the EPMDoc.

Supported API: false

Parameters:

objectReference - The object reference of the representable

Returns:

String HTML fragment

getPVConfigURL

public static String getPVConfigURL(String objectReference,
                                    String ContainerOid,
                                    boolean fromClip,
                                    Locale locale)

Returns URL to get productview config information from

Supported API: false

Parameters:

objectReference - The object reference for context of config info

fromClip - is this viewing from the clipboard

locale - the locale

Returns:

String the URL

isAdministrator

public static boolean isAdministrator(String objectReference)

is the user an administrator (on the container)

Supported API: false

Parameters:

objectReference - The container, can be null

Returns:

boolean

getPartStructurePVHTML

public static WTKeyedMap getPartStructurePVHTML(WTCollection collection)

Returns a set of HTML fragment to allow ProductView to be launched from the NAME link on the HTML Product Structure page. NOTE: this is not viewing the Part Structure, it is viewing the default representation

Supported API: false

Parameters:

collection - a WTCollection of objects

Returns:

WTKeyedMap

getPartStructureViewThumbnailLinkHTML

public static WTKeyedMap getPartStructureViewThumbnailLinkHTML(WTCollection collection)

Returns a set of HTML fragment to view the thumbnail of the default representation from the HTML Product Structure page. NOTE: this is not viewing the Part Structure, it is viewing the default representation

Supported API: false

Parameters:

collection - a WTCollection of objects

Returns:

WTKeyedMap

getPartStructurePVandViewThumbnailLinkHTML

public static WTKeyedMap getPartStructurePVandViewThumbnailLinkHTML(WTCollection collection)

Returns 2 HTML fragments to view in PV and view the thumbnail of the default representation from the HTML Product Structure page. NOTE: this is not viewing the Part Structure, it is viewing the default representation

Supported API: false

Parameters:

collection - a WTCollection of objects

Returns:

WTKeyedMap