server/io.spine.server.procman.model/ProcessManagerClass

ProcessManagerClass

public final class ProcessManagerClass extends CommandHandlingEntityClass<E> implements ReactingClass, CommandingClass

Provides message handling information on a process manager class.

Parameters

the type of process managers

Functions

asProcessManagerClass

public static ProcessManagerClass asProcessManagerClass(Class cls)

Obtains the process manager class for the passed raw class.

commanderOf

public CommandSubstituteMethod commanderOf(CommandClass commandClass)

Obtains a method which handles the passed class of commands by producing one or more other commands.

public CommandReactionMethod commanderOf(EventClass eventClass)

Obtains a method which may generate one or more commands in response to incoming event with the passed class.

commands

public ImmutableSet<CommandClass> commands()

Obtains classes of commands handled by the class.

domesticEvents

public ImmutableSet<EventClass> domesticEvents()

Obtains a set of domestic events which this class receives.

events

public ImmutableSet<EventClass> events()

Obtains a set of event classes which this class receives.

externalEvents

public ImmutableSet<EventClass> externalEvents()

Obtains a set of external events which this class receives.

outgoingCommands

public ImmutableSet<CommandClass> outgoingCommands()

Obtains the classes of commands produced by this commanding class.

outgoingEvents

public ImmutableSet<EventClass> outgoingEvents()

Obtains event classes produced by this process manager class.

producesCommandsOn

public boolean producesCommandsOn(EventClass eventClass)

Verifies if the process manager class generates a command in response to an event of the passed class.

reactionOutput

public ImmutableSet<EventClass> reactionOutput()

Obtains the classes of events produced from the event reaction.

reactorOf

public EventReactorMethod reactorOf(EventClass eventClass, MessageClass<?> originClass)

Obtains the method that reacts on the events of the passed class.

reactsOnEvent

public boolean reactsOnEvent(EventClass eventClass)

Verifies if the class of process managers react on an event of the passed class.

substitutesCommand

public boolean substitutesCommand(CommandClass commandClass)

Verifies if the process manager class has a method which generates one or more commands in response to a command of the passed class.

Inherited functions

asEntityClass

public static EntityClass<E> asEntityClass<E extends Entity>(Class<E> cls)

Obtains an entity class for the passed raw class.

columns

public final Columns columns()

Obtains the entity columns of this class.

commandOutput

public abstract ImmutableSet<R> commandOutput()

public ImmutableSet<EventClass> commandOutput()

Obtains classes of all messages produced as a result of command handling.

constructor

public final Constructor<E> constructor()

Obtains constructor for the entities of this class.

create

public E create(Object constructionArgument)

Creates new entity.

createFactory

protected EntityFactory<E> createFactory()

Creates a new instance of the factory for creating entities.

defaultState

public final EntityState defaultState()

Obtains the default state for this class of entities.

equals

public boolean equals(Object o)

factory

public final EntityFactory<E> factory()

Obtains the factory for creating entities.

get

protected static ModelClass<T> get<T, M extends ModelClass<T>>(Class<T> rawClass, Class<M> requestedModelClass, Supplier<ModelClass<T>> supplier)

Obtains the model class for the passed raw class.

handlerOf

public abstract H handlerOf(CommandClass commandClass)

public CommandHandlerMethod handlerOf(CommandClass commandClass)

Obtains the handler method for the passed command class.

handlesCommand

public boolean handlesCommand(CommandClass commandClass)

hashCode

public int hashCode()

idClass

public final Class<? extends Object> idClass()

Obtains the class of IDs used by the entities of this class.

public static Class idClass(Class<? extends Entity> cls)

Obtains the class of identifiers from the passed entity class.

rejections

public ImmutableSet<EventClass> rejections()

Obtains classes of rejections that command handling methods of this class throw, or empty set if no rejections are thrown.

stateClass

public final Class<? extends EntityState> stateClass()

Obtains the class of the state of entities of this class.

stateClassOf

public static Class<S> stateClassOf<S extends EntityState>(Class<? extends Entity> entityClass)

Retrieves the state class of the passed entity class.

stateType

public final MessageType stateType()

Obtains the entity state type.

stateTypeUrl

public final TypeUrl stateTypeUrl()

Obtains type URL of the state of entities of this class.

typeName

public final EntityTypeName typeName()

Obtains the name of this class as an EntityTypeName.

value

public Class<E> value()

Obtains the raw class of the entities.

visibility

public final EntityVisibility visibility()

Obtains the visibility of this entity type as declared in the Protobuf definition.