Package com.helger.phase4.ebms3header

Class EbbpSigSignalIdentificationInformation

java.lang.Object
com.helger.phase4.ebms3header.EbbpSigSignalIdentificationInformation
All Implemented Interfaces:
com.helger.base.lang.IExplicitlyCloneable, Serializable, Cloneable
Direct Known Subclasses:
AcceptanceAcknowledgement, Exception, ReceiptAcknowledgement
@CodingStyleguideUnaware public class EbbpSigSignalIdentificationInformation extends Object implements Serializable, com.helger.base.lang.IExplicitlyCloneable
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>

This class was annotated by ph-jaxb-plugin -Xph-annotate

This class contains methods created by ph-jaxb-plugin -Xph-equalshashcode

This class contains methods created by ph-jaxb-plugin -Xph-tostring

This class contains methods created by ph-jaxb-plugin -Xph-cloneable2

This class contains methods created by ph-jaxb-plugin -Xph-value-extender

This class contains methods created by ph-jaxb-plugin -Xph-offset-dt-extension

See Also:

  • Constructor Details

    • EbbpSigSignalIdentificationInformation

      public EbbpSigSignalIdentificationInformation()
      Default constructor
      Note: automatically created by ph-jaxb-plugin -Xph-value-extender

  • Method Details

    • getOriginalMessageIdentifier

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

    • setOriginalMessageIdentifier

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

    • getOriginalDocumentIdentifier

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

    • setOriginalDocumentIdentifier

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

    • getOriginalMessageDateTime

      public @Nullable com.helger.datetime.xml.XMLOffsetDateTime getOriginalMessageDateTime()
      Gets the value of the originalMessageDateTime property.
      Returns:
      possible object is String

    • setOriginalMessageDateTime

      public void setOriginalMessageDateTime(@Nullable com.helger.datetime.xml.XMLOffsetDateTime value)
      Sets the value of the originalMessageDateTime property.
      Parameters:
      value - allowed object is String

    • getThisMessageDateTime

      public @Nullable com.helger.datetime.xml.XMLOffsetDateTime getThisMessageDateTime()
      Gets the value of the thisMessageDateTime property.
      Returns:
      possible object is String

    • setThisMessageDateTime

      public void setThisMessageDateTime(@Nullable com.helger.datetime.xml.XMLOffsetDateTime value)
      Sets the value of the thisMessageDateTime property.
      Parameters:
      value - allowed object is String

    • getFromPartyInfo

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

    • setFromPartyInfo

      public void setFromPartyInfo(@Nullable EbbpSigPartyInfoType value)
      Sets the value of the fromPartyInfo property.
      Parameters:
      value - allowed object is EbbpSigPartyInfoType

    • getToPartyInfo

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

    • setToPartyInfo

      public void setToPartyInfo(@Nullable EbbpSigPartyInfoType value)
      Sets the value of the toPartyInfo property.
      Parameters:
      value - allowed object is EbbpSigPartyInfoType

    • getFromRole

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

    • setFromRole

      public void setFromRole(@Nullable EbbpSigRoleType value)
      Sets the value of the fromRole property.
      Parameters:
      value - allowed object is EbbpSigRoleType

    • getToRole

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

    • setToRole

      public void setToRole(@Nullable EbbpSigRoleType value)
      Sets the value of the toRole property.
      Parameters:
      value - allowed object is EbbpSigRoleType

    • getProcessSpecificationInfo

      public @Nullable EbbpSigProcessSpecificationInfoType getProcessSpecificationInfo()
      Gets the value of the processSpecificationInfo property.
      Returns:
      possible object is EbbpSigProcessSpecificationInfoType

    • setProcessSpecificationInfo

      public void setProcessSpecificationInfo(@Nullable EbbpSigProcessSpecificationInfoType value)
      Sets the value of the processSpecificationInfo property.
      Parameters:
      value - allowed object is EbbpSigProcessSpecificationInfoType

    • getCollaborationIdentifier

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

    • setCollaborationIdentifier

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

    • getBusinessActivityIdentifier

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

    • setBusinessActivityIdentifier

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

    • equals

      public boolean equals(Object o)
      Created by ph-jaxb-plugin -Xph-equalshashcode
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Created by ph-jaxb-plugin -Xph-equalshashcode
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Created by ph-jaxb-plugin -Xph-tostring
      Overrides:
      toString in class Object

    • cloneTo

      public void cloneTo(EbbpSigSignalIdentificationInformation ret)
      This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb-plugin -Xph-cloneable2
      Parameters:
      ret - The target object to clone to. May not be null.

    • clone

      @ReturnsMutableCopy public EbbpSigSignalIdentificationInformation clone()
      Created by ph-jaxb-plugin -Xph-cloneable2
      Specified by:
      clone in interface com.helger.base.lang.IExplicitlyCloneable
      Overrides:
      clone in class Object
      Returns:
      The cloned object. Never null.

    • setFromPartyInfo

      public @NonNull EbbpSigPartyInfoType setFromPartyInfo(@Nullable String valueParam)
      Special setter with value of type String
      Note: automatically created by ph-jaxb-plugin -Xph-value-extender
      Parameters:
      valueParam - The value to be set. May be null.
      Returns:
      The created intermediary object of type EbbpSigPartyInfoType and never null

    • setToPartyInfo

      public @NonNull EbbpSigPartyInfoType setToPartyInfo(@Nullable String valueParam)
      Special setter with value of type String
      Note: automatically created by ph-jaxb-plugin -Xph-value-extender
      Parameters:
      valueParam - The value to be set. May be null.
      Returns:
      The created intermediary object of type EbbpSigPartyInfoType and never null

    • getFromPartyInfoValue

      public @Nullable String getFromPartyInfoValue()
      Get the value of the contained EbbpSigPartyInfoType object
      Note: automatically created by ph-jaxb-plugin -Xph-value-extender
      Returns:
      Either the value of the contained EbbpSigPartyInfoType object or null

    • getToPartyInfoValue

      public @Nullable String getToPartyInfoValue()
      Get the value of the contained EbbpSigPartyInfoType object
      Note: automatically created by ph-jaxb-plugin -Xph-value-extender
      Returns:
      Either the value of the contained EbbpSigPartyInfoType object or null

    • getOriginalMessageDateTimeLocal

      public @Nullable LocalDateTime getOriginalMessageDateTimeLocal()
      Created by ph-jaxb-plugin -Xph-offset-dt-extension
      Returns:
      The LocalDateTime representation of originalMessageDateTime. May be null.

    • setOriginalMessageDateTime

      public void setOriginalMessageDateTime(@Nullable LocalDateTime aValue)
      Created by ph-jaxb-plugin -Xph-offset-dt-extension
      Parameters:
      aValue - The LocalDateTime to set. May be null.

    • getThisMessageDateTimeLocal

      public @Nullable LocalDateTime getThisMessageDateTimeLocal()
      Created by ph-jaxb-plugin -Xph-offset-dt-extension
      Returns:
      The LocalDateTime representation of thisMessageDateTime. May be null.

    • setThisMessageDateTime

      public void setThisMessageDateTime(@Nullable LocalDateTime aValue)
      Created by ph-jaxb-plugin -Xph-offset-dt-extension
      Parameters:
      aValue - The LocalDateTime to set. May be null.