Order (xuml-tools 0.5 API)

java.lang.Object
- ordertracker.Order

All Implemented Interfaces:: Entity<Order>

@Entity
public class Order
extends Object
implements Entity<Order>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.Attribute`
`static interface`	`Order.Behaviour` On entry procedures for this entity.
`static interface`	`Order.BehaviourFactory` A factory that creates behaviour for a given entity.
`static class`	`Order.Events` Event declarations.
`static class`	`Order.State` The list of all states from the state machine for this entity.

Constructor Summary

Constructors
Constructor and Description

Order()
No argument constructor required by JPA.

Order(String id)
Constructor using id.

Constructors
Constructor and Description
`Order()` No argument constructor required by JPA.
`Order(String id)` Constructor using id.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Order`	`cancelSignal(Event<Order> event)`
`Order`	`cancelSignal(String eventSignatureKey)`
`static Order`	`create(CreationEvent<Order> creationEvent)` Static creator method using CreationEvent.
`static Order`	`create(javax.persistence.EntityManager em, CreationEvent<Order> event)` Static creator method associated with the creation transition to 'Preparing' via event 'Create'.
`static Order`	`create(String id)` Static creator method using id.
`static Order.BehaviourFactory`	`createBehaviourFactory(Class<? extends Order.Behaviour> cls)` Returns a BehaviourFactory on the assumption that the given class has a single constructor with one parameter of type Order.
`Order`	`delete()` Same as this.remove()
`Order`	`event(Event<Order> event)` Synchronously runs the on entry procedure associated with this event and also any signals to self that are made during the procedure.
`static com.google.common.base.Optional<Order>`	`find(String id)`
`Integer`	`getAttempts()` Returns attempts.
`static Order.BehaviourFactory`	`getBehaviourFactory()` Returns the singleton BehaviourFactory for this.
`String`	`getComment()` Returns comment.
`Depot`	`getDepot_R1()` Getter.
`String`	`getDescription()` Returns description.
`String`	`getDestinationEmail()` Returns destinationEmail.
`String`	`getFromAddress()` Returns fromAddress.
`String`	`getId()` Returns the identifier for this entity.
`Integer`	`getMaxAttempts()` Returns maxAttempts.
`String`	`getSenderEmail()` Returns senderEmail.
`String`	`getState()` For internal use only by the state machine but is persisted by the jpa provider.
`String`	`getStatus()` Returns status.
`String`	`getToAddress()` Returns toAddress.
`EntityHelper`	`helper()` Returns the Helper for this instance.
`Order`	`load()`
`Order`	`load(javax.persistence.EntityManager em)` Does a merge then a refresh and returns a new updated merged instance.
`Order`	`merge(javax.persistence.EntityManager em)` Same as EntityManager.merge() except allows method chaining.
`Order`	`persist()` Same as `persist(Context.em())`.
`Order`	`persist(javax.persistence.EntityManager em)` Same as EntityManager.persist() except allows method chaining.
`Order`	`refresh(javax.persistence.EntityManager em)` Same as EntityManager.refresh() except inverted to facilitate method chaining.
`Order`	`relateAcrossR1(Depot depot_R1)` MANY Order was last at ZERO_ONE Depot
`Order`	`remove()` Same as EntityManager.remove() except inverted to facilitate method chaining.
`Order`	`remove(javax.persistence.EntityManager em)` Same as EntityManager.remove() except inverted to facilitate method chaining.
`static SelectBuilder<Order>`	`select()`
`static SelectBuilder<Order>`	`select(BooleanExpression<Order> where)`
`Order`	`setAttempts_(Integer attempts)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setAttempts(Integer attempts)` Sets attempts to the given value.
`static void`	`setBehaviourFactory(Class<? extends Order.Behaviour> cls)` Sets the BehaviourFactory for all instances of this class using the given Behaviour class as the base.
`static void`	`setBehaviourFactory(Order.BehaviourFactory factory)` Sets the BehaviourFactory for all instances of this class.
`Order`	`setComment_(String comment)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setComment(String comment)` Sets comment to the given value.
`void`	`setDepot_R1(Depot depot_R1)` Setter.
`Order`	`setDescription_(String description)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setDescription(String description)` Sets description to the given value.
`Order`	`setDestinationEmail_(String destinationEmail)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setDestinationEmail(String destinationEmail)` Sets destinationEmail to the given value.
`Order`	`setFromAddress_(String fromAddress)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setFromAddress(String fromAddress)` Sets fromAddress to the given value.
`Order`	`setId_(String id)`
`void`	`setId(String id)`
`Order`	`setMaxAttempts_(Integer maxAttempts)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setMaxAttempts(Integer maxAttempts)` Sets maxAttempts to the given value.
`Order`	`setSenderEmail_(String senderEmail)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setSenderEmail(String senderEmail)` Sets senderEmail to the given value.
`void`	`setState(Order.State state)` Sets the current state.
`void`	`setState(String state)` For internal use only by the state machine but is persisted by the jpa provider.
`Order`	`setStatus_(String status)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setStatus(String status)` Sets status to the given value.
`Order`	`setToAddress_(String toAddress)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setToAddress(String toAddress)` Sets toAddress to the given value.
`Order`	`signal(Event<Order> event)` Asychronously queues the given signal against this entity for processing.
`Order`	`signal(Event<Order> event, scala.concurrent.duration.Duration delay)` Asychronously queues the given signal against this entity for processing after the delay specified.
`Order`	`signal(Event<Order> event, long time)` Asychronously queues the given signal against this entity for processing at the epoch time in ms specified.
`String`	`uniqueId()` Returns a unique id for this instance as a String.
`Order`	`unrelateAcrossR1(Depot depot_R1)` MANY Order was last at ZERO_ONE Depot

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

- Constructor Detail
  - Order
```
public Order()
```
    No argument constructor required by JPA.
  - Order
```
public Order(String id)
```
    Constructor using id.
- Method Detail
  - setBehaviourFactory
```
public static void setBehaviourFactory(Order.BehaviourFactory factory)
```
    Sets the BehaviourFactory for all instances of this class. It will only be used when Behaviour is not explicitly provided in the constructor.
  - setBehaviourFactory
```
public static void setBehaviourFactory(Class<? extends Order.Behaviour> cls)
```
    Sets the BehaviourFactory for all instances of this class using the given Behaviour class as the base. It will only be used when Behaviour is not explicitly provided in the constructor.
  - getBehaviourFactory
```
public static Order.BehaviourFactory getBehaviourFactory()
```
    Returns the singleton BehaviourFactory for this.
  - create
```
public static Order create(String id)
```
    Static creator method using id.
  - create
```
public static Order create(CreationEvent<Order> creationEvent)
```
    Static creator method using CreationEvent.
  - helper
```
public EntityHelper helper()
```
    Returns the Helper for this instance.
    
    Specified by:
    
    helper in interface Entity<Order>
    
    Returns:
  - uniqueId
```
public String uniqueId()
```
    Returns a unique id for this instance as a String. Used for synchronizing access to entities.
    
    Specified by:
    
    uniqueId in interface Entity<Order>
    
    Returns:
  - getDepot_R1
```
public Depot getDepot_R1()
```
    Getter. MANY Order was last at ZERO_ONE Depot
  - setDepot_R1
```
public void setDepot_R1(Depot depot_R1)
```
    Setter. MANY Order was last at ZERO_ONE Depot
  - relateAcrossR1
```
public Order relateAcrossR1(Depot depot_R1)
```
    MANY Order was last at ZERO_ONE Depot
  - unrelateAcrossR1
```
public Order unrelateAcrossR1(Depot depot_R1)
```
    MANY Order was last at ZERO_ONE Depot
  - getId
```
public String getId()
```
    Returns the identifier for this entity.
    
    Specified by:
    
    getId in interface Entity<Order>
  - setId
```
public void setId(String id)
```
  - setId_
```
public Order setId_(String id)
```
  - getDescription
```
public String getDescription()
```
    Returns description.
  - setDescription
```
public void setDescription(String description)
```
    Sets description to the given value.
  - setDescription_
```
public Order setDescription_(String description)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getFromAddress
```
public String getFromAddress()
```
    Returns fromAddress.
  - setFromAddress
```
public void setFromAddress(String fromAddress)
```
    Sets fromAddress to the given value.
  - setFromAddress_
```
public Order setFromAddress_(String fromAddress)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getToAddress
```
public String getToAddress()
```
    Returns toAddress.
  - setToAddress
```
public void setToAddress(String toAddress)
```
    Sets toAddress to the given value.
  - setToAddress_
```
public Order setToAddress_(String toAddress)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getDestinationEmail
```
public String getDestinationEmail()
```
    Returns destinationEmail.
  - setDestinationEmail
```
public void setDestinationEmail(String destinationEmail)
```
    Sets destinationEmail to the given value.
  - setDestinationEmail_
```
public Order setDestinationEmail_(String destinationEmail)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getSenderEmail
```
public String getSenderEmail()
```
    Returns senderEmail.
  - setSenderEmail
```
public void setSenderEmail(String senderEmail)
```
    Sets senderEmail to the given value.
  - setSenderEmail_
```
public Order setSenderEmail_(String senderEmail)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getMaxAttempts
```
public Integer getMaxAttempts()
```
    Returns maxAttempts.
  - setMaxAttempts
```
public void setMaxAttempts(Integer maxAttempts)
```
    Sets maxAttempts to the given value.
  - setMaxAttempts_
```
public Order setMaxAttempts_(Integer maxAttempts)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getAttempts
```
public Integer getAttempts()
```
    Returns attempts.
  - setAttempts
```
public void setAttempts(Integer attempts)
```
    Sets attempts to the given value.
  - setAttempts_
```
public Order setAttempts_(Integer attempts)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getComment
```
public String getComment()
```
    Returns comment.
  - setComment
```
public void setComment(String comment)
```
    Sets comment to the given value.
  - setComment_
```
public Order setComment_(String comment)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getStatus
```
public String getStatus()
```
    Returns status.
  - setStatus
```
public void setStatus(String status)
```
    Sets status to the given value.
  - setStatus_
```
public Order setStatus_(String status)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getState
```
public String getState()
```
    For internal use only by the state machine but is persisted by the jpa provider.
  - setState
```
public void setState(String state)
```
    For internal use only by the state machine but is persisted by the jpa provider.
  - setState
```
public void setState(Order.State state)
```
    Sets the current state. This should only be used when creating an instance without using the state machine.
  - signal
```
public Order signal(Event<Order> event)
```
    Asychronously queues the given signal against this entity for processing.
    
    Specified by:
    
    signal in interface Entity<Order>
  - signal
```
public Order signal(Event<Order> event,
                    scala.concurrent.duration.Duration delay)
```
    Asychronously queues the given signal against this entity for processing after the delay specified. Delay cannot be null.
    
    Specified by:
    
    signal in interface Entity<Order>
  - signal
```
public Order signal(Event<Order> event,
                    long time)
```
    Asychronously queues the given signal against this entity for processing at the epoch time in ms specified. Delay cannot be null.
    
    Specified by:
    
    signal in interface Entity<Order>
  - cancelSignal
```
public Order cancelSignal(String eventSignatureKey)
```
  - cancelSignal
```
public Order cancelSignal(Event<Order> event)
```
  - event
```
public Order event(Event<Order> event)
```
    Synchronously runs the on entry procedure associated with this event and also any signals to self that are made during the procedure. This method should not be called directly except in a unit testing scenario perhaps. Call signal method instead.
    
    Specified by:
    
    event in interface Entity<Order>
  - create
```
public static Order create(javax.persistence.EntityManager em,
                           CreationEvent<Order> event)
```
    Static creator method associated with the creation transition to 'Preparing' via event 'Create'.
  - merge
```
public Order merge(javax.persistence.EntityManager em)
```
    Same as EntityManager.merge() except allows method chaining. Returns a new merged instance.
  - persist
```
public Order persist(javax.persistence.EntityManager em)
```
    Same as EntityManager.persist() except allows method chaining. Returns this.
  - persist
```
public Order persist()
```
    Same as persist(Context.em()). Returns this.
  - remove
```
public Order remove(javax.persistence.EntityManager em)
```
    Same as EntityManager.remove() except inverted to facilitate method chaining. Returns this.
  - remove
```
public Order remove()
```
    Same as EntityManager.remove() except inverted to facilitate method chaining. Returns this.
  - delete
```
public Order delete()
```
    Same as this.remove()
  - refresh
```
public Order refresh(javax.persistence.EntityManager em)
```
    Same as EntityManager.refresh() except inverted to facilitate method chaining. Returns this.
  - load
```
public Order load(javax.persistence.EntityManager em)
```
    Does a merge then a refresh and returns a new updated merged instance.
  - load
```
public Order load()
```
  - createBehaviourFactory
```
public static Order.BehaviourFactory createBehaviourFactory(Class<? extends Order.Behaviour> cls)
```
    Returns a BehaviourFactory on the assumption that the given class has a single constructor with one parameter of type Order.
  - find
```
public static com.google.common.base.Optional<Order> find(String id)
```
  - select
```
public static SelectBuilder<Order> select(BooleanExpression<Order> where)
```
  - select
```
public static SelectBuilder<Order> select()
```

Class Order

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Order

Order

Method Detail

setBehaviourFactory

setBehaviourFactory

getBehaviourFactory

create

create

helper

uniqueId

getDepot_R1

setDepot_R1

relateAcrossR1

unrelateAcrossR1

getId

setId

setId_

getDescription

setDescription

setDescription_

getFromAddress

setFromAddress

setFromAddress_

getToAddress

setToAddress

setToAddress_

getDestinationEmail

setDestinationEmail

setDestinationEmail_

getSenderEmail

setSenderEmail

setSenderEmail_

getMaxAttempts

setMaxAttempts

setMaxAttempts_

getAttempts

setAttempts

setAttempts_

getComment

setComment

setComment_

getStatus

setStatus

setStatus_

getState

setState

setState

signal

signal

signal

cancelSignal

cancelSignal

event

create

merge

persist

persist

remove

remove

delete

refresh

load

load

createBehaviourFactory

find

select

select