Package de.aristaflow.adept2.model.common

Interface UserAttributeContainer

All Known Subinterfaces:
AbstractActivity, AbstractActivityModelParameter, AbstractActivityTemplateDefinition, AbstractConfigurationSet, AbstractExecutableComponentDescription, AbstractOperation, AbstractParameterTemplate, Activity, ActivityInstance, ActivityModelParameter, ActivityReference, ActivityTemplate, ActivityTemplateDefinition, AdministrativeWorklistItem, ArchiveDataContainer, ATDReference, ATParameter, ATParameterTemplate, BuildtimeActivity, ChangeableIconDescriptor, ChangeableInstance, ChangeableResourceDescriptor, ChangeableTemplate, ClientWorklist, ClientWorklistItem, ConfigurationDescription.ConfigurationEntry, ConfigurationSet, CSReference, DataContainer, DataContext, DataEdge, DataElement, DecisionActivity, DecisionActivityInstance, DecisionStatement, ECDReference, Edge, EmbeddedProcess, ExecutableBusinessProcess, ExecutableBusinessProcessInstance, ExecutableComponentDescription, ExecutableInstance, ExecutionContext, GroupActivityReference, IconDescriptor, Identifier, IncrementalWorklist<T>, IncrementalWorklistUpdate, IndexedAccessDataContainer, IndividualWorklistItemSettings, InitTabEntry, InputDataContainer, InputDataContext, Instance, InstanceDataContainer, InstanceDeltaLayer, InstanceReference, InternalWorklist<T>, InternalWorklistItem, LightWeightProcess, LightWeightProcessInstance, Node, Operation, OperationReference, Parameter, ParameterDataContext, ParameterTemplate, ProcessImageData, ProcessModelParameter, ProcessNodeContext, ReferencedProcess, ResourceDescriptor, SerialisableDataContext, SessionContext, SimpleSessionContext, StorageActivityModelParameter, StorageActivityTemplateDefinition, StorageConfigurationSet, StorageExecutableComponentDescription, StorageOperation, StorageParameterTemplate, Template, TemplateDeltaLayer, TemplateProxy, TemplateReference, VariableParallelismEBP, Worklist<T>, WorklistItem, WorklistUpdate, WorklistUpdateConfiguration
All Known Implementing Classes:
AbstractWrappingTemplate, ActivityGroupReference, ADEPT2ActivityReference, ADEPT2EBPReference, AssuringWorklistUpdate, CachingIncWorklistUpdate, ClientWorklistWrapper, de.aristaflow.adept2.model.common.defaultimplementation.DefaultPluginDataContainer, de.aristaflow.adept2.model.common.defaultimplementation.DefaultUserAttributeContainer, IDWrappingTemplate, LWPActivityReference, de.aristaflow.adept2.model.common.defaultimplementation.SerialisablePluginDataContainer, de.aristaflow.adept2.model.common.defaultimplementation.SerialisableUserAttributeContainer, SettableDataContext, TLPInstanceReference, UnregisterClientWorklist
public interface UserAttributeContainer
The UserAttributeContainer provides an interface for all classes using user defined attributes. An attribute is identified by its name.

User attributes are used for the extension of data model interfaces, without the need to touch interfaces for accessing and/or storing the new data value. User attributes are usually used as a temporary solution, until the change of the interface is decided.

Author:
Kevin Goeser, Ulrich Kreher, Patrick Haas

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getUserAttributes()
    Returns all user attributes as map, the key of the map is the name of the attribute.
    String
    getUserAttributeValue(String attributeName)
    Returns the value of the user attribute.
    void
    removeUserAttributeValue(String attributeName)
    Deprecated.
    This method may, depending on the data model, not be used except in some special cases.
    void
    setUserAttributeValue(String attributeName, String attributeValue)
    Deprecated.
    This method may, depending on the data model, not be used except in some special cases.

  • Method Details

    • getUserAttributeValue

      String getUserAttributeValue(String attributeName)
      Returns the value of the user attribute.
      Parameters:
      attributeName - The name of the user attribute.
      Returns:
      The value of the user attribute.

    • setUserAttributeValue

      @Deprecated void setUserAttributeValue(String attributeName, String attributeValue)
      Deprecated.
      This method may, depending on the data model, not be used except in some special cases.
      Set the value of an user attribute.

      This method must not be called directly! Use the change primitive of the corresponding model instead! In case of the process model, refer to ChangePrimitives.updateUserAttribute(UserAttributeContainer, String, String).

      Parameters:
      attributeName - The name of the attribute.
      attributeValue - The new value of the attribute.

    • removeUserAttributeValue

      @Deprecated void removeUserAttributeValue(String attributeName)
      Deprecated.
      This method may, depending on the data model, not be used except in some special cases.
      Removes the user attribute with the given name.

      This method must not be called directly! Use the change primitive of the corresponding model instead! In case of the process model, refer to ChangePrimitives.updateUserAttribute(UserAttributeContainer, String, String).

      Parameters:
      attributeName - The key of the value to remove.

    • getUserAttributes

      Map<String,String> getUserAttributes()
      Returns all user attributes as map, the key of the map is the name of the attribute. Do not change the returned map even if it is modifiable. Implementations will usually return a copy of the map. See setUserAttributeValue(String, String) and removeUserAttributeValue(String) on how to change user attributes.
      Returns:
      A (copy of the) map with all user defined attributes.