Package de.aristaflow.adept2.model.processmodel.systemdata

Enum SystemDataProducer

  • All Implemented Interfaces:
    LocalisedString, Serializable, Comparable<SystemDataProducer>
    public enum SystemDataProducer
extends Enum<SystemDataProducer>
implements LocalisedString
    This enumeration represents all process model methods that can produce system data, that is data which can be used normally in the data flow of a process. This is used for instance for dependent staff assignment rules (a node is to be performed by the same agent as some other node before). Such data is modelled explicitly as system parameters of a node which write an existing data element. The ExecutionManager takes care of retrieving the values from the process model methods and writing them to the corresponding data elements in the DataManager.
    Data provided by templates and instances is written by the corresponding start node.

    Every element of this enumeration represents a Parameter which is to be added at the corresponding node.

    Author:
    Ulrich Kreher

    • Method Detail

      • values

        public static SystemDataProducer[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SystemDataProducer c : SystemDataProducer.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SystemDataProducer valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getParameterProperties

        public ProcessModelParameter getParameterProperties()
        Gets a parameter object providing all properties for the corresponding implicit system parameter
        Returns:
        A parameter object providing all information needed for creating a corresponding system parameter.

      • getCompanion

        public SystemDataProducer getCompanion()
        Gets the system data producer that is a companion of this. This is used for data producers that are coupled, for instance specifying a qualified agent needs an agent ID and organisational position ID. If this system data producer does not have such a "companion" system data producer, null will be returned.
        Returns:
        The system data producer that is coupled to this system data producer or null in case there is no companion for this system data producer.

      • toLocalisedString

        public Object toLocalisedString​(LocalisationFactory locFac,
                                Locale loc)
        Description copied from interface: LocalisedString
        Gets the localised representation of the implementing object. The localisation should be for the designated locale, model objects being Localised should use the designated localisation factory for automatic localisation.
        Specified by:
        toLocalisedString in interface LocalisedString
        Parameters:
        locFac - The localisation factory to be used by Localised model objects. If this is null, do not localise the used Localised attributes.
        loc - The locale for which to get the localised string. If this is null, treat it like Locale.ROOT has been requested.
        Returns:
        The localised (string) representation of the implementing object for the designated locale using the designated localisation factory if appropriate.

      • getProducerForIdentifierID

        public static SystemDataProducer getProducerForIdentifierID​(UUID identifierID)
        Returns the SystemDataProducer matching the specified identifier ID or null if there exists none.
        Parameters:
        identifierID - the identifier ID for which to return the associated system data producer
        Returns:
        the SystemDataProducer matching the specified identifier ID or null if there exists none

      • startNodeProduced

        public static SystemDataProducer[] startNodeProduced()
        Gets all the values that are produced by the start node, that is, the data stems from template or instance objects.
        Returns:
        All the values produced by the start node (data that stems from template or instance objects.

      • nodeProduced

        public static SystemDataProducer[] nodeProduced()
        Gets all the values that are produced by arbitrary nodes.
        Returns:
        All the values produced by arbitrary nodes.