Depot (xuml-tools 0.5 API)

java.lang.Object
- ordertracker.Depot

All Implemented Interfaces:: Entity<Depot>

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

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description

Depot()
No argument constructor required by JPA.

Depot(String id)
Constructor using id.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Depot`	`cancelSignal(Event<Depot> event)`
`Depot`	`cancelSignal(String eventSignatureKey)`
`static Depot`	`create(CreationEvent<Depot> creationEvent)` Static creator method using CreationEvent.
`static Depot`	`create(javax.persistence.EntityManager em, CreationEvent<Depot> event)` Static creator method associated with the creation transition to 'Created' via event 'Create'.
`static Depot`	`create(String id)` Static creator method using id.
`static Depot.BehaviourFactory`	`createBehaviourFactory(Class<? extends Depot.Behaviour> cls)` Returns a BehaviourFactory on the assumption that the given class has a single constructor with one parameter of type Depot.
`Depot`	`delete()` Same as this.remove()
`Depot`	`event(Event<Depot> 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<Depot>`	`find(String id)`
`static Depot.BehaviourFactory`	`getBehaviourFactory()` Returns the singleton BehaviourFactory for this.
`String`	`getId()` Returns the identifier for this entity.
`Double`	`getLatitude()` Returns latitude.
`Double`	`getLongitude()` Returns longitude.
`String`	`getName()` Returns name.
`Set<Order>`	`getOrder_R1()` Getter.
`String`	`getState()` For internal use only by the state machine but is persisted by the jpa provider.
`EntityHelper`	`helper()` Returns the Helper for this instance.
`Depot`	`load()`
`Depot`	`load(javax.persistence.EntityManager em)` Does a merge then a refresh and returns a new updated merged instance.
`Depot`	`merge(javax.persistence.EntityManager em)` Same as EntityManager.merge() except allows method chaining.
`Depot`	`persist()` Same as `persist(Context.em())`.
`Depot`	`persist(javax.persistence.EntityManager em)` Same as EntityManager.persist() except allows method chaining.
`Depot`	`refresh(javax.persistence.EntityManager em)` Same as EntityManager.refresh() except inverted to facilitate method chaining.
`Depot`	`relateAcrossR1(Order order_R1)` ZERO_ONE Depot is last location of MANY Order
`Depot`	`remove()` Same as EntityManager.remove() except inverted to facilitate method chaining.
`Depot`	`remove(javax.persistence.EntityManager em)` Same as EntityManager.remove() except inverted to facilitate method chaining.
`static SelectBuilder<Depot>`	`select()`
`static SelectBuilder<Depot>`	`select(BooleanExpression<Depot> where)`
`static void`	`setBehaviourFactory(Class<? extends Depot.Behaviour> cls)` Sets the BehaviourFactory for all instances of this class using the given Behaviour class as the base.
`static void`	`setBehaviourFactory(Depot.BehaviourFactory factory)` Sets the BehaviourFactory for all instances of this class.
`Depot`	`setId_(String id)`
`void`	`setId(String id)`
`Depot`	`setLatitude_(Double latitude)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setLatitude(Double latitude)` Sets latitude to the given value.
`Depot`	`setLongitude_(Double longitude)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setLongitude(Double longitude)` Sets longitude to the given value.
`Depot`	`setName_(String name)` Sets the attribute to the given value and returns this (enables method chaining).
`void`	`setName(String name)` Sets name to the given value.
`void`	`setOrder_R1(Set<Order> order_R1)` Setter.
`void`	`setState(Depot.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.
`Depot`	`signal(Event<Depot> event)` Asychronously queues the given signal against this entity for processing.
`Depot`	`signal(Event<Depot> event, scala.concurrent.duration.Duration delay)` Asychronously queues the given signal against this entity for processing after the delay specified.
`Depot`	`signal(Event<Depot> 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.
`Depot`	`unrelateAcrossR1(Order order_R1)` ZERO_ONE Depot is last location of MANY Order

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

- Constructor Detail
  - Depot
```
public Depot()
```
    No argument constructor required by JPA.
  - Depot
```
public Depot(String id)
```
    Constructor using id.
- Method Detail
  - setBehaviourFactory
```
public static void setBehaviourFactory(Depot.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 Depot.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 Depot.BehaviourFactory getBehaviourFactory()
```
    Returns the singleton BehaviourFactory for this.
  - create
```
public static Depot create(String id)
```
    Static creator method using id.
  - create
```
public static Depot create(CreationEvent<Depot> creationEvent)
```
    Static creator method using CreationEvent.
  - helper
```
public EntityHelper helper()
```
    Returns the Helper for this instance.
    
    Specified by:
    
    helper in interface Entity<Depot>
    
    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<Depot>
    
    Returns:
  - getOrder_R1
```
public Set<Order> getOrder_R1()
```
    Getter. ZERO_ONE Depot is last location of MANY Order
  - setOrder_R1
```
public void setOrder_R1(Set<Order> order_R1)
```
    Setter. ZERO_ONE Depot is last location of MANY Order
  - relateAcrossR1
```
public Depot relateAcrossR1(Order order_R1)
```
    ZERO_ONE Depot is last location of MANY Order
  - unrelateAcrossR1
```
public Depot unrelateAcrossR1(Order order_R1)
```
    ZERO_ONE Depot is last location of MANY Order
  - getId
```
public String getId()
```
    Returns the identifier for this entity.
    
    Specified by:
    
    getId in interface Entity<Depot>
  - setId
```
public void setId(String id)
```
  - setId_
```
public Depot setId_(String id)
```
  - getName
```
public String getName()
```
    Returns name.
  - setName
```
public void setName(String name)
```
    Sets name to the given value.
  - setName_
```
public Depot setName_(String name)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getLatitude
```
public Double getLatitude()
```
    Returns latitude.
  - setLatitude
```
public void setLatitude(Double latitude)
```
    Sets latitude to the given value.
  - setLatitude_
```
public Depot setLatitude_(Double latitude)
```
    Sets the attribute to the given value and returns this (enables method chaining).
  - getLongitude
```
public Double getLongitude()
```
    Returns longitude.
  - setLongitude
```
public void setLongitude(Double longitude)
```
    Sets longitude to the given value.
  - setLongitude_
```
public Depot setLongitude_(Double longitude)
```
    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(Depot.State state)
```
    Sets the current state. This should only be used when creating an instance without using the state machine.
  - signal
```
public Depot signal(Event<Depot> event)
```
    Asychronously queues the given signal against this entity for processing.
    
    Specified by:
    
    signal in interface Entity<Depot>
  - signal
```
public Depot signal(Event<Depot> 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<Depot>
  - signal
```
public Depot signal(Event<Depot> 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<Depot>
  - cancelSignal
```
public Depot cancelSignal(String eventSignatureKey)
```
  - cancelSignal
```
public Depot cancelSignal(Event<Depot> event)
```
  - event
```
public Depot event(Event<Depot> 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<Depot>
  - create
```
public static Depot create(javax.persistence.EntityManager em,
                           CreationEvent<Depot> event)
```
    Static creator method associated with the creation transition to 'Created' via event 'Create'.
  - merge
```
public Depot merge(javax.persistence.EntityManager em)
```
    Same as EntityManager.merge() except allows method chaining. Returns a new merged instance.
  - persist
```
public Depot persist(javax.persistence.EntityManager em)
```
    Same as EntityManager.persist() except allows method chaining. Returns this.
  - persist
```
public Depot persist()
```
    Same as persist(Context.em()). Returns this.
  - remove
```
public Depot remove(javax.persistence.EntityManager em)
```
    Same as EntityManager.remove() except inverted to facilitate method chaining. Returns this.
  - remove
```
public Depot remove()
```
    Same as EntityManager.remove() except inverted to facilitate method chaining. Returns this.
  - delete
```
public Depot delete()
```
    Same as this.remove()
  - refresh
```
public Depot refresh(javax.persistence.EntityManager em)
```
    Same as EntityManager.refresh() except inverted to facilitate method chaining. Returns this.
  - load
```
public Depot load(javax.persistence.EntityManager em)
```
    Does a merge then a refresh and returns a new updated merged instance.
  - load
```
public Depot load()
```
  - createBehaviourFactory
```
public static Depot.BehaviourFactory createBehaviourFactory(Class<? extends Depot.Behaviour> cls)
```
    Returns a BehaviourFactory on the assumption that the given class has a single constructor with one parameter of type Depot.
  - find
```
public static com.google.common.base.Optional<Depot> find(String id)
```
  - select
```
public static SelectBuilder<Depot> select(BooleanExpression<Depot> where)
```
  - select
```
public static SelectBuilder<Depot> select()
```

Class Depot

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Depot

Depot

Method Detail

setBehaviourFactory

setBehaviourFactory

getBehaviourFactory

create

create

helper

uniqueId

getOrder_R1

setOrder_R1

relateAcrossR1

unrelateAcrossR1

getId

setId

setId_

getName

setName

setName_

getLatitude

setLatitude

setLatitude_

getLongitude

setLongitude

setLongitude_

getState

setState

setState

signal

signal

signal

cancelSignal

cancelSignal

event

create

merge

persist

persist

remove

remove

delete

refresh

load

load

createBehaviourFactory

find

select

select