BuiltInVertexProperties (cristalise-kernel 5.1.0 API)

java.lang.Object
- java.lang.Enum<BuiltInVertexProperties>
- - org.cristalise.kernel.graph.model.BuiltInVertexProperties

All Implemented Interfaces:

Serializable, Comparable<BuiltInVertexProperties>
```
public enum BuiltInVertexProperties
extends Enum<BuiltInVertexProperties>
```
Enumeration to define all Vertex properties which are used by collection and lifecycle packages

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORTABLE` Boolean property.
`ACTIVITY_DEF_NAME`
`ACTIVITY_DEF_URN`
`ACTIVITY_DEF_VERSION`
`AGENT_NAME` String property.
`AGENT_ROLE` Deprecated. use `RolePath.setPermissions(java.util.List)` instead
`ATTACHMENT_MIME_TYPES` String property.
`BREAKPOINT` Boolean property ...
`DELEGATE_NAME` String property.
`DESCRIPTION` String property used in ActivityDef to store the description text
`LAST_NUM` Used in Splits as a counter to provide unique ID for instances of `DirectedEdge`
`MEMBER_ADD_SCRIPT` String property used in CollectionDefinition to specify the Script to be executed during AddMemberToCollection.
`MEMBER_REMOVE_SCRIPT` String property used in CollectionDefinition to specify the Script to be executed during RemoveSlotFromCollection.
`MEMBER_UPDATE_SCRIPT` String property.
`NAME` String property.
`OBJECT_TYPE` String property.
`OUTCOME_INIT` String property to hold the name of the OutcomeInititator to be used by the Job associated with Activities.
`PAIRING_ID` String property.
`PROPERTY_DEF_NAME` String property.
`PROPERTY_DEF_VERSION` Integer property.
`QUERY_NAME` String property.
`QUERY_VERSION` Integer property to hold the version of the Script associated with Activities.
`REPEAT_WHEN` Boolean property.
`ROUTING_EXPR` String property.
`ROUTING_SCRIPT_NAME` String property to hold either the name of the Script or the UUID of the Schema Item associated with Splits.
`ROUTING_SCRIPT_VERSION` Integer property to hold the version of the Schema associated with Splits.
`SCHEMA_NAME` String property.
`SCHEMA_VERSION` Integer property to hold the version of the Schema associated with Activities.
`SCRIPT_NAME` String property.
`SCRIPT_VERSION` Integer property to hold the version of the Script associated with Activities.
`SECURITY_ACTION` It is used during the permission checks based on Shiro WildcardPermission.
`SIMPLE_ELECTRONIC_SIGNATURE`
`STATE_MACHINE_NAME` String property to hold either the name of the StateMachine or the UUID of the StateMachine Item associated with Activities.
`STATE_MACHINE_VERSION` Integer property to hold the version of the StateMachine associated with Activities.
`TYPE` String property.
`VERSION` Integer property.
`VIEW_NAME` String property used in Script CreateNewNumberedVersionFromLast and SetLastNumberedVersionFromLast to specify `org.cristalise.kernel.persistency.outcome.Viewpoint#setSchemaName(String)`.
`VIEW_POINT` String property used to specify `Viewpoint.setName(String)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()`
`static BuiltInVertexProperties`	`getValue(String propName)`
`String`	`toString()`
`static BuiltInVertexProperties`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BuiltInVertexProperties[]`	`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
  - ABORTABLE
```
public static final BuiltInVertexProperties ABORTABLE
```
    Boolean property. Makes CompositeActitivy abortable, i.e. it can be finished even if it has active children.
  - ACTIVITY_DEF_NAME
```
public static final BuiltInVertexProperties ACTIVITY_DEF_NAME
```
  - ACTIVITY_DEF_VERSION
```
public static final BuiltInVertexProperties ACTIVITY_DEF_VERSION
```
  - ACTIVITY_DEF_URN
```
public static final BuiltInVertexProperties ACTIVITY_DEF_URN
```
  - AGENT_NAME
```
public static final BuiltInVertexProperties AGENT_NAME
```
    String property. The name of the Agent associated with Activities. Can be null or undefined.
  - ATTACHMENT_MIME_TYPES
```
public static final BuiltInVertexProperties ATTACHMENT_MIME_TYPES
```
    String property. Contains the comma separated list of mine types. Defined in ActivityDef. Can be null or undefined.
  - DELEGATE_NAME
```
public static final BuiltInVertexProperties DELEGATE_NAME
```
    String property. The name of the Delegate Agent associated with Activities. Can be null or undefined.
  - AGENT_ROLE
```
public static final BuiltInVertexProperties AGENT_ROLE
```
    Deprecated. use RolePath.setPermissions(java.util.List) instead
    
    String property. The role of the Agent associated with Activities. Can be null or undefined.
  - BREAKPOINT
```
public static final BuiltInVertexProperties BREAKPOINT
```
    Boolean property ...
  - DESCRIPTION
```
public static final BuiltInVertexProperties DESCRIPTION
```
    String property used in ActivityDef to store the description text
  - LAST_NUM
```
public static final BuiltInVertexProperties LAST_NUM
```
    Used in Splits as a counter to provide unique ID for instances of DirectedEdge
  - MEMBER_ADD_SCRIPT
```
public static final BuiltInVertexProperties MEMBER_ADD_SCRIPT
```
    String property used in CollectionDefinition to specify the Script to be executed during AddMemberToCollection. Its primary purpose is to ensure referential integrity. It shall contain the Name or UUID of the Script and the version number separated with colon.
```
 <Dependency name="Employees" isDescription="true">
   <DependencyMember itemPath="/domain/path/EmployeeFactory" />
   <CollectionProperties>
     <KeyValuePair Key="MemberAddScript" String="Department_CheckEmployees:0"/>
   </CollectionProperties>
 </Dependency>
 
```
  - MEMBER_REMOVE_SCRIPT
```
public static final BuiltInVertexProperties MEMBER_REMOVE_SCRIPT
```
    String property used in CollectionDefinition to specify the Script to be executed during RemoveSlotFromCollection. Its primary purpose is to ensure referential integrity. It shall contain the Name or UUID of the Script and the version number separated with colon.
```
 <Dependency name="Employees" isDescription="true">
   <DependencyMember itemPath="/domain/path/EmployeeFactory" />
   <CollectionProperties>
     <KeyValuePair Key="MemberRemoveScript" String="Department_CheckEmployees:0"/>
   </CollectionProperties>
 </Dependency>
 
```
  - MEMBER_UPDATE_SCRIPT
```
public static final BuiltInVertexProperties MEMBER_UPDATE_SCRIPT
```
    String property. Used in CollectionDefinition to specify the Script to be executed during UpdateDependencyMamber. Its primary purpose is to ensure referential integrity. It shall contain the Name or UUID of the Script and the version number separated with colon.
```
 <Dependency name="Employees" isDescription="true">
   <DependencyMember itemPath="/domain/path/EmployeeFactory" />
   <CollectionProperties>
     <KeyValuePair Key="MemberUpdateScript" String="Department_CheckEmployees:0"/>
   </CollectionProperties>
 </Dependency>
 
```
  - NAME
```
public static final BuiltInVertexProperties NAME
```
    String property. It is used in ActivitySlotDef to override the name of the ActivityDef
  - OBJECT_TYPE
```
public static final BuiltInVertexProperties OBJECT_TYPE
```
    String property. The type of object the Activity is going to create. Values are Schema, Script, StateMachine and Query. Used in script DescriptionCollectionSetter. Can be null or undefined.
  - OUTCOME_INIT
```
public static final BuiltInVertexProperties OUTCOME_INIT
```
    String property to hold the name of the OutcomeInititator to be used by the Job associated with Activities. The name is used to find the class name defined in the Config section of the module.xml. For example, the OutcomeInitiator named Empty is defined like this:
```
 
 
```
    Can be null or undefined.
  - PAIRING_ID
```
public static final BuiltInVertexProperties PAIRING_ID
```
    String property. It is used to find the Split-Join pairs to calculate if all the branches were finished. Can be null or undefined.
  - PROPERTY_DEF_NAME
```
public static final BuiltInVertexProperties PROPERTY_DEF_NAME
```
    String property. It contains either the name or the UUID of the PropertyDescription Item. Can be null or undefined.
  - PROPERTY_DEF_VERSION
```
public static final BuiltInVertexProperties PROPERTY_DEF_VERSION
```
    Integer property. It contains the version number of PropertyDescription Item. Can be null or undefined.
  - REPEAT_WHEN
```
public static final BuiltInVertexProperties REPEAT_WHEN
```
    Boolean property. Enables the Loop Transition of the CompositeActivity StateMachine
  - ROUTING_EXPR
```
public static final BuiltInVertexProperties ROUTING_EXPR
```
    String property. Routing expression associated with Splits. It is interpreted by the Script class. The content should start with the script engine name followed by the expression separated by a column like this:
```
 javascript: new java.lang.Integer(counter % 2);
 
```
  - ROUTING_SCRIPT_NAME
```
public static final BuiltInVertexProperties ROUTING_SCRIPT_NAME
```
    String property to hold either the name of the Script or the UUID of the Schema Item associated with Splits. If RoutingScriptVersion is null the content if any is interpreted like ROUTING_EXPR. Can be null or undefined.
  - ROUTING_SCRIPT_VERSION
```
public static final BuiltInVertexProperties ROUTING_SCRIPT_VERSION
```
    Integer property to hold the version of the Schema associated with Splits. Can be null or undefined.
  - SCHEMA_NAME
```
public static final BuiltInVertexProperties SCHEMA_NAME
```
    String property. Either the name of the Schema or the UUID of the Schema Item associated with Activities. Can be null or undefined.
  - SCHEMA_VERSION
```
public static final BuiltInVertexProperties SCHEMA_VERSION
```
    Integer property to hold the version of the Schema associated with Activities. Can be null or undefined.
  - SCRIPT_NAME
```
public static final BuiltInVertexProperties SCRIPT_NAME
```
    String property. Either the name of the Schema or the UUID of the Schema Item associated with Activities. Can be null or undefined.
  - SCRIPT_VERSION
```
public static final BuiltInVertexProperties SCRIPT_VERSION
```
    Integer property to hold the version of the Script associated with Activities. Can be null or undefined.
  - SECURITY_ACTION
```
public static final BuiltInVertexProperties SECURITY_ACTION
```
    It is used during the permission checks based on Shiro WildcardPermission. If not blank it replaces the name of the Activity used for the 'actions' section in the constructed permission string. Can be null or undefined.
  - SIMPLE_ELECTRONIC_SIGNATURE
```
public static final BuiltInVertexProperties SIMPLE_ELECTRONIC_SIGNATURE
```
  - QUERY_NAME
```
public static final BuiltInVertexProperties QUERY_NAME
```
    String property. Either the name of the Schema or the UUID of the Schema Item associated with Activities. Can be null or undefined.
  - QUERY_VERSION
```
public static final BuiltInVertexProperties QUERY_VERSION
```
    Integer property to hold the version of the Script associated with Activities. Can be null or undefined.
  - STATE_MACHINE_NAME
```
public static final BuiltInVertexProperties STATE_MACHINE_NAME
```
    String property to hold either the name of the StateMachine or the UUID of the StateMachine Item associated with Activities. Can be null or undefined. The default StateMachine is called Default Can be null or undefined.
  - STATE_MACHINE_VERSION
```
public static final BuiltInVertexProperties STATE_MACHINE_VERSION
```
    Integer property to hold the version of the StateMachine associated with Activities. Can be null or undefined.
  - TYPE
```
public static final BuiltInVertexProperties TYPE
```
    String property. It is used in Join and JoinDef to to specify if the join is a route or not Can be null or undefined.
  - VERSION
```
public static final BuiltInVertexProperties VERSION
```
    Integer property. It is used in CollectionMember to store the version of DescriptionDependency
  - VIEW_NAME
```
public static final BuiltInVertexProperties VIEW_NAME
```
    String property used in Script CreateNewNumberedVersionFromLast and SetLastNumberedVersionFromLast to specify org.cristalise.kernel.persistency.outcome.Viewpoint#setSchemaName(String).
  - VIEW_POINT
```
public static final BuiltInVertexProperties VIEW_POINT
```
    String property used to specify Viewpoint.setName(String).
- Method Detail
  - values
```
public static BuiltInVertexProperties[] 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 (BuiltInVertexProperties c : BuiltInVertexProperties.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BuiltInVertexProperties 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()
```
    Returns:
    
    kernel defined string value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<BuiltInVertexProperties>
  - getValue
```
public static BuiltInVertexProperties getValue(String propName)
```

Enum BuiltInVertexProperties

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ABORTABLE

ACTIVITY_DEF_NAME

ACTIVITY_DEF_VERSION

ACTIVITY_DEF_URN

AGENT_NAME

ATTACHMENT_MIME_TYPES

DELEGATE_NAME

AGENT_ROLE

BREAKPOINT

DESCRIPTION

LAST_NUM

MEMBER_ADD_SCRIPT

MEMBER_REMOVE_SCRIPT

MEMBER_UPDATE_SCRIPT

NAME

OBJECT_TYPE

OUTCOME_INIT

PAIRING_ID

PROPERTY_DEF_NAME

PROPERTY_DEF_VERSION

REPEAT_WHEN

ROUTING_EXPR

ROUTING_SCRIPT_NAME

ROUTING_SCRIPT_VERSION

SCHEMA_NAME

SCHEMA_VERSION

SCRIPT_NAME

SCRIPT_VERSION

SECURITY_ACTION

SIMPLE_ELECTRONIC_SIGNATURE

QUERY_NAME

QUERY_VERSION

STATE_MACHINE_NAME

STATE_MACHINE_VERSION

TYPE

VERSION

VIEW_NAME

VIEW_POINT

Method Detail

values

valueOf

getName

toString

getValue