Package org.kuali.rice.kew.api.document.attribute

Class WorkflowAttributeDefinition

java.lang.Object
org.kuali.rice.core.api.mo.AbstractDataTransferObject
org.kuali.rice.kew.api.document.attribute.WorkflowAttributeDefinition
All Implemented Interfaces:
Serializable, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete
public final class WorkflowAttributeDefinition extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
Encapsulates parameters that can be sent to an attribute when using that attribute to perform various operations (primarily, in the case of workflow attributes, during the generation of XML). The distinction between parameters and properties is that parameters are used to initially construct the attribute (via the attribute class constructor), while property definitions are used to set properties on the attribute thereafter.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WorkflowAttributeDefinition.Builder
    A builder which can be used to construct instances of WorkflowAttributeDefinition.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeName()
    Returns the name of the attribute for this workflow attribute definition.
    List<String>
    getParameters()
    Returns an unmodifiable list of parameters that will be used to construct the attribute as a list of string values.
    List<PropertyDefinition>
    getPropertyDefinitions()
    Returns an unmodifiable list of property names and values that will be passed to the attribute upon construction.
    Map<String,String>
    getPropertyDefinitionsAsMap()
    Returns the property definitions on this attribute definition as a map of strings instead of a list of PropertyDefinition objects.

    Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

    afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • getAttributeName

      public String getAttributeName()
      Returns the name of the attribute for this workflow attribute definition. Should never be a null or blank value.
      Returns:
      the name of the attribute for this workflow attribute definition

    • getParameters

      public List<String> getParameters()
      Returns an unmodifiable list of parameters that will be used to construct the attribute as a list of string values. This list will never be null but it may be empty.
      Returns:
      the list of parameters used to construct the attribute

    • getPropertyDefinitions

      public List<PropertyDefinition> getPropertyDefinitions()
      Returns an unmodifiable list of property names and values that will be passed to the attribute upon construction. This list will never be null but it may be empty.
      Returns:
      the list of property names and values to will be be passed to the attribute upon construction

    • getPropertyDefinitionsAsMap

      public Map<String,String> getPropertyDefinitionsAsMap()
      Returns the property definitions on this attribute definition as a map of strings instead of a list of PropertyDefinition objects.
      Returns:
      a map representation of the property definitions on this workflow attribute definition