org.cip4.jdflib.jmf
Class JDFResponse

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.cip4.jdflib.core.KElement
                          extended by org.cip4.jdflib.core.JDFElement
                              extended by org.cip4.jdflib.auto.JDFAutoMessage
                                  extended by org.cip4.jdflib.jmf.JDFMessage
                                      extended by org.cip4.jdflib.auto.JDFAutoResponse
                                          extended by org.cip4.jdflib.jmf.JDFResponse
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo

public class JDFResponse
extends JDFAutoResponse

Author:
Rainer Prosi, Heidelberger Druckmaschinen
See Also:
Serialized Form

Nested Class Summary
static class JDFResponse.EnumError
          inner class EnumClass
 
Nested classes/interfaces inherited from class org.cip4.jdflib.jmf.JDFMessage
JDFMessage.EnumFamily, JDFMessage.EnumType
 
Nested classes/interfaces inherited from class org.cip4.jdflib.core.JDFElement
JDFElement.EnumBoolean, JDFElement.EnumNamedColor, JDFElement.EnumNodeStatus, JDFElement.EnumOrientation, JDFElement.EnumPoolType, JDFElement.EnumSeparation, JDFElement.EnumSettingsPolicy, JDFElement.EnumValidationLevel, JDFElement.EnumVersion, JDFElement.EnumXYRelation
 
Nested classes/interfaces inherited from class org.cip4.jdflib.core.KElement
KElement.SimpleNodeComparator, KElement.SingleAttributeComparator, KElement.SingleXPathComparator
 
Field Summary
 
Fields inherited from class org.apache.xerces.dom.ElementNSImpl
localName, namespaceURI
 
Fields inherited from class org.apache.xerces.dom.ElementImpl
attributes, name
 
Fields inherited from class org.apache.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
 
Fields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
 
Fields inherited from class org.apache.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Fields inherited from interface org.w3c.dom.TypeInfo
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION
 
Constructor Summary
JDFResponse(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
          Constructor for JDFResponse
JDFResponse(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
          Constructor for JDFResponse
JDFResponse(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
          Constructor for JDFResponse
 
Method Summary
 JDFNotification setErrorText(String errorText)
          Deprecated. use public JDFNotification setErrorText(String errorText, EnumClass errorClass)
 JDFNotification setErrorText(String errorText, JDFAutoNotification.EnumClass errorClass)
          Set ErrorText, (Notification/Comment/#text) also sets Notification/@Type=Error and Notification/@Class=Error doesn't create a notification if ErroerText=null
 JDFAcknowledge splitAcknowledge()
          create an acknowledge JMF and set this to a pure acknowledge response
 String toString()
          toString
 
Methods inherited from class org.cip4.jdflib.auto.JDFAutoResponse
appendEmployee, appendNotification, getAcknowledged, getAllEmployee, getCreateEmployee, getCreateNotification, getEmployee, getNotification, getrefID, getReturnCode, getSubscribed, getTheAttributeInfo, getTheElementInfo, setAcknowledged, setrefID, setReturnCode, setSubscribed
 
Methods inherited from class org.cip4.jdflib.jmf.JDFMessage
appendDevice, appendDeviceFilter, appendDeviceInfo, appendDeviceList, appendEmployeeDef, appendFlushedResources, appendFlushQueueInfo, appendFlushQueueParams, appendFlushResourceParams, appendIDInfo, appendJDFController, appendJDFService, appendJobPhase, appendKnownMsgQuParams, appendMessageService, appendModifyNodeCmdParams, appendMsgFilter, appendNewJDFCmdParams, appendNewJDFQuParams, appendNodeInfoCmdParams, appendNodeInfoQuParams, appendNodeInfoResp, appendNotificationDef, appendNotificationFilter, appendOccupation, appendPipeParams, appendQueue, appendQueueEntry, appendQueueEntryDef, appendQueueEntryDefList, appendQueueEntryPosParams, appendQueueEntryPriParams, appendQueueFilter, appendQueueSubmissionParams, appendRequestQueueEntryParams, appendResourceCmdParams, appendResourceInfo, appendResourcePullParams, appendResourceQuParams, appendResubmissionParams, appendReturnQueueEntryParams, appendShutDownCmdParams, appendStatusQuParams, appendStopPersChParams, appendSubmissionMethods, appendSubscriptionFilter, appendSubscriptionInfo, appendTrackFilter, appendTrackResult, appendUpdateJDFCmdParams, appendValidElement, appendValidElement, appendWakeUpCmdParams, createResponse, getCreateDevice, getCreateDeviceFilter, getCreateDeviceInfo, getCreateDeviceInfo, getCreateDeviceList, getCreateEmployeeDef, getCreateFlushedResources, getCreateFlushQueueInfo, getCreateFlushQueueParams, getCreateFlushResourceParams, getCreateIDInfo, getCreateJDFController, getCreateJDFService, getCreateJobPhase, getCreateKnownMsgQuParams, getCreateMessageService, getCreateModifyNodeCmdParams, getCreateMsgFilter, getCreateNewJDFCmdParams, getCreateNewJDFQuParams, getCreateNodeInfoCmdParams, getCreateNodeInfoQuParams, getCreateNodeInfoResp, getCreateNotificationDef, getCreateNotificationFilter, getCreateOccupation, getCreatePipeParams, getCreateQueue, getCreateQueueEntry, getCreateQueueEntryDef, getCreateQueueEntryDefList, getCreateQueueEntryPosParams, getCreateQueueEntryPriParams, getCreateQueueFilter, getCreateQueueSubmissionParams, getCreateRequestQueueEntryParams, getCreateResourceCmdParams, getCreateResourceInfo, getCreateResourceQuParams, getCreateResubmissionParams, getCreateReturnQueueEntryParams, getCreateShutDownCmdParams, getCreateStatusQuParams, getCreateStopPersChParams, getCreateSubmissionMethods, getCreateSubscriptionFilter, getCreateSubscriptionInfo, getCreateTrackFilter, getCreateTrackResult, getCreateUpdateJDFCmdParams, getCreateValidElement, getCreateWakeUpCmdParams, getDeprecatedElements, getDevice, getDeviceFilter, getDeviceInfo, getDeviceInfo, getDeviceList, getEmployeeDef, getEnumType, getFamily, getFlushedResources, getFlushQueueInfo, getFlushQueueParams, getFlushResourceParams, getICSVersions, getIDInfo, getIDPrefix, getInvalidAttributes, getInvalidElements, getJDFController, getJDFService, getJobPhase, getKnownMsgQuParams, getLastVersion, getMessageService, getModifyNodeCmdParams, getMsgFilter, getNewJDFCmdParams, getNewJDFQuParams, getNodeInfoCmdParams, getNodeInfoQuParams, getNodeInfoResp, getNotificationDef, getNotificationFilter, getOccupation, getPipeParams, getPipeParams, getQueue, getQueueEntry, getQueueEntryDef, getQueueEntryDefList, getQueueEntryPosParams, getQueueEntryPriParams, getQueueFilter, getQueueSubmissionParams, getRequestQueueEntryParams, getResourceCmdParams, getResourceInfo, getResourcePullParams, getResourceQuParams, getResourceQuParams, getResubmissionParams, getReturnQueueEntryParams, getSenderID, getShutDownCmdParams, getStatusQuParams, getStatusQuParams, getStopPersChParams, getSubmissionMethods, getSubscriptionFilter, getSubscriptionInfo, getTime, getTrackFilter, getTrackResult, getType, getUpdateJDFCmdParams, getValidElement, getWakeUpCmdParams, init, isMessageElement, isStrictValidation, isValidMessageElement, optionalElements, setEnumType, setQuery, setStrictValidation, setType, setType, typeString, typeString
 
Methods inherited from class org.cip4.jdflib.auto.JDFAutoMessage
getAgentName, getAgentVersion, getID, setAgentName, setAgentVersion, setICSVersions, setID, setSenderID, setTime
 
Methods inherited from class org.cip4.jdflib.core.JDFElement
appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, appendGeneralID, appendHRef, appendHRef, appendMustHonorExceptions, appendOperatorInterventionExceptions, appendPreview, appendrRefs, attributeType, clearTargets, cloneNewDoc, copyInto, deprecatedAttributes, eraseDefaultAttributes, exclusiveOneOfAttribute, exclusiveOneOfElement, fixVersion, getAllRefs, getAtrType, getAttributeInfo, getBestEffortExceptions, getChildElement, getChildElements, getChildElementVector_JDFElement, getChildElementVector, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentURL, getCreateComment, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDescriptiveName, getElement_JDFElement, getElement, getElementIDPrefix, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidElements_JDFElement, getJDFRoot, getJMFRoot, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMap, getPartMapVector, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasPartMap, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDirty, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isValid, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, numChildElements, optionalAttributes, prereleaseAttributes, prereleaseElements, refElement, removeBestEffortExceptions, removeChild, removeChild, removeChildren, removeExtensions, removeFromBestEffortExceptions, removeFromMustHonorExceptions, removeFromOperatorInterventionExceptions, removeFromrRefs, removeGeneralID, removePartMap, removeRefElement, removeSettingsPolicy, replaceChild, requiredAttributes, requiredElements, requiredLevel, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNameTimeStamp, setAttributes, setBestEffortExceptions, setCommentURL, setDefaultJDFVersion, setDescriptiveName, setDirty, setEnumerationsAttribute, setGeneralID, setLongID, setMustHonorExceptions, setOperatorInterventionExceptions, setPartMap, setPartMapVector, setSettingsPolicy, setStatus, setVersion, setvStringAttribute, stringToVersion, uniqueElements, upDaterRefs, validAttribute, validAttribute, validEnumAttribute, validEnumerationsAttribute, validResourcePosition, version
 
Methods inherited from class org.cip4.jdflib.core.KElement
addAttribute, addAttribute, addNameSpace, ancestorDistance, appendAttribute, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildXPath, buildXPath, buildXPath, clone, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, fitsName, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttribute, getAttributeMap, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenFromList, getChildrenWithAttribute, getCreateElement_KElement, getCreateElement, getCreateElement, getCreateXPathElement, getDeepElement, getDeepParent, getDeepParent, getDeepParentChild, getDeepParentNotName, getDocRoot, getDOMAttr, getElement_KElement, getElement, getElementByClass, getElementHashMap, getElementsByTagName_KElement, getFirstChildElement, getFirstChildElement, getFirstChildElement, getFirstElementNode, getInheritedAttribute, getInheritedElement, getInheritedXPathAttribute, getIntAttribute, getLocalNameStatic, getLongAttribute, getMultipleIDs, getNamespaceURI, getNamespaceURIFromPrefix, getNextElementNode, getNextSiblingElement, getNextSiblingElement, getNextSiblingElement, getNumCDatas, getNumChildNodes, getNumChildText, getNumXMLComments, getOwnerDocument_KElement, getParentNode_KElement, getPreviousSiblingElement, getPreviousSiblingElement, getRealAttribute, getTarget_KElement, getText, getText, getTree, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasXPathNode, includesAttribute, includesAttributes, insertAt, insertBefore, isAncestor, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numSiblingElements, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildText, removeExtensions, removeFromAttribute, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameElement, replaceElement, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setAttributeNSRaw, setAttributeRaw, setAttributes, setAttributes, setAttributes, setAttributesRaw, setBoolAttribute, setDirty, setIntAttribute, setNamespaceURI, setNodeValue, setPrefix, setRealAttribute, setText, setvStringAttribute, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, toDisplayXML, toXML, toXML, uniqueID, write2File, write2File, write2Stream, xmlNameSpace, xmlnsLocalName, xmlnsPrefix
 
Methods inherited from class org.apache.xerces.dom.ElementNSImpl
getBaseURI, getLocalName, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setType, setValues
 
Methods inherited from class org.apache.xerces.dom.ElementImpl
cloneNode, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttributeNS, isEqualNode, reconcileDefaultAttributes, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData
 
Methods inherited from class org.apache.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren
 
Methods inherited from class org.apache.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
 
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setUserData, setUserData
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Element
getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
Methods inherited from interface org.w3c.dom.Node
cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setTextContent, setUserData
 

Constructor Detail

JDFResponse

public JDFResponse(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                   String qualifiedName)
Constructor for JDFResponse

Parameters:
myOwnerDocument -
qualifiedName -

JDFResponse

public JDFResponse(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                   String myNamespaceURI,
                   String qualifiedName)
Constructor for JDFResponse

Parameters:
myOwnerDocument -
myNamespaceURI -
qualifiedName -

JDFResponse

public JDFResponse(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                   String myNamespaceURI,
                   String qualifiedName,
                   String myLocalName)
Constructor for JDFResponse

Parameters:
myOwnerDocument -
myNamespaceURI -
qualifiedName -
myLocalName -
Method Detail

toString

public String toString()
toString

Overrides:
toString in class JDFAutoResponse
Returns:
String
See Also:
Object.toString()

setErrorText

@Deprecated
public JDFNotification setErrorText(String errorText)
Deprecated. use public JDFNotification setErrorText(String errorText, EnumClass errorClass)

Set ErrorText, (Notification/Comment/#text) also sets Notification/@Type=Error and Notification/@Class=Error doesn't create a notification if ErroerText=null

Parameters:
errorText - new error text
Returns:
JDFNotification the newly created Notification element

setErrorText

public JDFNotification setErrorText(String errorText,
                                    JDFAutoNotification.EnumClass errorClass)
Set ErrorText, (Notification/Comment/#text) also sets Notification/@Type=Error and Notification/@Class=Error doesn't create a notification if ErroerText=null

Parameters:
errorText - new error text
errorClass - the error class
Returns:
JDFNotification the newly created Notification element

splitAcknowledge

public JDFAcknowledge splitAcknowledge()
create an acknowledge JMF and set this to a pure acknowledge response

Returns:
an Acknowledge element that corresponds to this


Copyright © 2013. All Rights Reserved.