RelationType (AristaFlow Business Process Platform API)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RelationType>
```
public enum RelationType
extends java.lang.Enum<RelationType>
```
This enumeration list all defined relations between EntityTypes that are defined in [Berr05]. For more information about each relation see [Berr05].
There's one slight difference thought: The relation type ProjectInvolvement (which was a relation between Project and either OrgPosition or OrgUnit) has been split into the two relation types ProjectInvolvementOrgPosition and ProjectInvolvementOrgUnit. This has been done in order to avoid the use of the discriminant/discrimination which would also appear in the interface and unnecessarily complicate things.
Each RelationType involves two EntityTypes. The first one (leftHandEntityType()) is always the more general one (e.g. ROLE_SPECIALISATION), the one that groups/combines the second one (e.g. ORG_GROUP_INVOLVEMENT and all other 1:n relations) or the one that is a superior/manager to the second one.
The same order is used in ModelChangeOperations.addRelation(de.aristaflow.adept2.base.sessionmanagement.SessionToken, RelationType, long, long) and ModelChangeOperations.deleteRelation(de.aristaflow.adept2.base.sessionmanagement.SessionToken, RelationType, long, long).
See the individual relation types for more information about their kind (1:m or n:m) and the required order.

Author:

Patrick Schmidt

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGENT_ABILITY` refers to AgentAbility, an n:m relation type between Agent and Ability
`ORG_GROUP_INVOLVEMENT` refers to OrgGroupInvolvement, an n:m relation type between OrgGroup and (the involved) OrgUnit
`ORG_GROUP_MANAGEMENT` refers to OrgGroupManagement, a 1:m relation type between (the managing) OrgPosition and OrgGroup; the reference attribute: OrgGroup.managerId
`ORG_POSITION_AFFILIATION` refers to OrgPositionAffiliation, a 1:m relation type between OrgUnit and OrgPosition; the reference attribute: OrgPosition.orgUnitId
`ORG_POSITION_DESCRIPTION` refers to OrgPositionDescription, an n:m relation type between OrgPosition and Role
`ORG_POSITION_OCCUPATION` refers to OrgPositionOccupation, an n:m relation type between OrgPosition and Agent
`ORG_POSITION_SUBSTITUTE` refers to OrgPositionSubstitute, a 1:m relation type between OrgPosition (to substitute the other one) and SubstitutionRule; the reference attribute: SubstitutionRule.substituteId
`ORG_POSITION_SUBSTITUTION` refers to OrgPositionSubstitution, a 1:m relation type between OrgPosition and SubstitutionRule; the reference attribute: SubstitutionRule.orgPositionId
`ORG_UNIT_MANAGEMENT` refers to OrgUnitManagement, a 1:m relation type between (the managing) OrgPosition and OrgUnit; the reference attribute: OrgUnit.managerId
`ORG_UNIT_SUBORDINATION` refers to OrgUnitSubordination, a 1:m relation type between OrgUnit and (the subordinate) OrgUnit; the reference attribute: OrgUnit.supId
`PROJECT_GROUP_MANAGEMENT` refers to ProjectGroupManagement, a 1:m relation type between (the managing) OrgPosition and ProjectGroup; the reference attribute: ProjectGroup.managerId
`PROJECT_GROUP_SUBORDINATION` refers to ProjectGroupSubordination, a 1:m relation type between ProjectGroup and (the subordinate) ProjectGroup; the reference attribute: ProjectGroup.supId
`PROJECT_INVOLVEMENT_ORG_POSITION` refers to ProjectInvolvementOrgPosition, an n:m relation type between ProjectGroup and (the involved) OrgPosition
`PROJECT_INVOLVEMENT_ORG_UNIT` refers to ProjectInvolvementOrgUnit, an n:m relation type between ProjectGroup and (the involved) OrgUnit
`ROLE_DESCRIPTION` refers to RoleDescription, an n:m relation type between Role and Ability
`ROLE_SPECIALISATION` refers to RoleSpecialisation, a 1:m relation type between (the more generic) Role and (the specialised) Role; the reference attribute: Role.supId
`ROLE_SUBSTITUTION` refers to RoleSubstitution, a 1:m relation type between Role and SubstitutionRule; the reference attribute: SubstitutionRule.roleId

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isNMRelation()` Returns whether this is an n:m relation type (and not a 1:m relation type).
`boolean`	`isRecursive()` Returns whether a `RelationType` is recursive, i.e. connects an `EntityType` with itself.
`EntityType`	`leftHandEntityType()` Returns the first (left-hand) entity type in this relation type.
`java.lang.String`	`oneToMReferenceAttribute()` If this is a 1:m relation type, this method will return the attribute name in the right-hand entity type that references an entity of the left-hand entity type.
`EntityType`	`rightHandEntityType()` Returns the second (right-hand) entity type in this relation type.
`static RelationType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static RelationType[]`	`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, toString, valueOf

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

- Enum Constant Detail
  - ORG_POSITION_OCCUPATION
```
public static final RelationType ORG_POSITION_OCCUPATION
```
    refers to OrgPositionOccupation, an n:m relation type between OrgPosition and Agent
  - ORG_POSITION_DESCRIPTION
```
public static final RelationType ORG_POSITION_DESCRIPTION
```
    refers to OrgPositionDescription, an n:m relation type between OrgPosition and Role
  - ORG_POSITION_AFFILIATION
```
public static final RelationType ORG_POSITION_AFFILIATION
```
    refers to OrgPositionAffiliation, a 1:m relation type between OrgUnit and OrgPosition; the reference attribute: OrgPosition.orgUnitId
  - ORG_UNIT_SUBORDINATION
```
public static final RelationType ORG_UNIT_SUBORDINATION
```
    refers to OrgUnitSubordination, a 1:m relation type between OrgUnit and (the subordinate) OrgUnit; the reference attribute: OrgUnit.supId
  - ORG_UNIT_MANAGEMENT
```
public static final RelationType ORG_UNIT_MANAGEMENT
```
    refers to OrgUnitManagement, a 1:m relation type between (the managing) OrgPosition and OrgUnit; the reference attribute: OrgUnit.managerId
  - ORG_GROUP_MANAGEMENT
```
public static final RelationType ORG_GROUP_MANAGEMENT
```
    refers to OrgGroupManagement, a 1:m relation type between (the managing) OrgPosition and OrgGroup; the reference attribute: OrgGroup.managerId
  - ORG_GROUP_INVOLVEMENT
```
public static final RelationType ORG_GROUP_INVOLVEMENT
```
    refers to OrgGroupInvolvement, an n:m relation type between OrgGroup and (the involved) OrgUnit
  - PROJECT_GROUP_SUBORDINATION
```
public static final RelationType PROJECT_GROUP_SUBORDINATION
```
    refers to ProjectGroupSubordination, a 1:m relation type between ProjectGroup and (the subordinate) ProjectGroup; the reference attribute: ProjectGroup.supId
  - PROJECT_GROUP_MANAGEMENT
```
public static final RelationType PROJECT_GROUP_MANAGEMENT
```
    refers to ProjectGroupManagement, a 1:m relation type between (the managing) OrgPosition and ProjectGroup; the reference attribute: ProjectGroup.managerId
  - PROJECT_INVOLVEMENT_ORG_POSITION
```
public static final RelationType PROJECT_INVOLVEMENT_ORG_POSITION
```
    refers to ProjectInvolvementOrgPosition, an n:m relation type between ProjectGroup and (the involved) OrgPosition
  - PROJECT_INVOLVEMENT_ORG_UNIT
```
public static final RelationType PROJECT_INVOLVEMENT_ORG_UNIT
```
    refers to ProjectInvolvementOrgUnit, an n:m relation type between ProjectGroup and (the involved) OrgUnit
  - AGENT_ABILITY
```
public static final RelationType AGENT_ABILITY
```
    refers to AgentAbility, an n:m relation type between Agent and Ability
  - ROLE_DESCRIPTION
```
public static final RelationType ROLE_DESCRIPTION
```
    refers to RoleDescription, an n:m relation type between Role and Ability
  - ROLE_SPECIALISATION
```
public static final RelationType ROLE_SPECIALISATION
```
    refers to RoleSpecialisation, a 1:m relation type between (the more generic) Role and (the specialised) Role; the reference attribute: Role.supId
  - ORG_POSITION_SUBSTITUTION
```
public static final RelationType ORG_POSITION_SUBSTITUTION
```
    refers to OrgPositionSubstitution, a 1:m relation type between OrgPosition and SubstitutionRule; the reference attribute: SubstitutionRule.orgPositionId
  - ORG_POSITION_SUBSTITUTE
```
public static final RelationType ORG_POSITION_SUBSTITUTE
```
    refers to OrgPositionSubstitute, a 1:m relation type between OrgPosition (to substitute the other one) and SubstitutionRule; the reference attribute: SubstitutionRule.substituteId
  - ROLE_SUBSTITUTION
```
public static final RelationType ROLE_SUBSTITUTION
```
    refers to RoleSubstitution, a 1:m relation type between Role and SubstitutionRule; the reference attribute: SubstitutionRule.roleId
- Method Detail
  - values
```
public static RelationType[] 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 (RelationType c : RelationType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RelationType 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
  - leftHandEntityType
```
public EntityType leftHandEntityType()
```
    Returns the first (left-hand) entity type in this relation type.
    
    Returns:
    
    the first (left-hand) entity type in this relation type
  - rightHandEntityType
```
public EntityType rightHandEntityType()
```
    Returns the second (right-hand) entity type in this relation type.
    
    Returns:
    
    the second (right-hand) entity type in this relation type
  - isNMRelation
```
public boolean isNMRelation()
```
    Returns whether this is an n:m relation type (and not a 1:m relation type).
    
    Returns:
    
    whether this is an n:m relation type
  - oneToMReferenceAttribute
```
public java.lang.String oneToMReferenceAttribute()
```
    If this is a 1:m relation type, this method will return the attribute name in the right-hand entity type that references an entity of the left-hand entity type. If this isn't a 1:m relation type (but n:m, see isNMRelation()) this method will throw an IllegalStateException.
    
    Returns:
    
    the attribute name in the right-hand entity type that references an entity of the left-hand entity type
  - isRecursive
```
public boolean isRecursive()
```
    Returns whether a RelationType is recursive, i.e. connects an EntityType with itself.
    
    Returns:
    
    whether a RelationType is recursive

Enum RelationType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ORG_POSITION_OCCUPATION

ORG_POSITION_DESCRIPTION

ORG_POSITION_AFFILIATION

ORG_UNIT_SUBORDINATION

ORG_UNIT_MANAGEMENT

ORG_GROUP_MANAGEMENT

ORG_GROUP_INVOLVEMENT

PROJECT_GROUP_SUBORDINATION

PROJECT_GROUP_MANAGEMENT

PROJECT_INVOLVEMENT_ORG_POSITION

PROJECT_INVOLVEMENT_ORG_UNIT

AGENT_ABILITY

ROLE_DESCRIPTION

ROLE_SPECIALISATION

ORG_POSITION_SUBSTITUTION

ORG_POSITION_SUBSTITUTE

ROLE_SUBSTITUTION

Method Detail

values

valueOf

leftHandEntityType

rightHandEntityType

isNMRelation

oneToMReferenceAttribute

isRecursive