Package com.ptc.wvs.common.ui

Class Publisher

java.lang.Object
com.ptc.wvs.common.ui.Publisher
All Implemented Interfaces:
Serializable
public class Publisher extends Object implements Serializable
Methods associated with the submission of data to be published by WVS

Supported API: true

Extendable: false
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EPM
    Structure traversal type for publishing EPM is EPMDocument structure traversal, for when publishing EPMDocuments

    Supported API: true
    static final int
    EPM_PLUS_PARTS
    Structure traversal type for publishing EPM_PLUS_PART is EPMDocument structure traversal, for when publishing EPMDocuments and including non-built WTParts in the result

    Supported API: true
    static final int
    EPM_WC
    CAD Structure traversal type for publishing EPMDocuments to provide same result as the Visualization Tab

    Supported API: true
    static final int
    NONE
    Structure traversal type for publishing NONE is no structure traversal, for when publishnig WTDocuments for example

    Supported API: true
    static final int
    PART
    Structure traversal type for publishing PART is WTPart structure traversal, for when publishing WTPart structure

    Supported API: true
    static final int
    PART_AND_EPM
    Structure traversal type for publishing PART_AND_EPM is Part structure traversal, for when publishing Parts and including associated EPMDocuments in the result

    Supported API: true

  • Constructor Summary

    Constructors
    Constructor
    Description
    Publisher()
    No-arg constructor for this Publisher class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    doPublish(boolean viewableLink, boolean forceRepublish, String objectReference, NavigationCriteria navigationCriteria, NavigationCriteria partNavigationCriteria, boolean defaultRep, String repName, String repDescription, int structureType, String actionString, int jobSource)
    Attempts to publish a Representable generating a Representation
    boolean
    doPublish(boolean viewableLink, boolean forceRepublish, String objectReference, ConfigSpec configSpec, ConfigSpec partConfigSpec, boolean defaultRep, String repName, String repDescription, int structureType, String actionString, int jobSource)
    Attempts to publish a Representable generating a Representation
    String
    getViewableLink()
    Returns an HTML fragment used to launch ProductView from the last data to be set by a call to doPublish, when viewableLink was true

    Supported API: true
    String
    getViewableObjRef()
    Returns an object reference of the Represetation generated from the last call to doPublish, when viewableLink was true

    Supported API: true
    boolean
    isAccessDenied()
    Determines if access was denied for the publish request, especially when the publish request was not successful.
    boolean
    isJobAlreadyExist()
    Determines if job already exists in queue

    Supported API: true
    boolean
    isMarkedNotPublishable()
    Returns the status to indicate that the EPMDocument is marked as not publishable following a doPublish or republishRepresentation

    Supported API: true
    boolean
    republishRepresentation(String objectReference, String repRef, int jobSource)
    Attempts to republish an existing Representation of a Representatable

    Methods inherited from class java.lang.Object

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

  • Field Details

    • NONE

      public static final int NONE
      Structure traversal type for publishing NONE is no structure traversal, for when publishnig WTDocuments for example

      Supported API: true
      See Also:

    • EPM

      public static final int EPM
      Structure traversal type for publishing EPM is EPMDocument structure traversal, for when publishing EPMDocuments

      Supported API: true
      See Also:

    • PART

      public static final int PART
      Structure traversal type for publishing PART is WTPart structure traversal, for when publishing WTPart structure

      Supported API: true
      See Also:

    • EPM_PLUS_PARTS

      public static final int EPM_PLUS_PARTS
      Structure traversal type for publishing EPM_PLUS_PART is EPMDocument structure traversal, for when publishing EPMDocuments and including non-built WTParts in the result

      Supported API: true
      See Also:

    • PART_AND_EPM

      public static final int PART_AND_EPM
      Structure traversal type for publishing PART_AND_EPM is Part structure traversal, for when publishing Parts and including associated EPMDocuments in the result

      Supported API: true
      See Also:

    • EPM_WC

      public static final int EPM_WC
      CAD Structure traversal type for publishing EPMDocuments to provide same result as the Visualization Tab

      Supported API: true
      See Also:

  • Constructor Details

    • Publisher

      public Publisher()
      No-arg constructor for this Publisher class.

      Supported API: true

  • Method Details

    • getViewableLink

      public String getViewableLink()
      Returns an HTML fragment used to launch ProductView from the last data to be set by a call to doPublish, when viewableLink was true

      Supported API: true
      Returns:
      String HTML fragment to launch ProductView

    • getViewableObjRef

      public String getViewableObjRef()
      Returns an object reference of the Represetation generated from the last call to doPublish, when viewableLink was true

      Supported API: true
      Returns:
      String objectreference

    • isMarkedNotPublishable

      public boolean isMarkedNotPublishable()
      Returns the status to indicate that the EPMDocument is marked as not publishable following a doPublish or republishRepresentation

      Supported API: true
      Returns:
      boolean not publishable flag

    • isAccessDenied

      public boolean isAccessDenied()
      Determines if access was denied for the publish request, especially when the publish request was not successful.

      Supported API: true
      Returns:
      true if access was denied. Returns false if access was granted.

    • isJobAlreadyExist

      public boolean isJobAlreadyExist()
      Determines if job already exists in queue

      Supported API: true
      Returns:
      true if already exists

    • doPublish

      public boolean doPublish(boolean viewableLink, boolean forceRepublish, String objectReference, ConfigSpec configSpec, ConfigSpec partConfigSpec, boolean defaultRep, String repName, String repDescription, int structureType, String actionString, int jobSource)
      Attempts to publish a Representable generating a Representation
      Parameters:
      viewableLink - If true and the data has already been published, the viewable data will be passed back to allow access by getViewableLink
      forceRepublish - Overwrites an existing representation should one already exist
      objectReference - Reference of the Representable to be published
      configSpec - The EPM Config Spec to be used during the product structure tree walk, if null, as-stored or latest is used.
      partConfigSpec - The Part Config Spec to be used during the product structure tree walk, if null, latest is used.
      defaultRep - Should the created representation be the default or not. The first representation in always default.
      repName - Name of The representation to be created, if null default name will be used
      repDescription - Description of the representation to be created , if null no description will be used
      structureType - The type of structure walk to be performed, NONE, EPM, PART, EPM_PLUS_PARTS
      actionString - Option String, see PublisherAction class, if no options can be null
      jobSource - Source that submitted the job, 0=unknown, 1=manual, 2=checkin, 3=schedule
      Returns:
      boolean true if the representation that the publish job would create already exists (and forceRepublish is false). In this case if viewableLink is true then the information to view the existing representation can be obtained with getViewableLink(). If the publish job has not be submitted because the object being publish was marked not to be published then isMarkedNotPublishable() will return true. false if the business object does not have a representation already existed.

      Supported API: true

    • doPublish

      public boolean doPublish(boolean viewableLink, boolean forceRepublish, String objectReference, NavigationCriteria navigationCriteria, NavigationCriteria partNavigationCriteria, boolean defaultRep, String repName, String repDescription, int structureType, String actionString, int jobSource)
      Attempts to publish a Representable generating a Representation
      Parameters:
      viewableLink - If true and the data has already been published, the viewable data will be passed back to allow access by getViewableLink
      forceRepublish - Overwrites an existing representation should one already exist
      objectReference - Reference of the Representable to be published
      navigationCriteria - The EPM navigation criteria to be used during the product structure tree walk, if null, as-stored or latest is used.
      partNavigationCriteria - The Part navigation criteria to be used during the product structure tree walk, if null, latest is used.
      defaultRep - Should the created representation be the default or not. The first representation in always default.
      repName - Name of The representation to be created, if null default name will be used
      repDescription - Description of the representation to be created , if null no description will be used
      structureType - The type of structure walk to be performed, NONE, EPM, PART, EPM_PLUS_PARTS
      actionString - Option String, see PublisherAction class, if no options can be null
      jobSource - Source that submitted the job, 0=unknown, 1=manual, 2=checkin, 3=schedule
      Returns:
      boolean true if the representation that the publish job would create already exists (and forceRepublish is false). In this case if viewableLink is true then the information to view the existing representation can be obtained with getViewableLink(). If the publish job has not be submitted because the object being publish was marked not to be published then isMarkedNotPublishable() will return true. false if the business object does not have a representation already existed.

      Supported API: true

    • republishRepresentation

      public boolean republishRepresentation(String objectReference, String repRef, int jobSource)
      Attempts to republish an existing Representation of a Representatable
      Parameters:
      objectReference - Reference of the Representable to be published
      refRef - Reference of the Representation
      jobSource - Source that submitted the job, 0=unknown, 1=manual, 2=checkin, 3=schedule
      Returns:
      boolean true if successful

      Supported API: true