org.oasis_open.docs.ebxml_bp.ebbp_signals_2

Class SignalIdentificationInformation

java.lang.Object

org.oasis_open.docs.ebxml_bp.ebbp_signals_2.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>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignalIdentificationInformation.Builder<_B>
static class	SignalIdentificationInformation.Select
static class	SignalIdentificationInformation.Selector<TRoot extends com.kscs.util.jaxb.Selector<TRoot,?>,TParent>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	businessActivityIdentifier
protected String	collaborationIdentifier
protected PartyInfoType	fromPartyInfo
protected RoleType	fromRole
protected String	originalDocumentIdentifier
protected XMLGregorianCalendar	originalMessageDateTime
protected String	originalMessageIdentifier
protected ProcessSpecificationInfoType	processSpecificationInfo
protected XMLGregorianCalendar	thisMessageDateTime
protected PartyInfoType	toPartyInfo
protected RoleType	toRole

Constructor Summary

Constructors

Constructor and Description
SignalIdentificationInformation()

Method Summary

Modifier and Type	Method and Description
static SignalIdentificationInformation.Builder<Void>	builder()
static SignalIdentificationInformation.Builder<Void>	copyExcept(SignalIdentificationInformation _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> SignalIdentificationInformation.Builder<_B>	copyOf(SignalIdentificationInformation _other)
static <_B> SignalIdentificationInformation.Builder<_B>	copyOf(SignalIdentificationInformation _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static SignalIdentificationInformation.Builder<Void>	copyOnly(SignalIdentificationInformation _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(SignalIdentificationInformation.Builder<_B> _other) Copies all state of this object to a builder.
<_B> void	copyTo(SignalIdentificationInformation.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse) Copies all state of this object to a builder.
String	getBusinessActivityIdentifier() Gets the value of the businessActivityIdentifier property.
String	getCollaborationIdentifier() Gets the value of the collaborationIdentifier property.
PartyInfoType	getFromPartyInfo() Gets the value of the fromPartyInfo property.
RoleType	getFromRole() Gets the value of the fromRole property.
String	getOriginalDocumentIdentifier() Gets the value of the originalDocumentIdentifier property.
XMLGregorianCalendar	getOriginalMessageDateTime() Gets the value of the originalMessageDateTime property.
String	getOriginalMessageIdentifier() Gets the value of the originalMessageIdentifier property.
ProcessSpecificationInfoType	getProcessSpecificationInfo() Gets the value of the processSpecificationInfo property.
XMLGregorianCalendar	getThisMessageDateTime() Gets the value of the thisMessageDateTime property.
PartyInfoType	getToPartyInfo() Gets the value of the toPartyInfo property.
RoleType	getToRole() Gets the value of the toRole property.
<_B> SignalIdentificationInformation.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> SignalIdentificationInformation.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
SignalIdentificationInformation.Builder<Void>	newCopyBuilder()
SignalIdentificationInformation.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setBusinessActivityIdentifier(String value) Sets the value of the businessActivityIdentifier property.
void	setCollaborationIdentifier(String value) Sets the value of the collaborationIdentifier property.
void	setFromPartyInfo(PartyInfoType value) Sets the value of the fromPartyInfo property.
void	setFromRole(RoleType value) Sets the value of the fromRole property.
void	setOriginalDocumentIdentifier(String value) Sets the value of the originalDocumentIdentifier property.
void	setOriginalMessageDateTime(XMLGregorianCalendar value) Sets the value of the originalMessageDateTime property.
void	setOriginalMessageIdentifier(String value) Sets the value of the originalMessageIdentifier property.
void	setProcessSpecificationInfo(ProcessSpecificationInfoType value) Sets the value of the processSpecificationInfo property.
void	setThisMessageDateTime(XMLGregorianCalendar value) Sets the value of the thisMessageDateTime property.
void	setToPartyInfo(PartyInfoType value) Sets the value of the toPartyInfo property.
void	setToRole(RoleType value) Sets the value of the toRole property.

Methods inherited from class java.lang.Object

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

Field Detail

originalMessageIdentifier

protected String originalMessageIdentifier

originalDocumentIdentifier

protected String originalDocumentIdentifier

originalMessageDateTime

protected XMLGregorianCalendar originalMessageDateTime

thisMessageDateTime

protected XMLGregorianCalendar thisMessageDateTime

fromPartyInfo

protected PartyInfoType fromPartyInfo

toPartyInfo

protected PartyInfoType toPartyInfo

fromRole

protected RoleType fromRole

toRole

protected RoleType toRole

processSpecificationInfo

protected ProcessSpecificationInfoType processSpecificationInfo

collaborationIdentifier

protected String collaborationIdentifier

businessActivityIdentifier

protected String businessActivityIdentifier

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

getOriginalMessageDateTime

public XMLGregorianCalendar getOriginalMessageDateTime()

Gets the value of the originalMessageDateTime property.

Returns:

possible object is XMLGregorianCalendar

setOriginalMessageDateTime

public void setOriginalMessageDateTime(XMLGregorianCalendar value)

Sets the value of the originalMessageDateTime property.

Parameters:

value - allowed object is XMLGregorianCalendar

getThisMessageDateTime

public XMLGregorianCalendar getThisMessageDateTime()

Gets the value of the thisMessageDateTime property.

Returns:

possible 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

getProcessSpecificationInfo

public ProcessSpecificationInfoType getProcessSpecificationInfo()

Gets the value of the processSpecificationInfo property.

Returns:

possible object is ProcessSpecificationInfoType

setProcessSpecificationInfo

public void setProcessSpecificationInfo(ProcessSpecificationInfoType value)

Sets the value of the processSpecificationInfo property.

Parameters:

value - allowed object is ProcessSpecificationInfoType

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

copyTo

public <_B> void copyTo(SignalIdentificationInformation.Builder<_B> _other)

Copies all state of this object to a builder. This method is used by the copyOf(org.oasis_open.docs.ebxml_bp.ebbp_signals_2.SignalIdentificationInformation) method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

public <_B> SignalIdentificationInformation.Builder<_B> newCopyBuilder(_B _parentBuilder)

newCopyBuilder

public SignalIdentificationInformation.Builder<Void> newCopyBuilder()

builder

public static SignalIdentificationInformation.Builder<Void> builder()

copyOf

public static <_B> SignalIdentificationInformation.Builder<_B> copyOf(SignalIdentificationInformation _other)

copyTo

public <_B> void copyTo(SignalIdentificationInformation.Builder<_B> _other,
                        com.kscs.util.jaxb.PropertyTree _propertyTree,
                        com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Copies all state of this object to a builder. This method is used by the copyOf(org.oasis_open.docs.ebxml_bp.ebbp_signals_2.SignalIdentificationInformation) method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

public <_B> SignalIdentificationInformation.Builder<_B> newCopyBuilder(_B _parentBuilder,
                                                                       com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                                       com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

newCopyBuilder

public SignalIdentificationInformation.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                                    com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyOf

public static <_B> SignalIdentificationInformation.Builder<_B> copyOf(SignalIdentificationInformation _other,
                                                                      com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                                      com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyExcept

public static SignalIdentificationInformation.Builder<Void> copyExcept(SignalIdentificationInformation _other,
                                                                       com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

public static SignalIdentificationInformation.Builder<Void> copyOnly(SignalIdentificationInformation _other,
                                                                     com.kscs.util.jaxb.PropertyTree _propertyTree)