BuiltInItemProperties (cristalise-kernel 5.1.2 API)

java.lang.Object
- java.lang.Enum<BuiltInItemProperties>
- - org.cristalise.kernel.property.BuiltInItemProperties

All Implemented Interfaces:

Serializable, Comparable<BuiltInItemProperties>
```
public enum BuiltInItemProperties
extends Enum<BuiltInItemProperties>
```
Helper enumeration to make built-in Property names easier to maintain and document

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGGREGATE_SCRIPT_URN`
`COMPLEXITY` Used in description Items to manage Elementary or Composite Activity Definition
`CREATOR` Store the Agent name used used to call the `CreateItemFromDescription` predefined Step.
`KERNEL_VERSION`
`MASTER_SCHEMA_URN`
`MODULE`
`NAME` The name or ID of the Item, specified by the Factory Item and sent as the first parameter in the `CreateItemFromDescription` predefined Step.
`NAMESPACE`
`QUERY_URN` The UUID of the Query Item and its Version number separated by colon ':'.
`SCHEMA_URN` The UUID of the Schema Item and its Version number separated by colon ':'.
`SCRIPT_URN` The UUID of the Script Item and its Version number separated by colon ':'.
`SECURITY_DOMAIN` It is used during the permission checks based on Shiro WildcardPermission.
`STATE_MACHINE_URN` The UUID of the StateMachine Item and its Version number separated by colon ':'.
`TYPE` The type of the Item, it is a good practice to set it as an immutable, fixed value Property.
`VERSION`
`WORKFLOW_URN` The UUID of the Workflow Item and its Version number separated by colon ':'

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()`
`static BuiltInItemProperties`	`getValue(String propName)`
`String`	`toString()`
`static BuiltInItemProperties`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BuiltInItemProperties[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AGGREGATE_SCRIPT_URN
```
public static final BuiltInItemProperties AGGREGATE_SCRIPT_URN
```
  - CREATOR
```
public static final BuiltInItemProperties CREATOR
```
    Store the Agent name used used to call the CreateItemFromDescription predefined Step.
  - COMPLEXITY
```
public static final BuiltInItemProperties COMPLEXITY
```
    Used in description Items to manage Elementary or Composite Activity Definition
  - KERNEL_VERSION
```
public static final BuiltInItemProperties KERNEL_VERSION
```
  - 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. It will be automatically added even if it was not defined.
  - NAMESPACE
```
public static final BuiltInItemProperties NAMESPACE
```
  - MODULE
```
public static final BuiltInItemProperties MODULE
```
  - 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.
  - WORKFLOW_URN
```
public static final BuiltInItemProperties WORKFLOW_URN
```
    The UUID of the Workflow Item and its Version number separated by colon ':'
- Method Detail
  - values
```
public static BuiltInItemProperties[] 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 (BuiltInItemProperties c : BuiltInItemProperties.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BuiltInItemProperties 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
  - getName
```
public String getName()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<BuiltInItemProperties>
  - getValue
```
public static BuiltInItemProperties getValue(String propName)
```

Enum BuiltInItemProperties

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AGGREGATE_SCRIPT_URN

CREATOR

COMPLEXITY

KERNEL_VERSION

MASTER_SCHEMA_URN

NAME

NAMESPACE

MODULE

TYPE

SECURITY_DOMAIN

VERSION

SCHEMA_URN

SCRIPT_URN

QUERY_URN

STATE_MACHINE_URN

WORKFLOW_URN

Method Detail

values

valueOf

getName

toString

getValue