Package com.senzing.sdk

Enum Class SzFlagUsageGroup

java.lang.Object
java.lang.Enum<SzFlagUsageGroup>
com.senzing.sdk.SzFlagUsageGroup
All Implemented Interfaces:
Serializable, Comparable<SzFlagUsageGroup>, Constable
public enum SzFlagUsageGroup extends Enum<SzFlagUsageGroup>
Enumerates the various classifications of usage groups for the SzFlag instances.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    SZ_ENTITY
    Flags in this usage group can be used for operations that retrieve entity data in order to control the level of detail of the returned entity.
    SZ_EXPORT
    Flags in this usage group can be used for operations that export entities to control how the entities are qualified for inclusion in the export and the level of detail for the entities returned in the search results.
    SZ_FIND_NETWORK
    Flags in this usage group can be used to control the methodology for finding an entity network, what details to include for the entity network and the level of detail for the entities in the network that are returned.
    SZ_FIND_PATH
    Flags in this usage group can be used to control the methodology for finding an entity path, what details to include for the entity path and the level of detail for the entities on the path that are returned.
    SZ_HOW
    Flags in this usage group can be used to control the methodology for performing "how analysis", what details to include for the analysis and the level of detail for the entities in the network that are returned.
    SZ_MODIFY
    Flags in this usage group can be used for operations that modify the entity repository by adding records, revaluating records or entities, deleting records or any similar operations.
    SZ_RECORD
    Flags in this usage group can be used for operations that retrieve record data in order to control the level of detail of the returned record.
    SZ_SEARCH
    Flags in this usage group can be used for operations that search for entities to control how the entities are qualified for inclusion in the search results and the level of detail for the entities returned in the search results.
    SZ_VIRTUAL_ENTITY
    Flags in this usage group can be used for operations that retrieve virtual entities in order to control the level of detail of the returned virtual entity.
    SZ_WHY
    Flags in this usage group can be used to control the methodology for performing "why analysis", what details to include for the analysis and the level of detail for the entities in the network that are returned.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<SzFlag>
    getFlags()
    Gets the EnumSet of SzFlag instances that have this SzFlagUsageGroup.
    String
    toString(long flagsValue)
    Returns the String representation of the specified long flags value according to the SzFlag instances included for this SzFlagUsageGroup.
    static SzFlagUsageGroup
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SzFlagUsageGroup[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait