Package com.ptc.wvs.common.ui

Class PublisherAction

java.lang.Object
com.ptc.wvs.common.ui.ProcessingAction
com.ptc.wvs.common.ui.PublisherAction
public class PublisherAction extends ProcessingAction
Helper class for creating the action string that can be passed as an argument to Publisher.doPublish methods. The action string contains specific options for the publishing job. The format of the action string is: name1=value1,name2=value2 The use of the toString method will return the action string with the correct format. Note: as "=" and "," are used as separators, name and value can not contain these characters and they will be removed. The following is an example of how to use the PublisherAction: 
     PublisherAction publisherAction = new PublisherAction();
     publisherAction.addAction(PublisherAction.POSASSY, "true");
     publisherAction.addAction(PublisherAction.QUEUEPRIORITY, "H");

     Publisher publisher = new Publisher();
     publisher.doPublish(false, false, objRef, configRef, partConfigRef,
                         false, "repname", "repdesc", Publisher.PART, PublisherAction.toString());
The following is the grammar for the PUBRULENAME action. pubrulename=<param-set-name> Optional. <param-set-name> Optional.

Supported API: true

Extendable: false

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CADINSTNAME
    Action String Name for the CAD Part name to be used Value can be: a CAD Part name that exists in the CAD data

    Supported API: true
    static final String
    CADREPNAME
    Action String Name for the CAD Form name to be used Value can be: a CAD Form name that exists in the CAD data

    Supported API: true
    static final String
    DOCUMENTFILE
    Action String Name for the file on a WTDocument to be published If not specified all files will be published, assuming they have a worker associated.
    static final String
    IGNOREPRECONVERTEDEDZ
    Action String Name for setting how preconverted EDZ data will be published Value can be: "false" - use preconverted EDZ file if it exists (default) "true" - ignore any preconverted EDZ file

    Supported API: true
    static final String
    JOBINFO
    Action String Name for the "job info string" to be passed to the job Value can be: a string which must not contain the '=' or ',' characters The string is written to the file "wvsinfo.properties", as the property "jobinfo".
    static final String
    POSASSY
    Action String Name for setting publishing as positioning assembly Value can be: "false" - publish normally (default) "true" - publish as a positioning assembly

    Supported API: true
    static final String
    PROCESSTYPE
    Action String Name for setting the processing type for the publish job.
    static final String
    REFERENCEDFILES
    Action String Name for setting how referenced data will be published Value can be: "false" - do not publish dependents (default) "true" - publish dependents "republish" - republish dependents

    Supported API: true

    Fields inherited from class com.ptc.wvs.common.ui.ProcessingAction

    QUEUEPRIORITY, QUEUESET

  • Constructor Summary

    Constructors
    Constructor
    Description
    PublisherAction()
    Create a new PublisherAction object.
    PublisherAction(String name, String value)
    Create a new PublisherAction object, specifying an action Neither name or value can be null

    Supported API: true

  • Method Summary

    Methods inherited from class com.ptc.wvs.common.ui.ProcessingAction

    addAction, getActions, isSet, isSynchronous, removeSynchronous, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

    • PROCESSTYPE

      public static final String PROCESSTYPE
      Action String Name for setting the processing type for the publish job. Value can be: "0" - publish process marked out of date (default) "1" - only publish ie. no mark out of date "2" - only mark out of date, ie no publish

      Supported API: true
      See Also:

    • REFERENCEDFILES

      public static final String REFERENCEDFILES
      Action String Name for setting how referenced data will be published Value can be: "false" - do not publish dependents (default) "true" - publish dependents "republish" - republish dependents

      Supported API: true
      See Also:

    • POSASSY

      public static final String POSASSY
      Action String Name for setting publishing as positioning assembly Value can be: "false" - publish normally (default) "true" - publish as a positioning assembly

      Supported API: true
      See Also:

    • CADREPNAME

      public static final String CADREPNAME
      Action String Name for the CAD Form name to be used Value can be: a CAD Form name that exists in the CAD data

      Supported API: true
      See Also:

    • CADINSTNAME

      public static final String CADINSTNAME
      Action String Name for the CAD Part name to be used Value can be: a CAD Part name that exists in the CAD data

      Supported API: true
      See Also:

    • DOCUMENTFILE

      public static final String DOCUMENTFILE
      Action String Name for the file on a WTDocument to be published If not specified all files will be published, assuming they have a worker associated. Value can be: a file name which is content on the WTDocument

      Supported API: true
      See Also:

    • JOBINFO

      public static final String JOBINFO
      Action String Name for the "job info string" to be passed to the job Value can be: a string which must not contain the '=' or ',' characters The string is written to the file "wvsinfo.properties", as the property "jobinfo". This file can be read by a worker custom hook or the generic worker etc

      Supported API: true
      See Also:

    • IGNOREPRECONVERTEDEDZ

      public static final String IGNOREPRECONVERTEDEDZ
      Action String Name for setting how preconverted EDZ data will be published Value can be: "false" - use preconverted EDZ file if it exists (default) "true" - ignore any preconverted EDZ file

      Supported API: true
      See Also:

  • Constructor Details

    • PublisherAction

      public PublisherAction()
      Create a new PublisherAction object.

      Supported API: true

    • PublisherAction

      public PublisherAction(String name, String value)
      Create a new PublisherAction object, specifying an action Neither name or value can be null

      Supported API: true
      Parameters:
      name - action name
      value - action value