Package org.cristalise.kernel.property

Enum Class BuiltInItemProperties

java.lang.Object
java.lang.Enum<BuiltInItemProperties>
org.cristalise.kernel.property.BuiltInItemProperties
All Implemented Interfaces:
Serializable, Comparable<BuiltInItemProperties>, Constable
public enum BuiltInItemProperties extends Enum<BuiltInItemProperties>
Helper enumeration to make built-in Property names easier to maintain and document

  • Enum Constant Details

    • AGGREGATE_SCRIPT_URN

      public static final BuiltInItemProperties AGGREGATE_SCRIPT_URN

    • COMPLEXITY

      public static final BuiltInItemProperties COMPLEXITY
      Used in description Items to manage Elementary or Composite Activity Definition

    • ID_PREFIX

      public static final BuiltInItemProperties ID_PREFIX
      Used for generating Names: the prefix (e.g. PR) used as a beginning of the Name

    • KERNEL_VERSION

      public static final BuiltInItemProperties KERNEL_VERSION

    • LEFT_PAD_SIZE

      public static final BuiltInItemProperties LEFT_PAD_SIZE
      Used for generating Names: the length of the number part left padded by zeros

    • LAST_COUNT

      public static final BuiltInItemProperties LAST_COUNT
      Used for generating Names: the last number used to generate a Name

    • MASTER_SCHEMA_URN

      public static final BuiltInItemProperties MASTER_SCHEMA_URN

    • NAME

      public static final BuiltInItemProperties NAME
      The name or ID of the Item, specified by the Factory Item and sent as the first parameter in the CreateItemFromDescription predefined Step or generated during the execution of CreateItemFromDescription. It will be automatically added even if it was not defined.

    • NAMESPACE

      public static final BuiltInItemProperties NAMESPACE

    • MODULE

      public static final BuiltInItemProperties MODULE

    • ROOT

      public static final BuiltInItemProperties ROOT
      Used in factory Items to specify the Root DomainPath.

    • TYPE

      public static final BuiltInItemProperties TYPE
      The type of the Item, it is a good practice to set it as an immutable, fixed value Property. It is convenient to use in lookup.search() to find Items of the same type. It is used in Dev module extensively, and it is also used when checking permission for the 'domain' part of Shiro WildcardPermission (use 'SecurityDomain' Property to overwrite it)

    • SECURITY_DOMAIN

      public static final BuiltInItemProperties SECURITY_DOMAIN
      It is used during the permission checks based on Shiro WildcardPermission. If not blank it replaces the type of the Item used for the 'domain' section in the constructed permission string. Can be null or undefined.

    • VERSION

      public static final BuiltInItemProperties VERSION

    • SCHEMA_URN

      public static final BuiltInItemProperties SCHEMA_URN
      The UUID of the Schema Item and its Version number separated by colon ':'. It is created during instantiation of the Schema Dependency.

    • SCRIPT_URN

      public static final BuiltInItemProperties SCRIPT_URN
      The UUID of the Script Item and its Version number separated by colon ':'. It is created during instantiation of the Script Dependency.

    • QUERY_URN

      public static final BuiltInItemProperties QUERY_URN
      The UUID of the Query Item and its Version number separated by colon ':'. It is created during instantiation of the Query Dependency.

    • STATE_MACHINE_URN

      public static final BuiltInItemProperties STATE_MACHINE_URN
      The UUID of the StateMachine Item and its Version number separated by colon ':'. It is created during instantiation of the StateMachine Dependency.

    • UPDATE_SCHEMA

      public static final BuiltInItemProperties UPDATE_SCHEMA
      The Name or the UUID of the Schema Item and its Version separated by colon ':'. It is specified in Factory Items is used while creating new Items.

    • WORKFLOW_URN

      public static final BuiltInItemProperties WORKFLOW_URN
      The UUID of the Workflow Item and its Version number separated by colon ':'

  • Method Details

    • values

      public static BuiltInItemProperties[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BuiltInItemProperties valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()

    • toString

      public String toString()
      Overrides:
      toString in class Enum<BuiltInItemProperties>

    • getValue

      public static BuiltInItemProperties getValue(String propName)