EntityType (AristaFlow Business Process Platform API)

java.lang.Object
- java.lang.Enum<EntityType>
- - de.aristaflow.adept2.model.orgmodel.EntityType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EntityType>
```
public enum EntityType
extends java.lang.Enum<EntityType>
```
This enumeration lists the all entity types that are defined in the Organisational Meta Model. All their attribute names are case insensitive. To retrieve an entity type's identifier as it can be used in OrgPolicies, use the policyToken()-method.

Author:

Patrick Schmidt

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABILITY` Refers to the Ability entity type
`AGENT` Refers to the Agent entity type
`ORG_GROUP` Refers to the OrgGroup entity type
`ORG_POSITION` Refers to the OrgPosition entity type
`ORG_UNIT` Refers to the OrgUnit entity type
`PROJECT_GROUP` Refers to the ProjectGroup entity type
`ROLE` Refers to the Role entity type
`SUBSTITUTION_RULE` Refers to the SubstitutionRole entity type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EntityType`	`fromIdentifierID(java.util.UUID identifierID)` Returns the `EntityType` for a given identifier ID or `null` if the identifier ID is not recognised.
`static EntityType`	`fromPolicyToken(java.lang.String policyToken)` Returns the `EntityType` for a given policy token or `null` if the policy token is not recognised.
`java.lang.String[]`	`getMandatoryAttributes()` Returns the list of mandatory attributes of this entity type.
`NavFunction`	`getNavFunction(java.lang.String funcName)` Returns the function for this entity type with the given name; or `null` if it doesn't exist.
`NavFunction[]`	`getNavFunctions()` Returns all functions that are defined for this entity type.
`boolean`	`hasHiddenAttribute(java.lang.String attrName)` Gets whether this entity type has a hidden attribute corresponding to the designated one.
`boolean`	`hasMandatoryAttribute(java.lang.String attrName)` Returns whether this entity type has the given mandatory attribute.
`boolean`	`hasNavFunction(java.lang.String funcName)` Returns whether the function with the given name is defined for this entity type.
`boolean`	`hasReadOnlyAttribute(java.lang.String attrName)` Returns whether the specified mandatory (!)
`java.util.UUID`	`identifierID()` Returns the UUID semantically identifying this entity type.
`java.lang.String`	`policyToken()` Returns a policy token for this EntityType that can be used in OrgPolicies (see page 68 in [Berr05]).
`java.lang.String`	`toString()` Returns a string that can be used for display purposes.
`static EntityType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EntityType[]`	`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
  - AGENT
```
public static final EntityType AGENT
```
    Refers to the Agent entity type
  - ORG_POSITION
```
public static final EntityType ORG_POSITION
```
    Refers to the OrgPosition entity type
  - ORG_UNIT
```
public static final EntityType ORG_UNIT
```
    Refers to the OrgUnit entity type
  - ORG_GROUP
```
public static final EntityType ORG_GROUP
```
    Refers to the OrgGroup entity type
  - PROJECT_GROUP
```
public static final EntityType PROJECT_GROUP
```
    Refers to the ProjectGroup entity type
  - ABILITY
```
public static final EntityType ABILITY
```
    Refers to the Ability entity type
  - ROLE
```
public static final EntityType ROLE
```
    Refers to the Role entity type
  - SUBSTITUTION_RULE
```
public static final EntityType SUBSTITUTION_RULE
```
    Refers to the SubstitutionRole entity type
- Method Detail
  - values
```
public static EntityType[] 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 (EntityType c : EntityType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EntityType valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - policyToken
```
public java.lang.String policyToken()
```
    Returns a policy token for this EntityType that can be used in OrgPolicies (see page 68 in [Berr05]). E.g. Agent for AGENT or OrgPosition for ORG_POSITION.
    
    Returns:
    
    a policy token for this entity type
  - identifierID
```
public java.util.UUID identifierID()
```
    Returns the UUID semantically identifying this entity type.
    
    Returns:
    
    the UUID semantically identifying this entity type
  - getMandatoryAttributes
```
public java.lang.String[] getMandatoryAttributes()
```
    Returns the list of mandatory attributes of this entity type.
    
    Returns:
    
    the list of mandatory attributes of this entity type
  - hasMandatoryAttribute
```
public boolean hasMandatoryAttribute(java.lang.String attrName)
```
    Returns whether this entity type has the given mandatory attribute.
    
    Parameters:
    
    attrName - the attribute to be checked
    
    Returns:
    
    whether this entity type has the given mandatory attribute
  - hasReadOnlyAttribute
```
public boolean hasReadOnlyAttribute(java.lang.String attrName)
```
    Returns whether the specified mandatory (!) attribute is read-only. All ids and id references are read-only. When an attribute is read-only it means that it can't be set directly using ModelChangeOperations.updateEntity(de.aristaflow.adept2.base.sessionmanagement.SessionToken, Entity).
    Note: This method does and can not provide any information about user-defined attributes, only mandatory ones.
    
    Parameters:
    
    attrName - the mandatory attribute to be checked
    
    Returns:
    
    whether the given attribute is read-only
  - hasHiddenAttribute
```
public boolean hasHiddenAttribute(java.lang.String attrName)
```
    Gets whether this entity type has a hidden attribute corresponding to the designated one.
    
    Parameters:
    
    attrName - The attribute to be checked.
    
    Returns:
    
    Whether this entity type has a hidden attribute corresponding to the designated one.
  - hasNavFunction
```
public boolean hasNavFunction(java.lang.String funcName)
```
    Returns whether the function with the given name is defined for this entity type.
    The function name must NOT include the + which is optional for some functions.
    
    Parameters:
    
    funcName - the name of the function to be found
    
    Returns:
    
    whether the function with the given name is defined for this entity type
  - getNavFunction
```
public NavFunction getNavFunction(java.lang.String funcName)
```
    Returns the function for this entity type with the given name; or null if it doesn't exist.
    The function name must NOT include the + which is optional for some functions.
    
    Parameters:
    
    funcName - the name of the function to be found
    
    Returns:
    
    the function for this entity type with the given name; or null if it doesn't exist
  - getNavFunctions
```
public NavFunction[] getNavFunctions()
```
    Returns all functions that are defined for this entity type.
    
    Returns:
    
    all functions that are defined for this entity type
  - toString
```
public java.lang.String toString()
```
    Returns a string that can be used for display purposes.
    
    Overrides:
    
    toString in class java.lang.Enum<EntityType>
  - fromPolicyToken
```
public static EntityType fromPolicyToken(java.lang.String policyToken)
```
    Returns the EntityType for a given policy token or null if the policy token is not recognised.
    
    Parameters:
    
    policyToken - the policy token for which the appropriate EntityType should be returned
    
    Returns:
    
    the EntityType for the given policy token or null if the policy token is not recognised
  - fromIdentifierID
```
public static EntityType fromIdentifierID(java.util.UUID identifierID)
```
    Returns the EntityType for a given identifier ID or null if the identifier ID is not recognised.
    
    Parameters:
    
    identifierID - the identifier ID for which the appropriate EntityType should be returned
    
    Returns:
    
    the EntityType for the given identifier ID or null if the identifier ID is not recognised

Enum EntityType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AGENT

ORG_POSITION

ORG_UNIT

ORG_GROUP

PROJECT_GROUP

ABILITY

ROLE

SUBSTITUTION_RULE

Method Detail

values

valueOf

policyToken

identifierID

getMandatoryAttributes

hasMandatoryAttribute

hasReadOnlyAttribute

hasHiddenAttribute

hasNavFunction

getNavFunction

getNavFunctions

toString

fromPolicyToken

fromIdentifierID