SystemEvent (xuml-tools 0.5 API)

java.lang.Object
- ordertracker.SystemEvent

All Implemented Interfaces:: Entity<SystemEvent>

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

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description

SystemEvent()
No argument constructor required by JPA.

SystemEvent(String id)
Constructor using id.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SystemEvent`	`cancelSignal(Event<SystemEvent> event)`
`SystemEvent`	`cancelSignal(String eventSignatureKey)`
`static SystemEvent`	`create(CreationEvent<SystemEvent> creationEvent)` Static creator method using CreationEvent.
`static SystemEvent`	`create(javax.persistence.EntityManager em, CreationEvent<SystemEvent> event)` Static creator method associated with the creation transition to 'Created' via event 'Create'.
`static SystemEvent`	`create(String id)` Static creator method using id.
`static SystemEvent.BehaviourFactory`	`createBehaviourFactory(Class<? extends SystemEvent.Behaviour> cls)` Returns a BehaviourFactory on the assumption that the given class has a single constructor with one parameter of type SystemEvent.
`SystemEvent`	`delete()` Same as this.remove()
`SystemEvent`	`event(Event<SystemEvent> 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<SystemEvent>`	`find(String id)`
`static SystemEvent.BehaviourFactory`	`getBehaviourFactory()` Returns the singleton BehaviourFactory for this.
`String`	`getId()` Returns the identifier for this entity.
`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.
`SystemEvent`	`load()`
`SystemEvent`	`load(javax.persistence.EntityManager em)` Does a merge then a refresh and returns a new updated merged instance.
`SystemEvent`	`merge(javax.persistence.EntityManager em)` Same as EntityManager.merge() except allows method chaining.
`SystemEvent`	`persist()` Same as `persist(Context.em())`.
`SystemEvent`	`persist(javax.persistence.EntityManager em)` Same as EntityManager.persist() except allows method chaining.
`SystemEvent`	`refresh(javax.persistence.EntityManager em)` Same as EntityManager.refresh() except inverted to facilitate method chaining.
`SystemEvent`	`remove()` Same as EntityManager.remove() except inverted to facilitate method chaining.
`SystemEvent`	`remove(javax.persistence.EntityManager em)` Same as EntityManager.remove() except inverted to facilitate method chaining.
`static SelectBuilder<SystemEvent>`	`select()`
`static SelectBuilder<SystemEvent>`	`select(BooleanExpression<SystemEvent> where)`
`static void`	`setBehaviourFactory(Class<? extends SystemEvent.Behaviour> cls)` Sets the BehaviourFactory for all instances of this class using the given Behaviour class as the base.
`static void`	`setBehaviourFactory(SystemEvent.BehaviourFactory factory)` Sets the BehaviourFactory for all instances of this class.
`SystemEvent`	`setId_(String id)`
`void`	`setId(String id)`
`void`	`setState(String state)` For internal use only by the state machine but is persisted by the jpa provider.
`void`	`setState(SystemEvent.State state)` Sets the current state.
`SystemEvent`	`signal(Event<SystemEvent> event)` Asychronously queues the given signal against this entity for processing.
`SystemEvent`	`signal(Event<SystemEvent> event, scala.concurrent.duration.Duration delay)` Asychronously queues the given signal against this entity for processing after the delay specified.
`SystemEvent`	`signal(Event<SystemEvent> 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.

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

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

Class SystemEvent

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SystemEvent

SystemEvent

Method Detail

setBehaviourFactory

setBehaviourFactory

getBehaviourFactory

create

create

helper

uniqueId

getId

setId

setId_

getState

setState

setState

signal

signal

signal

cancelSignal

cancelSignal

event

create

merge

persist

persist

remove

remove

delete

refresh

load

load

createBehaviourFactory

find

select

select