ConversationMessage (Utilities Conversation 0.3 API)

java.lang.Object
- won.protocol.agreement.ConversationMessage

All Implemented Interfaces:: java.lang.Comparable<ConversationMessage>

public class ConversationMessage
extends java.lang.Object
implements java.lang.Comparable<ConversationMessage>

Author:: fkleedorfer

Constructor Summary

Constructors
Constructor and Description

ConversationMessage(java.net.URI messageURI)

Constructors
Constructor and Description
`ConversationMessage(java.net.URI messageURI)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accepts(ConversationMessage other)`
`void`	`addAccepts(java.net.URI accepts)`
`void`	`addAcceptsInverseRef(ConversationMessage ref)`
`void`	`addAcceptsRef(ConversationMessage ref)`
`void`	`addContentGraph(java.net.URI contentGraph)`
`void`	`addPrevious(java.net.URI previous)`
`void`	`addPreviousInverseRef(ConversationMessage ref)`
`void`	`addPreviousRef(ConversationMessage ref)`
`void`	`addProposes(java.net.URI proposes)`
`void`	`addProposesInverseRef(ConversationMessage ref)`
`void`	`addProposesRef(ConversationMessage ref)`
`void`	`addProposesToCancel(java.net.URI proposesToCancel)`
`void`	`addProposesToCancelInverseRef(ConversationMessage ref)`
`void`	`addProposesToCancelRef(ConversationMessage ref)`
`void`	`addRejects(java.net.URI rejects)`
`void`	`addRejectsInverseRef(ConversationMessage ref)`
`void`	`addRejectsRef(ConversationMessage ref)`
`void`	`addRetracts(java.net.URI retracts)`
`void`	`addRetractsInverseRef(ConversationMessage ref)`
`void`	`addRetractsRef(ConversationMessage ref)`
`int`	`compareTo(ConversationMessage other)` Compares messages for sorting them temporally, using the URI as tie breaker so as to ensure a stable ordering.
`boolean`	`equals(java.lang.Object obj)`
`java.util.Set<java.net.URI>`	`getAccepts()`
`java.util.Set<ConversationMessage>`	`getAcceptsInverseRefs()`
`java.util.Set<ConversationMessage>`	`getAcceptsRefs()`
`java.util.Set<java.net.URI>`	`getContentGraphs()`
`ConversationMessage`	`getCorrespondingRemoteMessageRef()`
`java.net.URI`	`getCorrespondingRemoteMessageURI()`
`DeliveryChain`	`getDeliveryChain()`
`WonMessageDirection`	`getDirection()`
`java.util.Set<MessageEffect>`	`getEffects()`
`java.net.URI`	`getIsRemoteResponseTo()`
`ConversationMessage`	`getIsRemoteResponseToInverseRef()`
`ConversationMessage`	`getIsRemoteResponseToRef()`
`java.net.URI`	`getIsResponseTo()`
`ConversationMessage`	`getIsResponseToInverseRef()`
`ConversationMessage`	`getIsResponseToRef()`
`WonMessageType`	`getMessageType()`
`java.net.URI`	`getMessageURI()`
`int`	`getOrder()`
`org.apache.thrift.Option<ConversationMessage>`	`getOwnConversationRoot()`
`java.util.Set<java.net.URI>`	`getPrevious()`
`java.util.Set<ConversationMessage>`	`getPreviousInverseRefs()`
`java.util.Set<ConversationMessage>`	`getPreviousRefs()`
`java.util.Set<java.net.URI>`	`getProposes()`
`java.util.Set<ConversationMessage>`	`getProposesInverseRefs()`
`java.util.Set<ConversationMessage>`	`getProposesRefs()`
`java.util.Set<java.net.URI>`	`getProposesToCancel()`
`java.util.Set<ConversationMessage>`	`getProposesToCancelInverseRefs()`
`java.util.Set<ConversationMessage>`	`getProposesToCancelRefs()`
`java.util.Set<ConversationMessage>`	`getReachableConversationRoots()`
`java.util.Set<java.net.URI>`	`getRejects()`
`java.util.Set<ConversationMessage>`	`getRejectsInverseRefs()`
`java.util.Set<ConversationMessage>`	`getRejectsRefs()`
`java.util.Set<java.net.URI>`	`getRetracts()`
`java.util.Set<ConversationMessage>`	`getRetractsInverseRefs()`
`java.util.Set<ConversationMessage>`	`getRetractsRefs()`
`ConversationMessage`	`getRootOfDeliveryChain()`
`java.net.URI`	`getSenderNeedURI()`
`boolean`	`hasCorrespondingRemoteMessage()`
`int`	`hashCode()`
`boolean`	`hasPreviousMessage()`
`boolean`	`hasRemoteResponse()`
`boolean`	`hasRemoteResponse(ConversationMessage other)`
`boolean`	`hasRemoteSuccessResponse()`
`boolean`	`hasResponse()`
`boolean`	`hasResponse(ConversationMessage other)`
`boolean`	`hasSubsequentMessage()`
`boolean`	`hasSuccessResponse()`
`boolean`	`isAcceptsMessage()`
`boolean`	`isAcknowledgedLocally()`
`boolean`	`isAcknowledgedRemotely()`
`boolean`	`isAgreementProtocolMessage()`
`boolean`	`isCorrespondingRemoteMessageOf(ConversationMessage other)`
`boolean`	`isEndOfDeliveryChain()`
`boolean`	`isFromExternal()`
`boolean`	`isFromOwner()`
`boolean`	`isFromSystem()`
`boolean`	`isHeadOfDeliveryChain()`
`boolean`	`isInSameDeliveryChain(ConversationMessage other)`
`boolean`	`isMessageOnPathToRoot(ConversationMessage other)`
`boolean`	`isProposesMessage()`
`boolean`	`isProposesToCancelMessage()`
`boolean`	`isRejectsMessage()`
`boolean`	`isRemoteResponseTo(ConversationMessage other)`
`boolean`	`isResponse()`
`boolean`	`isResponseTo(ConversationMessage other)`
`boolean`	`isRetractsMessage()`
`boolean`	`partOfSameExchange(ConversationMessage other)`
`boolean`	`proposes(ConversationMessage other)`
`boolean`	`proposesToCancel(ConversationMessage other)`
`boolean`	`rejects(ConversationMessage other)`
`void`	`removeHighlevelProtocolProperties()` Removes all proposes, rejects, accepts, proposesToCancel, contentGraphs
`boolean`	`retracts(ConversationMessage other)`
`void`	`setCorrespondingRemoteMessageRef(ConversationMessage ref)`
`void`	`setCorrespondingRemoteMessageURI(java.net.URI correspondingRemoteMessageURI)`
`void`	`setDirection(WonMessageDirection direction)`
`void`	`setEffects(java.util.Set<MessageEffect> effects)`
`void`	`setIsRemoteResponseTo(java.net.URI isRemoteResponseTo)`
`void`	`setIsRemoteResponseToInverseRef(ConversationMessage ref)`
`void`	`setIsRemoteResponseToRef(ConversationMessage ref)`
`void`	`setIsResponseTo(java.net.URI isResponseTo)`
`void`	`setIsResponseToInverseRef(ConversationMessage ref)`
`void`	`setIsResponseToRef(ConversationMessage ref)`
`void`	`setMessageType(WonMessageType messageType)`
`void`	`setSenderNeedURI(java.net.URI senderNeedURI)`
`boolean`	`sharesReachableRootsWith(ConversationMessage other)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConversationMessage

public ConversationMessage(java.net.URI messageURI)

Method Detail

removeHighlevelProtocolProperties
```
public void removeHighlevelProtocolProperties()
```
Removes all proposes, rejects, accepts, proposesToCancel, contentGraphs

getRootOfDeliveryChain

public ConversationMessage getRootOfDeliveryChain()

isHeadOfDeliveryChain

public boolean isHeadOfDeliveryChain()

isEndOfDeliveryChain
```
public boolean isEndOfDeliveryChain()
```

isInSameDeliveryChain

public boolean isInSameDeliveryChain(ConversationMessage other)

getDeliveryChain

public DeliveryChain getDeliveryChain()

isResponse
```
public boolean isResponse()
```

hasResponse
```
public boolean hasResponse()
```

hasRemoteResponse
```
public boolean hasRemoteResponse()
```

hasSuccessResponse
```
public boolean hasSuccessResponse()
```

hasRemoteSuccessResponse

public boolean hasRemoteSuccessResponse()

isAcknowledgedRemotely

public boolean isAcknowledgedRemotely()

hasPreviousMessage
```
public boolean hasPreviousMessage()
```

hasSubsequentMessage
```
public boolean hasSubsequentMessage()
```

isCorrespondingRemoteMessageOf

public boolean isCorrespondingRemoteMessageOf(ConversationMessage other)

isResponseTo

public boolean isResponseTo(ConversationMessage other)

hasResponse

public boolean hasResponse(ConversationMessage other)

isRemoteResponseTo

public boolean isRemoteResponseTo(ConversationMessage other)

hasRemoteResponse

public boolean hasRemoteResponse(ConversationMessage other)

partOfSameExchange

public boolean partOfSameExchange(ConversationMessage other)

compareTo
```
public int compareTo(ConversationMessage other)
```
Compares messages for sorting them temporally, using the URI as tie breaker so as to ensure a stable ordering.

Specified by:

compareTo in interface java.lang.Comparable<ConversationMessage>

Parameters:

other -

Returns:

getOrder
```
public int getOrder()
```

getOwnConversationRoot

public org.apache.thrift.Option<ConversationMessage> getOwnConversationRoot()

getReachableConversationRoots

public java.util.Set<ConversationMessage> getReachableConversationRoots()

sharesReachableRootsWith

public boolean sharesReachableRootsWith(ConversationMessage other)

isMessageOnPathToRoot

public boolean isMessageOnPathToRoot(ConversationMessage other)

isAgreementProtocolMessage

public boolean isAgreementProtocolMessage()

isFromOwner
```
public boolean isFromOwner()
```

isFromExternal
```
public boolean isFromExternal()
```

isFromSystem
```
public boolean isFromSystem()
```

isAcknowledgedLocally

public boolean isAcknowledgedLocally()

isRetractsMessage
```
public boolean isRetractsMessage()
```

isAcceptsMessage
```
public boolean isAcceptsMessage()
```

isProposesMessage
```
public boolean isProposesMessage()
```

isRejectsMessage
```
public boolean isRejectsMessage()
```

isProposesToCancelMessage

public boolean isProposesToCancelMessage()

proposes

public boolean proposes(ConversationMessage other)

accepts

public boolean accepts(ConversationMessage other)

proposesToCancel

public boolean proposesToCancel(ConversationMessage other)

retracts

public boolean retracts(ConversationMessage other)

rejects

public boolean rejects(ConversationMessage other)

getMessageURI
```
public java.net.URI getMessageURI()
```

getSenderNeedURI

public java.net.URI getSenderNeedURI()

setSenderNeedURI

public void setSenderNeedURI(java.net.URI senderNeedURI)

getProposes

public java.util.Set<java.net.URI> getProposes()

getRejects

public java.util.Set<java.net.URI> getRejects()

getProposesRefs

public java.util.Set<ConversationMessage> getProposesRefs()

addProposes

public void addProposes(java.net.URI proposes)

addProposesRef

public void addProposesRef(ConversationMessage ref)

getRejectsRefs

public java.util.Set<ConversationMessage> getRejectsRefs()

addRejects

public void addRejects(java.net.URI rejects)

addRejectsRef

public void addRejectsRef(ConversationMessage ref)

getPrevious

public java.util.Set<java.net.URI> getPrevious()

getPreviousRefs

public java.util.Set<ConversationMessage> getPreviousRefs()

addPrevious

public void addPrevious(java.net.URI previous)

addPreviousRef

public void addPreviousRef(ConversationMessage ref)

getAccepts

public java.util.Set<java.net.URI> getAccepts()

getAcceptsRefs

public java.util.Set<ConversationMessage> getAcceptsRefs()

addAcceptsRef

public void addAcceptsRef(ConversationMessage ref)

addAccepts

public void addAccepts(java.net.URI accepts)

getRetracts

public java.util.Set<java.net.URI> getRetracts()

getRetractsRefs

public java.util.Set<ConversationMessage> getRetractsRefs()

addRetractsRef

public void addRetractsRef(ConversationMessage ref)

addRetracts

public void addRetracts(java.net.URI retracts)

getProposesToCancel

public java.util.Set<java.net.URI> getProposesToCancel()

getProposesToCancelRefs

public java.util.Set<ConversationMessage> getProposesToCancelRefs()

addProposesToCancelRef

public void addProposesToCancelRef(ConversationMessage ref)

addProposesToCancel

public void addProposesToCancel(java.net.URI proposesToCancel)

getCorrespondingRemoteMessageURI

public java.net.URI getCorrespondingRemoteMessageURI()

getCorrespondingRemoteMessageRef

public ConversationMessage getCorrespondingRemoteMessageRef()

hasCorrespondingRemoteMessage

public boolean hasCorrespondingRemoteMessage()

setCorrespondingRemoteMessageURI

public void setCorrespondingRemoteMessageURI(java.net.URI correspondingRemoteMessageURI)

setCorrespondingRemoteMessageRef

public void setCorrespondingRemoteMessageRef(ConversationMessage ref)

getIsResponseTo
```
public java.net.URI getIsResponseTo()
```

setIsResponseTo

public void setIsResponseTo(java.net.URI isResponseTo)

getIsResponseToRef

public ConversationMessage getIsResponseToRef()

setIsResponseToRef

public void setIsResponseToRef(ConversationMessage ref)

getIsRemoteResponseTo

public java.net.URI getIsRemoteResponseTo()

setIsRemoteResponseTo

public void setIsRemoteResponseTo(java.net.URI isRemoteResponseTo)

getIsRemoteResponseToRef

public ConversationMessage getIsRemoteResponseToRef()

setIsRemoteResponseToRef

public void setIsRemoteResponseToRef(ConversationMessage ref)

getProposesInverseRefs

public java.util.Set<ConversationMessage> getProposesInverseRefs()

addProposesInverseRef

public void addProposesInverseRef(ConversationMessage ref)

getRejectsInverseRefs

public java.util.Set<ConversationMessage> getRejectsInverseRefs()

addRejectsInverseRef

public void addRejectsInverseRef(ConversationMessage ref)

getPreviousInverseRefs

public java.util.Set<ConversationMessage> getPreviousInverseRefs()

addPreviousInverseRef

public void addPreviousInverseRef(ConversationMessage ref)

getAcceptsInverseRefs

public java.util.Set<ConversationMessage> getAcceptsInverseRefs()

addAcceptsInverseRef

public void addAcceptsInverseRef(ConversationMessage ref)

getRetractsInverseRefs

public java.util.Set<ConversationMessage> getRetractsInverseRefs()

addRetractsInverseRef

public void addRetractsInverseRef(ConversationMessage ref)

getIsResponseToInverseRef

public ConversationMessage getIsResponseToInverseRef()

setIsResponseToInverseRef

public void setIsResponseToInverseRef(ConversationMessage ref)

getIsRemoteResponseToInverseRef

public ConversationMessage getIsRemoteResponseToInverseRef()

setIsRemoteResponseToInverseRef

public void setIsRemoteResponseToInverseRef(ConversationMessage ref)

getProposesToCancelInverseRefs

public java.util.Set<ConversationMessage> getProposesToCancelInverseRefs()

addProposesToCancelInverseRef

public void addProposesToCancelInverseRef(ConversationMessage ref)

getContentGraphs

public java.util.Set<java.net.URI> getContentGraphs()

addContentGraph

public void addContentGraph(java.net.URI contentGraph)

getMessageType

public WonMessageType getMessageType()

setMessageType

public void setMessageType(WonMessageType messageType)

getDirection

public WonMessageDirection getDirection()

setDirection

public void setDirection(WonMessageDirection direction)

setEffects

public void setEffects(java.util.Set<MessageEffect> effects)

getEffects

public java.util.Set<MessageEffect> getEffects()

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

Class ConversationMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConversationMessage

Method Detail

removeHighlevelProtocolProperties

getRootOfDeliveryChain

isHeadOfDeliveryChain

isEndOfDeliveryChain

isInSameDeliveryChain

getDeliveryChain

isResponse

hasResponse

hasRemoteResponse

hasSuccessResponse

hasRemoteSuccessResponse

isAcknowledgedRemotely

hasPreviousMessage

hasSubsequentMessage

isCorrespondingRemoteMessageOf

isResponseTo

hasResponse

isRemoteResponseTo

hasRemoteResponse

partOfSameExchange

compareTo

getOrder

getOwnConversationRoot

getReachableConversationRoots

sharesReachableRootsWith

isMessageOnPathToRoot

isAgreementProtocolMessage

isFromOwner

isFromExternal

isFromSystem

isAcknowledgedLocally

isRetractsMessage

isAcceptsMessage

isProposesMessage

isRejectsMessage

isProposesToCancelMessage

proposes

accepts

proposesToCancel

retracts

rejects

getMessageURI

getSenderNeedURI

setSenderNeedURI

getProposes

getRejects

getProposesRefs

addProposes

addProposesRef

getRejectsRefs

addRejects

addRejectsRef

getPrevious

getPreviousRefs

addPrevious

addPreviousRef

getAccepts

getAcceptsRefs

addAcceptsRef

addAccepts

getRetracts

getRetractsRefs

addRetractsRef

addRetracts

getProposesToCancel

getProposesToCancelRefs

addProposesToCancelRef

addProposesToCancel

getCorrespondingRemoteMessageURI

getCorrespondingRemoteMessageRef

hasCorrespondingRemoteMessage

setCorrespondingRemoteMessageURI

setCorrespondingRemoteMessageRef