Enum Class ClassificationPropagationRule
java.lang.Object
java.lang.Enum<ClassificationPropagationRule>
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.ClassificationPropagationRule
- All Implemented Interfaces:
Serializable
,Comparable<ClassificationPropagationRule>
,Constable
public enum ClassificationPropagationRule
extends Enum<ClassificationPropagationRule>
implements Serializable
ClassificationPropagationRule is part of a relationship definition (RelationshipDef).
It indicates whether classifications from one entity should propagate across a relationship instance.
It allows classification for, say confidentiality to be propagated to related entities.
The propagation rule defines the direction of propagation:
- NONE: no propagation of classifications across the relationship.
- ONE_TO_TWO: from entity at end 1 of the relationship to the entity at end 2 of the relationship.
- TWO_TO_ONE: from entity at end 2 of the relationship to the entity at end 1 of the relationship.
- BOTH: two way propagation.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionClassification propagation in both directions.No classification propagation.Classification propagation direction is one way from entity one to entity two.Classification propagation direction is one way from entity two to entity one. -
Method Summary
Modifier and TypeMethodDescriptionReturn the default description of the propagation rule.getName()
Return the default name of the propagation rule.int
Return the numeric representation of the propagation rule.toString()
toString() JSON-styleReturns the enum constant of this class with the specified name.static ClassificationPropagationRule[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
No classification propagation. -
ONE_TO_TWO
Classification propagation direction is one way from entity one to entity two. -
TWO_TO_ONE
Classification propagation direction is one way from entity two to entity one. -
BOTH
Classification propagation in both directions.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOrdinal
public int getOrdinal()Return the numeric representation of the propagation rule.- Returns:
- int ordinal
-
getName
Return the default name of the propagation rule.- Returns:
- String name
-
getDescription
Return the default description of the propagation rule.- Returns:
- String description
-
toString
toString() JSON-style- Overrides:
toString
in classEnum<ClassificationPropagationRule>
- Returns:
- string description
-