Package org.oasis_open.docs.ebxml_bp.ebbp_signals_2

Class SignalIdentificationInformation

  • Direct Known Subclasses:
    AcceptanceAcknowledgement, Exception, ReceiptAcknowledgement
    public class SignalIdentificationInformation
extends Object
    This defines the content structure for identiying various parameters pertaining to the business signal. "OriginalMessageIdentifier" captures the value of the transport message identifier for original message to which this business signal is being sent. If business message has an identifier, that can be captured by the "OriginalDocumentIdentifier" attribute. "OriginalMessageDateTime" is the time when the original message was sent. "ThisMessageDateTime" is the time when this signal message is being sent. The following optional elements are there to provide access to information that can be used by processing logic outside the business process engine. One example of this could be a monitoring application which can use this information to provide status of a collaboration. "FromPartyInfo" describes the party id that is sending the signal message. "ToPartyInfo" describes the party id that is being sent the signal message. The roles described below are based on the implicit relationship between the partner sending the signal message and the partner who sent the original message to which this particular signal is being sent. The role relationship between partner sending the business message and the partner receiving it is captured in the process definition (ebBP). "FromRole" captures the role being played by the party that is sending the signal message. "ToRole" captures the role played by the party that is being sent the signal message. "ProcessSpecificationInfo" type descibes the process information (ebBP) which defines the runtime collaborations for which this signal is being sent "CollaborationIdentifier" is the unique identifer that associates the signal with a particular collaboration. This could come from the business message itself or in case of ebXML MSH, could be the messaging level header "ConversationId" "BusinessActivityIdentifier" identifies the business Requesting or Responding activity to which this signal is being sent. This would identify the "BusinessAction" from the process definition (ebBP) and could be implemented using the "name" attribute on either the RequestingBusinessActivity or the RespondingBusinessActivity.

    Java class for SignalIdentificationInformation complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="SignalIdentificationInformation">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="OriginalMessageIdentifier" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}non-empty-string"/>
         <element name="OriginalDocumentIdentifier" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}non-empty-string" minOccurs="0"/>
         <element name="OriginalMessageDateTime" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element name="ThisMessageDateTime" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element name="FromPartyInfo" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}PartyInfoType" minOccurs="0"/>
         <element name="ToPartyInfo" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}PartyInfoType" minOccurs="0"/>
         <element name="FromRole" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}RoleType" minOccurs="0"/>
         <element name="ToRole" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}RoleType" minOccurs="0"/>
         <element name="ProcessSpecificationInfo" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}ProcessSpecificationInfoType" minOccurs="0"/>
         <element name="CollaborationIdentifier" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}non-empty-string" minOccurs="0"/>
         <element name="BusinessActivityIdentifier" type="{http://docs.oasis-open.org/ebxml-bp/ebbp-signals-2.0}non-empty-string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

    • Constructor Detail

      • SignalIdentificationInformation

        public SignalIdentificationInformation()

    • Method Detail

      • getOriginalMessageIdentifier

        public String getOriginalMessageIdentifier()
        Gets the value of the originalMessageIdentifier property.
        Returns:
        possible object is String

      • setOriginalMessageIdentifier

        public void setOriginalMessageIdentifier​(String value)
        Sets the value of the originalMessageIdentifier property.
        Parameters:
        value - allowed object is String

      • getOriginalDocumentIdentifier

        public String getOriginalDocumentIdentifier()
        Gets the value of the originalDocumentIdentifier property.
        Returns:
        possible object is String

      • setOriginalDocumentIdentifier

        public void setOriginalDocumentIdentifier​(String value)
        Sets the value of the originalDocumentIdentifier property.
        Parameters:
        value - allowed object is String

      • setOriginalMessageDateTime

        public void setOriginalMessageDateTime​(XMLGregorianCalendar value)
        Sets the value of the originalMessageDateTime property.
        Parameters:
        value - allowed object is XMLGregorianCalendar

      • setThisMessageDateTime

        public void setThisMessageDateTime​(XMLGregorianCalendar value)
        Sets the value of the thisMessageDateTime property.
        Parameters:
        value - allowed object is XMLGregorianCalendar

      • getFromPartyInfo

        public PartyInfoType getFromPartyInfo()
        Gets the value of the fromPartyInfo property.
        Returns:
        possible object is PartyInfoType

      • setFromPartyInfo

        public void setFromPartyInfo​(PartyInfoType value)
        Sets the value of the fromPartyInfo property.
        Parameters:
        value - allowed object is PartyInfoType

      • getToPartyInfo

        public PartyInfoType getToPartyInfo()
        Gets the value of the toPartyInfo property.
        Returns:
        possible object is PartyInfoType

      • setToPartyInfo

        public void setToPartyInfo​(PartyInfoType value)
        Sets the value of the toPartyInfo property.
        Parameters:
        value - allowed object is PartyInfoType

      • getFromRole

        public RoleType getFromRole()
        Gets the value of the fromRole property.
        Returns:
        possible object is RoleType

      • setFromRole

        public void setFromRole​(RoleType value)
        Sets the value of the fromRole property.
        Parameters:
        value - allowed object is RoleType

      • getToRole

        public RoleType getToRole()
        Gets the value of the toRole property.
        Returns:
        possible object is RoleType

      • setToRole

        public void setToRole​(RoleType value)
        Sets the value of the toRole property.
        Parameters:
        value - allowed object is RoleType

      • getCollaborationIdentifier

        public String getCollaborationIdentifier()
        Gets the value of the collaborationIdentifier property.
        Returns:
        possible object is String

      • setCollaborationIdentifier

        public void setCollaborationIdentifier​(String value)
        Sets the value of the collaborationIdentifier property.
        Parameters:
        value - allowed object is String

      • getBusinessActivityIdentifier

        public String getBusinessActivityIdentifier()
        Gets the value of the businessActivityIdentifier property.
        Returns:
        possible object is String

      • setBusinessActivityIdentifier

        public void setBusinessActivityIdentifier​(String value)
        Sets the value of the businessActivityIdentifier property.
        Parameters:
        value - allowed object is String