Package org.cip4.jdflib.jmf

Class JDFMessage

java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.cip4.jdflib.core.KElement
org.cip4.jdflib.core.JDFElement
org.cip4.jdflib.auto.JDFAutoMessage
org.cip4.jdflib.jmf.JDFMessage
All Implemented Interfaces:
Serializable, Cloneable, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
JDFAutoAcknowledge, JDFAutoCommand, JDFAutoQuery, JDFAutoRegistration, JDFAutoResponse, JDFAutoSignal
public class JDFMessage extends JDFAutoMessage
super class for all message families Signal, Command,...
See Also:

  • Constructor Details

    • JDFMessage

      public JDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
      Constructor for JDFMessage
      Parameters:
      myOwnerDocument -
      qualifiedName -

    • JDFMessage

      public JDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
      Constructor for JDFMessage
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -

    • JDFMessage

      public JDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
      Constructor for JDFMessage
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -
      myLocalName -

  • Method Details

    • isStrictValidation

      public static boolean isStrictValidation()
      if true, all typesafe calls are strictly validated
      Returns:
      the strictValidation

    • setStrictValidation

      public static void setStrictValidation(boolean strictValidation)
      set false to switch off jmf validation when adding elements set true (default) to enable run time checking when constructing JMF messages
      Parameters:
      strictValidation - the strictValidation to set

    • getTheAttributeInfo

      protected AttributeInfo getTheAttributeInfo()
      Overrides:
      getTheAttributeInfo in class JDFAutoMessage
      Returns:

    • getTheElementInfo

      protected ElementInfo getTheElementInfo()
      Overrides:
      getTheElementInfo in class JDFElement
      Returns:
      the elementinfo

    • isMessageElement

      @Deprecated public boolean isMessageElement()
      Deprecated.
      use instanceof JDFMessage
      IsMessageElement - is a message with this name a message element?
      Returns:
      boolean

    • init

      public boolean init()
      init
      Overrides:
      init in class JDFElement
      Returns:
      boolean
      See Also:

    • getIDPrefix

      public String getIDPrefix()
      getIDPrefix
      Overrides:
      getIDPrefix in class KElement
      Returns:
      the ID prefix of JDFMessage

    • getFamily

      public JDFMessage.EnumFamily getFamily()
      getFamily: get the enum family type
      Returns:
      EnumFamily - type Family_Unknown, Family_Query, Family_Signal, Family_Command, Family_Response or Family_Acknowledge

    • getType

      public String getType()
      getType: get attribute Type
      Overrides:
      getType in class JDFAutoMessage
      Returns:
      String

    • setType

      public void setType(String typ)
      Set attribute Type and xsi:type
      Overrides:
      setType in class JDFAutoMessage
      Parameters:
      typ - the type

    • setQuery

      public void setQuery(JDFMessage q)
      SetQuery - sets the initiating query, command, Acknowledge, Signal or registration to q
      Parameters:
      q - the query, command or registration to create a response for

    • typeString

      public static String typeString(JDFMessage.EnumType value)
      Enumeration string for enum value
      Parameters:
      value - the enumeration to translate
      Returns:
      String the string representation of the enumeration

    • typeString

      @Deprecated public static String typeString()
      Deprecated.
      use EnumType to get strings
      Returns:

    • setEnumType

      @Deprecated public void setEnumType(JDFMessage.EnumType value)
      Deprecated.
      use setType()
      Set attribute Type
      Parameters:
      value - the value to set the attribute to

    • setType

      public void setType(JDFMessage.EnumType value)
      Set attribute Type
      Parameters:
      value - the value to set the attribute to

    • createResponse

      public JDFJMF createResponse()
      create a new response for this if this is any message except response correctly fills refId, type etc.
      Returns:
      the newly created message

    • createSignal

      public JDFJMF createSignal()
      create a new signal for this if this is any message except response correctly fills refId, type etc.
      Returns:
      the newly created message

    • isValidMessageElement

      public boolean isValidMessageElement(String elementName, int iSkip)
      checks whether the type of messageElement is valid for this message
      Parameters:
      elementName - the name of the element to be tested
      iSkip -
      Returns:
      boolean: true if valid; always true if not in JDFNameSpace

    • getEnumType

      public JDFMessage.EnumType getEnumType()
      Typesafe enumerated attribute Type
      Returns:
      EnumType: the enumeration value of the attribute

    • appendValidElement

      public KElement appendValidElement(String elementName, String nameSpaceURI)
      append an element
      throws a JDFException, if elementName is not legal and strictValidation is switched on
      Parameters:
      elementName - name of the element to append
      nameSpaceURI - namespace URI of the element to append
      Returns:
      the appended element

    • appendValidElement

      @Deprecated public KElement appendValidElement(String elementName)
      Deprecated.
      use appendValidElement(elementName, null);
      Parameters:
      elementName -
      Returns:

    • getValidElement

      public KElement getValidElement(String nodeName, String nameSpaceURI, int iSkip)
      get a (valid) element
      throws JDFException if the element is not valid and strictValidation is switched on
      Parameters:
      nodeName - name of the element to get
      nameSpaceURI - namespace URI of the element to get
      iSkip - number of elements to skip
      Returns:
      the element

    • getCreateValidElement

      public KElement getCreateValidElement(String nodeName, String nameSpaceURI, int iSkip)
      get a (valid) element, create if it doesn't exist
      throws JDFException if the element is not valid and strictValidation is switched on
      Parameters:
      nodeName - name of the element to get
      nameSpaceURI - namespace URI of the element to get
      iSkip - number of elements to skip
      Returns:
      KElement

    • getCreateDevice

      public JDFDevice getCreateDevice(int iSkip)
      get device, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDevice

    • appendDevice

      public JDFDevice appendDevice()
      append element Device
      Returns:
      JDFDevice: the element

    • getDevice

      public JDFDevice getDevice(int iSkip)
      get the iSkip'th device
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDevice: the element

    • getCreateDeviceFilter

      public JDFDeviceFilter getCreateDeviceFilter(int iSkip)
      get iSkip'th element DeviceFilter, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDeviceFilter: the element

    • appendDeviceFilter

      public JDFDeviceFilter appendDeviceFilter()
      append element DeviceFilter
      Returns:
      JDFDeviceFilter: the element

    • getDeviceFilter

      public JDFDeviceFilter getDeviceFilter(int iSkip)
      get iSkip'th element DeviceFilter
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDeviceFilter: the element

    • getCreateDeviceInfo

      public JDFDeviceInfo getCreateDeviceInfo(int iSkip)
      get element DeviceInfo, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDeviceInfo: the element

    • appendDeviceInfo

      public JDFDeviceInfo appendDeviceInfo()
      append element DeviceInfo
      Returns:
      JDFDeviceInfo: the element

    • getDeviceInfo

      public JDFDeviceInfo getDeviceInfo(int iSkip)
      get iSkip'th element DeviceInfo
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDeviceInfo: the element

    • getDeviceInfo

      public JDFDeviceInfo getDeviceInfo(String deviceID)
      get a matching deviceInfo for a given DeviceID
      Parameters:
      deviceID - the deviceID of the device to get
      Returns:

    • getCreateDeviceInfo

      public JDFDeviceInfo getCreateDeviceInfo(String deviceID)
      get a matching deviceInfo for a given DeviceID, create it if it does not exist
      Parameters:
      deviceID - the deviceID of the device to get
      Returns:

    • getCreateDeviceList

      public JDFDeviceList getCreateDeviceList(int iSkip)
      get Element DeviceList, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDeviceList: the element

    • appendDeviceList

      public JDFDeviceList appendDeviceList()
      Append element DeviceList
      Returns:
      JDFDeviceList the element

    • getDeviceList

      public JDFDeviceList getDeviceList(int iSkip)
      get iSkip'th DeviceList element
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFDeviceList: the element

    • getCreateEmployeeDef

      public JDFEmployeeDef getCreateEmployeeDef(int iSkip)
      get element EmployeeDef, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFEmployeeDef: the element

    • appendEmployeeDef

      public JDFEmployeeDef appendEmployeeDef()
      Append element EmployeeDef
      Returns:
      JDFEmployeeDef: the element

    • getEmployeeDef

      public JDFEmployeeDef getEmployeeDef(int iSkip)
      get iSkip'th element EmployeeDef
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFEmployeeDef: the element

    • getCreateJDFController

      public JDFJDFController getCreateJDFController(int iSkip)
      get Element JDFController, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFJDFController: the element

    • appendJDFController

      public JDFJDFController appendJDFController()
      Append element JDFController
      Returns:
      JDFJDFController: the element

    • getJDFController

      public JDFJDFController getJDFController(int iSkip)
      get iSkip'th JDFController element
      Parameters:
      iSkip - number of elemts to skip
      Returns:
      JDFJDFController: the element

    • getCreateJDFService

      public JDFJDFService getCreateJDFService(int iSkip)
      get iSkip'th element JDFService, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFJDFService: the element

    • appendJDFService

      public JDFJDFService appendJDFService()
      Append element JDFService
      Returns:
      JDFJDFService the element

    • getJDFService

      public JDFJDFService getJDFService(int iSkip)
      get iSkip'th JDFService element
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFJDFService: the element

    • getCreateGangInfo

      public JDFGangInfo getCreateGangInfo(int iSkip)
      get iSkip'th element GangInfo, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFGangInfo: the element

    • appendGangInfo

      public JDFGangInfo appendGangInfo()
      Append element GangInfo
      Returns:
      JDFGangInfo the element

    • getGangInfo

      public JDFGangInfo getGangInfo(int iSkip)
      get iSkip'th GangInfo element
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFGangInfo: the element

    • getCreateJobPhase

      public JDFJobPhase getCreateJobPhase(int iSkip)
      get Element JobPhase, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFJobPhase: the element

    • appendJobPhase

      public JDFJobPhase appendJobPhase()
      append element JobPhase
      Returns:
      JDFJobPhase: the element

    • getJobPhase

      public JDFJobPhase getJobPhase(int iSkip)
      get iSkip'th JobPhase element
      Parameters:
      iSkip - elements to skip
      Returns:
      JDFJobPhase: the element

    • getCreateKnownMsgQuParams

      public JDFKnownMsgQuParams getCreateKnownMsgQuParams(int iSkip)
      get iSkip'th KnownMsgQuParams element, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFKnownMsgQuParams the element

    • appendKnownMsgQuParams

      public JDFKnownMsgQuParams appendKnownMsgQuParams()
      append element KnownMsgQuParams
      Returns:
      JDFKnownMsgQuParams: the element

    • getKnownMsgQuParams

      public JDFKnownMsgQuParams getKnownMsgQuParams(int iSkip)
      get iSkip'th KnownMsgQuParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFKnownMsgQuParams: the element

    • getCreateMessageService

      public JDFMessageService getCreateMessageService(int iSkip)
      get iSkip'th element MessageService, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFMessageService: the element

    • appendMessageService

      public JDFMessageService appendMessageService()
      append element MessageService
      Returns:

    • getMessageService

      public JDFMessageService getMessageService(int iSkip)
      get iSkip'th element MessageService
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFMessageService: the element

    • getCreateMsgFilter

      public JDFMsgFilter getCreateMsgFilter(int iSkip)
      get element MsgFilter, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFMsgFilter: the element

    • appendMsgFilter

      public JDFMsgFilter appendMsgFilter()
      append element MsgFilter
      Returns:
      JDFMsgFilter: the element

    • getMsgFilter

      public JDFMsgFilter getMsgFilter(int iSkip)
      get iSkip'th element MsgFilter
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFMsgFilter: the element

    • getCreateNotificationDef

      public JDFNotificationDef getCreateNotificationDef(int iSkip)
      get element NotificationDef, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFNotificationDef: the element

    • appendNotificationDef

      public JDFNotificationDef appendNotificationDef()
      append element NotificationDef
      Returns:
      JDFNotificationDef: the element

    • getNotificationDef

      public JDFNotificationDef getNotificationDef(int iSkip)
      get iSkip'th element NotificationDef
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFNotificationDef: the element

    • getCreateNotificationFilter

      public JDFNotificationFilter getCreateNotificationFilter(int iSkip)
      get element NotificationFilter, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFNotificationFilter: the element

    • appendNotificationFilter

      public JDFNotificationFilter appendNotificationFilter()
      append element NotificationFilter
      Returns:
      JDFNotificationFilter: the element

    • getNotificationFilter

      public JDFNotificationFilter getNotificationFilter(int iSkip)
      get iSkip'th NotificationFilter element
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFNotificationFilter: the element

    • getCreateOccupation

      public JDFOccupation getCreateOccupation(int iSkip)
      get iSkip'th Occupation element
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFOccupation: the element

    • appendOccupation

      public JDFOccupation appendOccupation()
      append element Occupation
      Returns:
      JDFOccupation: the element

    • getOccupation

      public JDFOccupation getOccupation(int iSkip)
      get iSkip'th element Occupation
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFOccupation: the element

    • getCreatePipeParams

      public JDFPipeParams getCreatePipeParams(int iSkip)
      get iSkip'th element PipeParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFPipeParams: the element

    • appendPipeParams

      public JDFPipeParams appendPipeParams()
      append element PipeParams
      Returns:
      JDFPipeParams: the element

    • getPipeParams

      public JDFPipeParams getPipeParams()
      get element PipeParams
      Returns:
      JDFPipeParams: the element

    • getPipeParams

      @Deprecated public JDFPipeParams getPipeParams(int iSkip)
      Deprecated.
      - use the 0 parameter version
      get iSkip'th element PipeParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFPipeParams: the element

    • getCreateQueue

      public JDFQueue getCreateQueue(int iSkip)
      get iSkip'th element Queue
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueue: the element

    • appendQueue

      public JDFQueue appendQueue()
      append element Queue
      Returns:
      JDFQueue: the element

    • getQueue

      public JDFQueue getQueue(int iSkip)
      get iSkip'th element Queue
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueue: the element

    • getCreateQueueEntry

      public JDFQueueEntry getCreateQueueEntry(int iSkip)
      get iSkip'th element QueueEntry, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntry: the element

    • appendQueueEntry

      public JDFQueueEntry appendQueueEntry()
      append element QueueEntry
      Returns:
      JDFQueueEntry: the element

    • getQueueEntry

      public JDFQueueEntry getQueueEntry(int iSkip)
      get iSkip'th element QueueEntry
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntry: the element

    • getCreateQueueEntryDef

      public JDFQueueEntryDef getCreateQueueEntryDef(int iSkip)
      get iSkip'th element QueueEntryDef, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryDef: the element

    • appendQueueEntryDef

      public JDFQueueEntryDef appendQueueEntryDef()
      append element QueueEntryDef
      Returns:
      JDFQueueEntryDef: the element

    • getQueueEntryDef

      public JDFQueueEntryDef getQueueEntryDef(int iSkip)
      get iSkip'th element QueueEntryDef
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryDef: the element

    • getCreateQueueEntryDefList

      public JDFQueueEntryDefList getCreateQueueEntryDefList(int iSkip)
      get iSkip'th element QueueEntryDefList, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryDefList: the element

    • appendQueueEntryDefList

      public JDFQueueEntryDefList appendQueueEntryDefList()
      append element QueueEntryDefList
      Returns:
      JDFQueueEntryDefList: the element

    • getQueueEntryDefList

      public JDFQueueEntryDefList getQueueEntryDefList(int iSkip)
      get iSkip'th element QueueEntryDefList
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryDefList: the element

    • getCreateQueueEntryPriParams

      public JDFQueueEntryPriParams getCreateQueueEntryPriParams(int iSkip)
      get iSkip'th element QueueEntryPriParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryPriParams: the element

    • appendQueueEntryPriParams

      public JDFQueueEntryPriParams appendQueueEntryPriParams()
      append element QueueEntryPriParams
      Returns:
      JDFQueueEntryPriParams: the element

    • getQueueEntryPriParams

      public JDFQueueEntryPriParams getQueueEntryPriParams(int iSkip)
      get iSkip'th element QueueEntryPriParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryPriParams: the element

    • getCreateQueueEntryPosParams

      public JDFQueueEntryPosParams getCreateQueueEntryPosParams(int iSkip)
      get iSkip'th element QueueEntryPosParams, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryPosParams: the element

    • appendQueueEntryPosParams

      public JDFQueueEntryPosParams appendQueueEntryPosParams()
      append element QueueEntryPosParams
      Returns:
      JDFQueueEntryPosParams: the element

    • getQueueEntryPosParams

      public JDFQueueEntryPosParams getQueueEntryPosParams(int iSkip)
      get iSkip'th element QeueEntryPosParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueEntryPosParams: the element

    • getCreateQueueSubmissionParams

      public JDFQueueSubmissionParams getCreateQueueSubmissionParams(int iSkip)
      get iSkip'th element QueueSubmissionParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueSubmissionParams: the element

    • appendQueueSubmissionParams

      public JDFQueueSubmissionParams appendQueueSubmissionParams()
      append element QueueSubmissionParams
      Returns:
      JDFQueueSubmissionParams: the element

    • getQueueSubmissionParams

      public JDFQueueSubmissionParams getQueueSubmissionParams(int iSkip)
      get iSkip'th element QueueSubmissionParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFQueueSubmissionParams: the element

    • getCreateResourceCmdParams

      public JDFResourceCmdParams getCreateResourceCmdParams(int iSkip)
      get iSkip'th element ResourceCmdParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFResourceCmdParams: the element

    • appendResourceCmdParams

      public JDFResourceCmdParams appendResourceCmdParams()
      append element ResourceCmdParams
      Returns:
      JDFResourceCmdParams: the element

    • getResourceCmdParams

      public JDFResourceCmdParams getResourceCmdParams(int iSkip)
      get iSkip'th element ResourceCmdParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFResourceCmdParams: the element

    • getCreateResourceQuParams

      public JDFResourceQuParams getCreateResourceQuParams(int iSkip)
      get iSkip'th element ResourceQuParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFResourceQuParams: the element

    • appendResourceQuParams

      public JDFResourceQuParams appendResourceQuParams()
      append element ResourceQuParams
      Returns:
      JDFResourceQuParams: the element

    • getResourceQuParams

      @Deprecated public JDFResourceQuParams getResourceQuParams(int iSkip)
      Deprecated.
      use null parameter version
      get iSkip'th element ResourceQuParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFResourceQuParams: the element

    • getResourceQuParams

      public JDFResourceQuParams getResourceQuParams()
      get first element ResourceQuParams
      Returns:
      JDFResourceQuParams: the element

    • getCreateResourceInfo

      public JDFResourceInfo getCreateResourceInfo(int iSkip)
      get iSkip'th element ResourceInfo
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFResourceInfo: the element

    • appendResourceInfo

      public JDFResourceInfo appendResourceInfo()
      append element ResourceInfo
      Returns:
      JDFResourceInfo: the element

    • getResourceInfo

      public JDFResourceInfo getResourceInfo(int iSkip)
      get iSkip'th element ResourceInfo
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFResourceInfo: the element

    • getCreateStatusQuParams

      public JDFStatusQuParams getCreateStatusQuParams(int iSkip)
      get iSkip'th element StatusQuParams, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFStatusQuParams: the element

    • appendStatusQuParams

      public JDFStatusQuParams appendStatusQuParams()
      append element StatusQuParams
      Returns:
      JDFStatusQuParams: the element

    • getStatusQuParams

      @Deprecated public JDFStatusQuParams getStatusQuParams(int iSkip)
      Deprecated.
      - use 0 parameter version
      get iSkip'th element StatusQuParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFStatusQuParams: the element

    • getStatusQuParams

      public JDFStatusQuParams getStatusQuParams()
      get StatusQuParams
      Returns:
      JDFStatusQuParams: the element

    • getCreateStopPersChParams

      public JDFStopPersChParams getCreateStopPersChParams(int iSkip)
      get iSkip'th element StopPersChParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFStopPersChParams: the element

    • appendStopPersChParams

      public JDFStopPersChParams appendStopPersChParams()
      append element StopPersChParams
      Returns:
      JDFStopPersChParams: the element

    • getStopPersChParams

      public JDFStopPersChParams getStopPersChParams(int iSkip)
      get iSkip'th element StopPersChParams
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFStopPersChParams: the element

    • getCreateSubmissionMethods

      public JDFSubmissionMethods getCreateSubmissionMethods(int iSkip)
      get iSkip'th element SubmissionMethods
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFSubmissionMethods: the element

    • appendSubmissionMethods

      public JDFSubmissionMethods appendSubmissionMethods()
      append element SubmissionMethods
      Returns:
      JDFSubmissionMethods: the element

    • getSubmissionMethods

      public JDFSubmissionMethods getSubmissionMethods(int iSkip)
      get iSkip'th element SubMissionMethods
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFSubmissionMethods: the element

    • getCreateTrackFilter

      public JDFTrackFilter getCreateTrackFilter(int iSkip)
      get iSkip'th element TrackFilter
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFTrackFilter: the element

    • appendTrackFilter

      public JDFTrackFilter appendTrackFilter()
      append element TrackFilter
      Returns:
      JDFTrackFilter: the element

    • getTrackFilter

      public JDFTrackFilter getTrackFilter(int iSkip)
      get iSkip'th element TrackFilter
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFTrackFilter: the element

    • getCreateTrackResult

      public JDFTrackResult getCreateTrackResult(int iSkip)
      get iSkip'th element TrackResult
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFTrackResult: the element

    • appendTrackResult

      public JDFTrackResult appendTrackResult()
      append element TrackResult
      Returns:
      JDFTrackResult: the element

    • getTrackResult

      public JDFTrackResult getTrackResult(int iSkip)
      get the iSkip'th element TrackResult
      Parameters:
      iSkip - the number of elements to skip
      Returns:
      JDFTrackResult: the element

    • getReturnCode

      public int getReturnCode()
      Returns the ReturnCode; applies to JmfResponse and JmfAcknowledge.
      Returns:
      ConstReturnCode

    • getCreateIDInfo

      public JDFIDInfo getCreateIDInfo(int iSkip)
      get iSkip'th element IDInfo, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFIDInfo: the element

    • appendIDInfo

      public JDFIDInfo appendIDInfo()
      append element IDInfo JDFIDInfo: the element
      Returns:

    • getIDInfo

      public JDFIDInfo getIDInfo(int iSkip)
      get iSkip'th element IDInfo
      Parameters:
      iSkip - number of elements to skip JDFIDInfo: the element
      Returns:

    • appendGangQuFilter

      public JDFGangQuFilter appendGangQuFilter()
      append element IDInfo JDFIDInfo: the element
      Returns:

    • getJDFGangQuFilter

      public JDFGangQuFilter getJDFGangQuFilter(int iSkip)
      get iSkip'th element IDInfo
      Parameters:
      iSkip - number of elements to skip JDFIDInfo: the element
      Returns:

    • appendGangCmdFilter

      public JDFGangCmdFilter appendGangCmdFilter()
      append element IDInfo JDFIDInfo: the element
      Returns:

    • getJDFGangCmdFilter

      public JDFGangCmdFilter getJDFGangCmdFilter(int iSkip)
      get iSkip'th element IDInfo
      Parameters:
      iSkip - number of elements to skip JDFIDInfo: the element
      Returns:

    • getCreateFlushedResources

      public JDFFlushedResources getCreateFlushedResources(int iSkip)
      get iSkip'th element FlushedResources
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFFlushedResources: the element

    • appendFlushedResources

      public JDFFlushedResources appendFlushedResources()
      append element FlushedResources
      Returns:
      JDFFlushedResources: the element

    • getFlushedResources

      public JDFFlushedResources getFlushedResources(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateFlushQueueParams

      public JDFFlushQueueParams getCreateFlushQueueParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateFlushQueueInfo

      public JDFFlushQueueInfo getCreateFlushQueueInfo(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getFlushQueueInfo

      public JDFFlushQueueInfo getFlushQueueInfo(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendAbortQueueEntryParams

      public JDFAbortQueueEntryParams appendAbortQueueEntryParams()
      Returns:

    • getAbortQueueEntryParams

      public JDFAbortQueueEntryParams getAbortQueueEntryParams()
      Returns:

    • getCreateAbortQueueEntryParams

      public JDFAbortQueueEntryParams getCreateAbortQueueEntryParams()
      Returns:

    • appendFlushQueueParams

      public JDFFlushQueueParams appendFlushQueueParams()
      Returns:

    • appendFlushQueueInfo

      public JDFFlushQueueInfo appendFlushQueueInfo()
      Returns:

    • getFlushQueueParams

      public JDFFlushQueueParams getFlushQueueParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateFlushResourceParams

      public JDFFlushResourceParams getCreateFlushResourceParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendFlushResourceParams

      public JDFFlushResourceParams appendFlushResourceParams()
      Returns:

    • getFlushResourceParams

      public JDFFlushResourceParams getFlushResourceParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateNewJDFCmdParams

      public JDFNewJDFCmdParams getCreateNewJDFCmdParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendNewJDFCmdParams

      public JDFNewJDFCmdParams appendNewJDFCmdParams()
      Returns:

    • getNewJDFCmdParams

      public JDFNewJDFCmdParams getNewJDFCmdParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateNewJDFQuParams

      public JDFNewJDFQuParams getCreateNewJDFQuParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendNewJDFQuParams

      public JDFNewJDFQuParams appendNewJDFQuParams()
      Returns:

    • getNewJDFQuParams

      public JDFNewJDFQuParams getNewJDFQuParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateNodeInfoCmdParams

      public JDFNodeInfoCmdParams getCreateNodeInfoCmdParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendNodeInfoCmdParams

      public JDFNodeInfoCmdParams appendNodeInfoCmdParams()
      Returns:

    • getNodeInfoCmdParams

      public JDFNodeInfoCmdParams getNodeInfoCmdParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateNodeInfoQuParams

      public JDFNodeInfoQuParams getCreateNodeInfoQuParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendNodeInfoQuParams

      public JDFNodeInfoQuParams appendNodeInfoQuParams()
      Returns:

    • getNodeInfoQuParams

      public JDFNodeInfoQuParams getNodeInfoQuParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateNodeInfoResp

      public JDFNodeInfoResp getCreateNodeInfoResp(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendNodeInfoResp

      public JDFNodeInfoResp appendNodeInfoResp()
      Returns:

    • getNodeInfoResp

      public JDFNodeInfoResp getNodeInfoResp(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateQueueFilter

      public JDFQueueFilter getCreateQueueFilter(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendQueueFilter

      public JDFQueueFilter appendQueueFilter()
      Returns:

    • getQueueFilter

      public JDFQueueFilter getQueueFilter(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateRequestQueueEntryParams

      public JDFRequestQueueEntryParams getCreateRequestQueueEntryParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendRequestQueueEntryParams

      public JDFRequestQueueEntryParams appendRequestQueueEntryParams()
      Returns:

    • getRequestQueueEntryParams

      public JDFRequestQueueEntryParams getRequestQueueEntryParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendResourcePullParams

      public JDFResourcePullParams appendResourcePullParams()
      Returns:

    • getResourcePullParams

      public JDFResourcePullParams getResourcePullParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateResubmissionParams

      public JDFResubmissionParams getCreateResubmissionParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendResubmissionParams

      public JDFResubmissionParams appendResubmissionParams()
      Returns:

    • getResubmissionParams

      public JDFResubmissionParams getResubmissionParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateReturnQueueEntryParams

      public JDFReturnQueueEntryParams getCreateReturnQueueEntryParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendReturnQueueEntryParams

      public JDFReturnQueueEntryParams appendReturnQueueEntryParams()
      Returns:

    • getReturnQueueEntryParams

      public JDFReturnQueueEntryParams getReturnQueueEntryParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateSubscriptionInfo

      public JDFSubscriptionInfo getCreateSubscriptionInfo(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendSubscriptionInfo

      public JDFSubscriptionInfo appendSubscriptionInfo()
      Returns:

    • getSubscriptionInfo

      public JDFSubscriptionInfo getSubscriptionInfo(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getSubscriptionFilter

      public JDFSubscriptionFilter getSubscriptionFilter()
      Returns:

    • getCreateSubscriptionFilter

      public JDFSubscriptionFilter getCreateSubscriptionFilter()
      Returns:

    • appendSubscriptionFilter

      public JDFSubscriptionFilter appendSubscriptionFilter()
      Returns:

    • getCreateShutDownCmdParams

      public JDFShutDownCmdParams getCreateShutDownCmdParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • appendShutDownCmdParams

      public JDFShutDownCmdParams appendShutDownCmdParams()
      Returns:

    • getShutDownCmdParams

      public JDFShutDownCmdParams getShutDownCmdParams(int iSkip)
      Parameters:
      iSkip -
      Returns:

    • getCreateWakeUpCmdParams

      public JDFWakeUpCmdParams getCreateWakeUpCmdParams()
      Returns:

    • appendWakeUpCmdParams

      public JDFWakeUpCmdParams appendWakeUpCmdParams()
      Returns:

    • getWakeUpCmdParams

      public JDFWakeUpCmdParams getWakeUpCmdParams()
      Returns:

    • getCreateModifyNodeCmdParams

      public JDFModifyNodeCmdParams getCreateModifyNodeCmdParams()
      Returns:

    • appendModifyNodeCmdParams

      public JDFModifyNodeCmdParams appendModifyNodeCmdParams()
      Returns:

    • getModifyNodeCmdParams

      public JDFModifyNodeCmdParams getModifyNodeCmdParams()
      Returns:

    • getCreateUpdateJDFCmdParams

      public JDFUpdateJDFCmdParams getCreateUpdateJDFCmdParams()
      Returns:

    • appendUpdateJDFCmdParams

      public JDFUpdateJDFCmdParams appendUpdateJDFCmdParams()
      Returns:

    • getUpdateJDFCmdParams

      public JDFUpdateJDFCmdParams getUpdateJDFCmdParams()
      Returns:

    • getrefID

      public String getrefID()
      Method getrefID.
      Returns:
      String

    • setrefID

      public void setrefID(String refID)
      Method setrefID.
      Parameters:
      refID -

    • getInvalidElements

      public VString getInvalidElements(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)
      Description copied from class: JDFElement
      get invalid elements
      Overrides:
      getInvalidElements in class JDFElement
      Parameters:
      level - validation level
      bIgnorePrivate - if true, do not worry about elements in other namespaces
      nMax - maximum size of the returned vector
      Returns:
      VString - a vector of invalid element names
      See Also:

    • optionalElements

      public VString optionalElements()
      definition of optional elements in the JDF namespace
      Overrides:
      optionalElements in class JDFElement
      Returns:
      VString the comma separated list of optional element names

    • getInvalidAttributes

      public VString getInvalidAttributes(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)
      Description copied from class: JDFElement
      get invalid attributes
      Overrides:
      getInvalidAttributes in class JDFElement
      Parameters:
      level - validation level
      bIgnorePrivate - if true, do not worry about attributes in other namespaces
      nMax - maximum size of the returned vector
      Returns:
      VString - a vector of invalid attribute names
      See Also:

    • getICSVersions

      public VString getICSVersions()
      (21) get VString attribute ICSVersions, grab from parent JMF if none exists here
      Overrides:
      getICSVersions in class JDFAutoMessage
      Returns:
      VString the value of the attribute

    • getSenderID

      public String getSenderID()
      gets the senderID of this message
      Overrides:
      getSenderID in class JDFAutoMessage
      Returns:
      String the senderID of this message or the SenderID of the parent JMF; null if neither are specified

    • getDeprecatedElements

      public VString getDeprecatedElements(int nMax)
      Description copied from class: JDFElement
      Vector of deprecated elements below the current element.

      default: getDeprecatedElements(99999999)

      Overrides:
      getDeprecatedElements in class JDFElement
      Parameters:
      nMax -
      Returns:
      See Also:

    • getLastVersion

      public JDFElement.EnumVersion getLastVersion(String eaName, boolean bElement)
      Description copied from class: JDFElement
      get the last JDF version where attribute name or element name is valid
      Overrides:
      getLastVersion in class JDFElement
      Parameters:
      eaName -
      bElement -
      Returns:
      See Also:

    • getTime

      public JDFDate getTime()
      Description copied from class: JDFAutoMessage
      (12) get JDFDate attribute Time
      Overrides:
      getTime in class JDFAutoMessage
      Returns:
      JDFDate the value of the attribute
      See Also: