Package com.senzing.sdk

Enum Class SzFlag

java.lang.Object

java.lang.Enum<SzFlag>

com.senzing.sdk.SzFlag

All Implemented Interfaces:

Serializable, Comparable<SzFlag>, Constable

public enum SzFlag
extends Enum<SzFlag>

Enumerates the Senzing flag values from SzFlags so they can be referred to as objects, used in EnumSet instances and coverted to sensible String's with symbolic names and hexadecimal values.

Each SzFlag belongs to one or more SzFlagUsageGroup instances which can be obtained via getGroups(). This helps in identifying which flags are applicable to which functions since a function will document which SzFlagUsageGroup to refer to for applicable flags. Passing an SzFlag to a function to which it does not apply will either have no effect or activate an applicable SzFlag that happens to have the same bitwise value as the non-applicable SzFlag.

See Also:

• https://docs.senzing.com/flags/index.html

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_INCLUDE_ALL_FEATURES	The value for including all features for entities.
SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS	The value for including disclosed relations for entities.
SZ_ENTITY_INCLUDE_ENTITY_NAME	The value for including the name of the entity.
SZ_ENTITY_INCLUDE_FEATURE_STATS	The value for including feature statistics in entity output.
SZ_ENTITY_INCLUDE_INTERNAL_FEATURES	The value for including internal features in an entity response or record response.
SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS	The value for including name-only relations for entities.
SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS	The value for including possibly-related relations for entities.
SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS	The value for including possibly-same relations for entities.
SZ_ENTITY_INCLUDE_RECORD_DATA	The value for including the basic record data for the entity.
SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS	The value for including record-level feature details in the record segment of an entity or in a record response.
SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS	The value for including record-level feature statistics in the record segment of an entity or in a record response.
SZ_ENTITY_INCLUDE_RECORD_FEATURES	The value for including features identifiers in the records segment, referencing back to the entity features.
SZ_ENTITY_INCLUDE_RECORD_JSON_DATA	The value for including the record json data for the entity.
SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO	The value for including the record matching info for the entity.
SZ_ENTITY_INCLUDE_RECORD_SUMMARY	The value for including the record summary of the entity.
SZ_ENTITY_INCLUDE_RECORD_TYPES	The value for including the record types of the entity.
SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA	The value for including the record unmapped data for the entity.
SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME	The value for including the name of the related entities.
SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO	The value for including the record matching info of the related entities.
SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA	The value for including the basic record data of the related entities.
SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY	The value for including the record summary of the related entities.
SZ_ENTITY_INCLUDE_RELATED_RECORD_TYPES	The value for including the record types of the related entities.
SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES	The value for including representative features for entities.
SZ_EXPORT_INCLUDE_DISCLOSED	The value for export functionality to indicate that "disclosed" relationships should be included in the export.
SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES	The value for export functionality to indicate "resolved" relationships (i.e.: entities with multiple records) should be included in the export.
SZ_EXPORT_INCLUDE_NAME_ONLY	The value for export functionality to indicate that "name only" relationships should be included in the export.
SZ_EXPORT_INCLUDE_POSSIBLY_RELATED	The value for export functionality to indicate that "possibly related" relationships should be included in the export.
SZ_EXPORT_INCLUDE_POSSIBLY_SAME	The value for export functionality to indicate that "possibly same" relationships should be included in the export.
SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES	The value for export functionality to indicate that single-record entities should be included in the export.
SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO	The value for find-network functionality to include matching info on the entity paths of the network.
SZ_FIND_PATH_INCLUDE_MATCHING_INFO	The value for find-path functionality to include matching info on entity paths.
SZ_FIND_PATH_STRICT_AVOID	The value for find-path functionality to indicate that avoided entities must be strictly avoided even if using an avoided entity would be the only means to find a path between two entities.
SZ_INCLUDE_FEATURE_SCORES	The value for including feature scores.
SZ_INCLUDE_MATCH_KEY_DETAILS	The value for including match key details in addition to the standard match key.
SZ_SEARCH_INCLUDE_ALL_CANDIDATES	The value for search functionality to indicate that search results should not only include those entities that satisfy resolution rule, but also those that present on the candidate list but fail to satisfy a resolution rule.
SZ_SEARCH_INCLUDE_NAME_ONLY	The value for search functionality to indicate that "name only" match level results should be included.
SZ_SEARCH_INCLUDE_POSSIBLY_RELATED	The value for search functionality to indicate that "possibly related" match level results should be included.
SZ_SEARCH_INCLUDE_POSSIBLY_SAME	The value for search functionality to indicate that "possibly same" match level results should be included.
SZ_SEARCH_INCLUDE_REQUEST	The value for search functionality to indicate that the search response should include the basic feature information for the search criteria features.
SZ_SEARCH_INCLUDE_REQUEST_DETAILS	The value for search functionality to indicate that the search response should include detailed feature information for search criteria features (including feature stats and generic status).
SZ_SEARCH_INCLUDE_RESOLVED	The value for search functionality to indicate that "resolved" match level results should be included.
SZ_SEARCH_INCLUDE_STATS	The value for including statistics from search results.
SZ_WITH_INFO	Indicates that the Senzing engine should produce and return the INFO document describing the affected entities from an operation.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<SzFlag>	SZ_ENTITY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_ENTITY_FLAGS usage group.
static final Set<SzFlag>	SZ_ENTITY_BRIEF_DEFAULT_FLAGS	The Set of SzFlag instances representing the default flags for a "brief" level of detail when retrieving entities.
static final Set<SzFlag>	SZ_ENTITY_CORE_FLAGS	The Set of SzFlag instances representing the flags for obtaining the typical basic entity content without any related entity content.
static final Set<SzFlag>	SZ_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances representing the default' level of detail when retrieving entities.
static final Set<SzFlag>	SZ_ENTITY_INCLUDE_ALL_RELATIONS	The unmodifiable Set of SzFlag instances indicating that that entities that are returned should include all relationships regardless of the kind of relationship.
static final Set<SzFlag>	SZ_EXPORT_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_EXPORT_FLAGS usage group.
static final Set<SzFlag>	SZ_EXPORT_DEFAULT_FLAGS	The Set of SzFlag instances representing the default flags for exporting entities.
static final Set<SzFlag>	SZ_EXPORT_INCLUDE_ALL_ENTITIES	The unmodifiable Set of SzFlag instances indicating that an export should include all entities in the export.
static final Set<SzFlag>	SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS	The Set of SzFlag instances indicating that an export should include all entities having a relationships of any kind.
static final Set<SzFlag>	SZ_FIND_NETWORK_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS usage group.
static final Set<SzFlag>	SZ_FIND_NETWORK_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "find network" operations.
static final Set<SzFlag>	SZ_FIND_PATH_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_FIND_PATH_FLAGS usage group.
static final Set<SzFlag>	SZ_FIND_PATH_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "find path" operations.
static final Set<SzFlag>	SZ_HOW_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_HOW_FLAGS usage group.
static final Set<SzFlag>	SZ_HOW_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "how entity" operations that analyze how an entity was formed.
static final Set<SzFlag>	SZ_MODIFY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_MODIFY_FLAGS usage group.
static final Set<SzFlag>	SZ_NO_FLAGS	An unmodifiable Set of SzFlag instances containing NO flags (an empty set).
static final Set<SzFlag>	SZ_RECORD_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_RECORD_FLAGS usage group.
static final Set<SzFlag>	SZ_RECORD_DEFAULT_FLAGS	The Set of SzFlag instances representing the default level of detail when retrieving records.
static final Set<SzFlag>	SZ_SEARCH_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.
static final Set<SzFlag>	SZ_SEARCH_BY_ATTRIBUTES_ALL	The Set of SzFlag instances indicating that search results should include all matching entities regardless of match level.
static final Set<SzFlag>	SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS	The Set of SzFlag instances that are a good default for searching by attributes and returning basic entity data.
static final Set<SzFlag>	SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL	The Set of SzFlag instances indicating that search results should include all matching entities regardless of match level while returning minimal data for those matching entities.
static final Set<SzFlag>	SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG	The Set of SzFlag instances indicating that search results should only include strongly matching entities while returning minimal data for those matching entities.
static final Set<SzFlag>	SZ_SEARCH_BY_ATTRIBUTES_STRONG	The Set of SzFlag instances indicating that search results should only include strongly matching entities.
static final Set<SzFlag>	SZ_SEARCH_INCLUDE_ALL_ENTITIES	The Set of SzFlag instances indicating that search results should include entities that are related to the search attributes at any match level.
static final Set<SzFlag>	SZ_VIRTUAL_ENTITY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS usage group.
static final Set<SzFlag>	SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults when retrieving virtual entities.
static final Set<SzFlag>	SZ_WHY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_WHY_FLAGS usage group.
static final Set<SzFlag>	SZ_WHY_ENTITIES_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "why entities" operations.
static final Set<SzFlag>	SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "why record in entity" operations.
static final Set<SzFlag>	SZ_WHY_RECORDS_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "why records" operations.
static final Set<SzFlag>	SZ_WITH_INFO_FLAGS	The unmodifiable Set of SzFlag instances containing the SzFlag instances to use when a repository-modifying operation is being invoked and the desired repsonse should contain an "INFO" message describing how the repository was affected as a result of the operation.

Method Summary

Modifier and Type	Method	Description
Set<SzFlagUsageGroup>	getGroups()	Gets the unmodifiable Set of SzFlagUsageGroup instances describing which usage groups that this SzFlag belongs to.
static EnumSet<SzFlag>	intersect(Set<SzFlag> set1, Set<SzFlag> set2)	Creates a new EnumSet of SzFlag instances that represents the intersection between the two specified sets of SzFlag instances.
static boolean	intersects(Set<SzFlag> set1, Set<SzFlag> set2)	Checks if any intersection exists between two sets of SzFlag instances.
long	toLong()	Converts this instance to its 64-bit long integer equivalent representing the bitwise flags.
static long	toLong(Set<SzFlag> set)	Converts the specified EnumSet to its 64-bit long integer equivalent representing the bitwise flags.
static String	toString(Set<SzFlag> flagSet)	Returns the String representation describing the SzFlag instances in the specified Set.
static EnumSet<SzFlag>	union(Set<SzFlag> set1, Set<SzFlag> set2)	Creates a new EnumSet of SzFlag instances that represents the union between the two specified sets of SzFlag instances.
static SzFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SzFlag[]	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

Enum Constant Details

SZ_WITH_INFO

public static final SzFlag SZ_WITH_INFO

Indicates that the Senzing engine should produce and return the INFO document describing the affected entities from an operation.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_MODIFY_FLAGS

SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES

public static final SzFlag SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES

The value for export functionality to indicate "resolved" relationships (i.e.: entities with multiple records) should be included in the export.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_EXPORT_INCLUDE_POSSIBLY_SAME

public static final SzFlag SZ_EXPORT_INCLUDE_POSSIBLY_SAME

The value for export functionality to indicate that "possibly same" relationships should be included in the export.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_EXPORT_INCLUDE_POSSIBLY_RELATED

public static final SzFlag SZ_EXPORT_INCLUDE_POSSIBLY_RELATED

The value for export functionality to indicate that "possibly related" relationships should be included in the export.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_EXPORT_INCLUDE_NAME_ONLY

public static final SzFlag SZ_EXPORT_INCLUDE_NAME_ONLY

The value for export functionality to indicate that "name only" relationships should be included in the export.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_EXPORT_INCLUDE_DISCLOSED

public static final SzFlag SZ_EXPORT_INCLUDE_DISCLOSED

The value for export functionality to indicate that "disclosed" relationships should be included in the export.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES

public static final SzFlag SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES

The value for export functionality to indicate that single-record entities should be included in the export.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS

public static final SzFlag SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS

The value for including possibly-same relations for entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS

public static final SzFlag SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS

The value for including possibly-related relations for entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS

public static final SzFlag SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS

The value for including name-only relations for entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS

public static final SzFlag SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS

The value for including disclosed relations for entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_ALL_FEATURES

public static final SzFlag SZ_ENTITY_INCLUDE_ALL_FEATURES

The value for including all features for entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES

public static final SzFlag SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES

The value for including representative features for entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_ENTITY_NAME

public static final SzFlag SZ_ENTITY_INCLUDE_ENTITY_NAME

The value for including the name of the entity.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_SUMMARY

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_SUMMARY

The value for including the record summary of the entity.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_TYPES

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_TYPES

The value for including the record types of the entity.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_DATA

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_DATA

The value for including the basic record data for the entity.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO

The value for including the record matching info for the entity.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_JSON_DATA

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_JSON_DATA

The value for including the record json data for the entity.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA

The value for including the record unmapped data for the entity.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_FEATURES

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_FEATURES

The value for including features identifiers in the records segment, referencing back to the entity features.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS

The value for including record-level feature details in the record segment of an entity or in a record response. This is affected by SZ_ENTITY_INCLUDE_INTERNAL_FEATURES.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS

public static final SzFlag SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS

The value for including record-level feature statistics in the record segment of an entity or in a record response. This is affected by SZ_ENTITY_INCLUDE_INTERNAL_FEATURES.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME

public static final SzFlag SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME

The value for including the name of the related entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO

public static final SzFlag SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO

The value for including the record matching info of the related entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY

public static final SzFlag SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY

The value for including the record summary of the related entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RELATED_RECORD_TYPES

public static final SzFlag SZ_ENTITY_INCLUDE_RELATED_RECORD_TYPES

The value for including the record types of the related entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA

public static final SzFlag SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA

The value for including the basic record data of the related entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_INTERNAL_FEATURES

public static final SzFlag SZ_ENTITY_INCLUDE_INTERNAL_FEATURES

The value for including internal features in an entity response or record response.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_FEATURE_STATS

public static final SzFlag SZ_ENTITY_INCLUDE_FEATURE_STATS

The value for including feature statistics in entity output.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_INCLUDE_MATCH_KEY_DETAILS

public static final SzFlag SZ_INCLUDE_MATCH_KEY_DETAILS

The value for including match key details in addition to the standard match key.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_HOW_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_FIND_PATH_STRICT_AVOID

public static final SzFlag SZ_FIND_PATH_STRICT_AVOID

The value for find-path functionality to indicate that avoided entities must be strictly avoided even if using an avoided entity would be the only means to find a path between two entities.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_FIND_PATH_INCLUDE_MATCHING_INFO

public static final SzFlag SZ_FIND_PATH_INCLUDE_MATCHING_INFO

The value for find-path functionality to include matching info on entity paths.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO

public static final SzFlag SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO

The value for find-network functionality to include matching info on the entity paths of the network.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_INCLUDE_FEATURE_SCORES

public static final SzFlag SZ_INCLUDE_FEATURE_SCORES

The value for including feature scores.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_WHY_FLAGS
• SzFlagUsageGroup.SZ_HOW_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_STATS

public static final SzFlag SZ_SEARCH_INCLUDE_STATS

The value for including statistics from search results.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_RESOLVED

public static final SzFlag SZ_SEARCH_INCLUDE_RESOLVED

The value for search functionality to indicate that "resolved" match level results should be included.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_POSSIBLY_SAME

public static final SzFlag SZ_SEARCH_INCLUDE_POSSIBLY_SAME

The value for search functionality to indicate that "possibly same" match level results should be included.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_POSSIBLY_RELATED

public static final SzFlag SZ_SEARCH_INCLUDE_POSSIBLY_RELATED

The value for search functionality to indicate that "possibly related" match level results should be included.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_NAME_ONLY

public static final SzFlag SZ_SEARCH_INCLUDE_NAME_ONLY

The value for search functionality to indicate that "name only" match level results should be included.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_ALL_CANDIDATES

public static final SzFlag SZ_SEARCH_INCLUDE_ALL_CANDIDATES

The value for search functionality to indicate that search results should not only include those entities that satisfy resolution rule, but also those that present on the candidate list but fail to satisfy a resolution rule.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_REQUEST

public static final SzFlag SZ_SEARCH_INCLUDE_REQUEST

The value for search functionality to indicate that the search response should include the basic feature information for the search criteria features.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_REQUEST_DETAILS

public static final SzFlag SZ_SEARCH_INCLUDE_REQUEST_DETAILS

The value for search functionality to indicate that the search response should include detailed feature information for search criteria features (including feature stats and generic status). This flag has no effect unless SZ_SEARCH_INCLUDE_REQUEST is also specified.

This flag belongs to the following usage groups:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

Field Details

SZ_NO_FLAGS

public static final Set<SzFlag> SZ_NO_FLAGS

An unmodifiable Set of SzFlag instances containing NO flags (an empty set).

SZ_MODIFY_ALL_FLAGS

public static final Set<SzFlag> SZ_MODIFY_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_MODIFY_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_MODIFY_FLAGS

SZ_RECORD_ALL_FLAGS

public static final Set<SzFlag> SZ_RECORD_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_RECORD_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_RECORD_FLAGS

SZ_ENTITY_ALL_FLAGS

public static final Set<SzFlag> SZ_ENTITY_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_ENTITY_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS

SZ_FIND_PATH_ALL_FLAGS

public static final Set<SzFlag> SZ_FIND_PATH_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_FIND_PATH_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS

SZ_FIND_NETWORK_ALL_FLAGS

public static final Set<SzFlag> SZ_FIND_NETWORK_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS

SZ_SEARCH_ALL_FLAGS

public static final Set<SzFlag> SZ_SEARCH_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_SEARCH_FLAGS

SZ_EXPORT_ALL_FLAGS

public static final Set<SzFlag> SZ_EXPORT_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_EXPORT_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

SZ_WHY_ALL_FLAGS

public static final Set<SzFlag> SZ_WHY_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_WHY_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_WHY_FLAGS

SZ_HOW_ALL_FLAGS

public static final Set<SzFlag> SZ_HOW_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_HOW_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_HOW_FLAGS

SZ_VIRTUAL_ENTITY_ALL_FLAGS

public static final Set<SzFlag> SZ_VIRTUAL_ENTITY_ALL_FLAGS

The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS usage group.

See Also:

• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

SZ_WITH_INFO_FLAGS

public static final Set<SzFlag> SZ_WITH_INFO_FLAGS

The unmodifiable Set of SzFlag instances containing the SzFlag instances to use when a repository-modifying operation is being invoked and the desired repsonse should contain an "INFO" message describing how the repository was affected as a result of the operation.

The contained SzFlag instances are:

• SZ_WITH_INFO

All the flags in this Set belong to the following usage groups:

• SzFlagUsageGroup.SZ_MODIFY_FLAGS

SZ_EXPORT_INCLUDE_ALL_ENTITIES

public static final Set<SzFlag> SZ_EXPORT_INCLUDE_ALL_ENTITIES

The unmodifiable Set of SzFlag instances indicating that an export should include all entities in the export.

The contained SzFlag instances are:

• SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES
• SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES

All the flags in this Set belong to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS

public static final Set<SzFlag> SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS

The Set of SzFlag instances indicating that an export should include all entities having a relationships of any kind.

The contained SzFlag instances are:

• SZ_EXPORT_INCLUDE_POSSIBLY_SAME
• SZ_EXPORT_INCLUDE_POSSIBLY_RELATED
• SZ_EXPORT_INCLUDE_NAME_ONLY
• SZ_EXPORT_INCLUDE_DISCLOSED

All the flags in this Set belong to the following usage groups:

• SzFlagUsageGroup.SZ_EXPORT_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_INCLUDE_ALL_RELATIONS

public static final Set<SzFlag> SZ_ENTITY_INCLUDE_ALL_RELATIONS

The unmodifiable Set of SzFlag instances indicating that that entities that are returned should include all relationships regardless of the kind of relationship.

The contained SzFlag instances are:

• SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS
• SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS
• SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS
• SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_ENTITY_FLAGS, and by extension belong to the following usage groups which are super sets:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_INCLUDE_ALL_ENTITIES

public static final Set<SzFlag> SZ_SEARCH_INCLUDE_ALL_ENTITIES

The Set of SzFlag instances indicating that search results should include entities that are related to the search attributes at any match level.

The contained SzFlag instances are:

• SZ_SEARCH_INCLUDE_RESOLVED
• SZ_SEARCH_INCLUDE_POSSIBLY_SAME
• SZ_SEARCH_INCLUDE_POSSIBLY_RELATED
• SZ_SEARCH_INCLUDE_NAME_ONLY

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_RECORD_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_RECORD_DEFAULT_FLAGS

The Set of SzFlag instances representing the default level of detail when retrieving records.

The contained SzFlag instances are:

• SZ_ENTITY_INCLUDE_RECORD_JSON_DATA

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_RECORD_FLAGS usage group, and by extension belong to the following groups which are super sets:

• SzFlagUsageGroup.SZ_RECORD_FLAGS
• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_CORE_FLAGS

public static final Set<SzFlag> SZ_ENTITY_CORE_FLAGS

The Set of SzFlag instances representing the flags for obtaining the typical basic entity content without any related entity content. This constant is used in building other Set's of aggregate SzFlag instances, but can be used directly when retrieving entities.

The contained SzFlag instances are:

• SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
• SZ_ENTITY_INCLUDE_ENTITY_NAME
• SZ_ENTITY_INCLUDE_RECORD_SUMMARY
• SZ_ENTITY_INCLUDE_RECORD_DATA
• SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_ENTITY_FLAGS, and by extension belong to the following usage groups which are super sets:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_ENTITY_DEFAULT_FLAGS

The Set of SzFlag instances representing the default' level of detail when retrieving entities.

The contained SzFlag instances are:

• All SzFlag instances from SZ_ENTITY_CORE_FLAGS
• All SzFlag instances from SZ_ENTITY_INCLUDE_ALL_RELATIONS
• SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME
• SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY
• SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_ENTITY_FLAGS, and by extension belong to the following usage groups which are super sets:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_ENTITY_BRIEF_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_ENTITY_BRIEF_DEFAULT_FLAGS

The Set of SzFlag instances representing the default flags for a "brief" level of detail when retrieving entities.

The contained SzFlag instances are:

• All SzFlag instances from SZ_ENTITY_INCLUDE_ALL_RELATIONS
• SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO
• SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_ENTITY_FLAGS, and by extension belong to the following usage groups which are super sets:

• SzFlagUsageGroup.SZ_ENTITY_FLAGS
• SzFlagUsageGroup.SZ_SEARCH_FLAGS
• SzFlagUsageGroup.SZ_EXPORT_FLAGS
• SzFlagUsageGroup.SZ_FIND_PATH_FLAGS
• SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS
• SzFlagUsageGroup.SZ_WHY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_EXPORT_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_EXPORT_DEFAULT_FLAGS

The Set of SzFlag instances representing the default flags for exporting entities.

The contained SzFlag instances are:

• All SzFlag instances from SZ_EXPORT_INCLUDE_ALL_ENTITIES
• All SzFlag instances from SZ_ENTITY_DEFAULT_FLAGS

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_EXPORT_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_FIND_PATH_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_FIND_PATH_DEFAULT_FLAGS

The Set of SzFlag instances representing the defaults for "find path" operations.

The contained SzFlag instances are:

• SZ_FIND_PATH_INCLUDE_MATCHING_INFO
• SZ_ENTITY_INCLUDE_ENTITY_NAME
• SZ_ENTITY_INCLUDE_RECORD_SUMMARY

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_FIND_PATH_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_FIND_NETWORK_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_FIND_NETWORK_DEFAULT_FLAGS

The Set of SzFlag instances representing the defaults for "find network" operations.

The contained SzFlag instances are:

• SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO
• SZ_ENTITY_INCLUDE_ENTITY_NAME
• SZ_ENTITY_INCLUDE_RECORD_SUMMARY

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_FIND_NETWORK_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_WHY_ENTITIES_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_WHY_ENTITIES_DEFAULT_FLAGS

The Set of SzFlag instances representing the defaults for "why entities" operations.

The contained SzFlag instances are:

• All SzFlag instances from SZ_ENTITY_DEFAULT_FLAGS
• SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
• SZ_ENTITY_INCLUDE_FEATURE_STATS
• SZ_INCLUDE_FEATURE_SCORES

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_WHY_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_WHY_RECORDS_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_WHY_RECORDS_DEFAULT_FLAGS

The Set of SzFlag instances representing the defaults for "why records" operations.

The contained SzFlag instances are:

• All SzFlag instances from SZ_ENTITY_DEFAULT_FLAGS
• SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
• SZ_ENTITY_INCLUDE_FEATURE_STATS
• SZ_INCLUDE_FEATURE_SCORES

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_WHY_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS

The Set of SzFlag instances representing the defaults for "why record in entity" operations.

The contained SzFlag instances are:

• All SzFlag instances from SZ_ENTITY_DEFAULT_FLAGS
• SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
• SZ_ENTITY_INCLUDE_FEATURE_STATS
• SZ_INCLUDE_FEATURE_SCORES

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_WHY_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_HOW_ENTITY_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_HOW_ENTITY_DEFAULT_FLAGS

The Set of SzFlag instances representing the defaults for "how entity" operations that analyze how an entity was formed.

The contained SzFlag instances are:

• SZ_INCLUDE_FEATURE_SCORES

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_HOW_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS

The Set of SzFlag instances representing the defaults when retrieving virtual entities.

The contained SzFlag instances are:

• All SzFlag instances from SZ_ENTITY_CORE_FLAGS

All the flags in this Set belong to the following usage groups:

• SzFlagUsageGroup.SZ_VIRTUAL_ENTITY_FLAGS

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_BY_ATTRIBUTES_ALL

public static final Set<SzFlag> SZ_SEARCH_BY_ATTRIBUTES_ALL

The Set of SzFlag instances indicating that search results should include all matching entities regardless of match level.

The contained SzFlag instances are:

• All SzFlag instances from SZ_SEARCH_INCLUDE_ALL_ENTITIES
• SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
• SZ_ENTITY_INCLUDE_ENTITY_NAME
• SZ_ENTITY_INCLUDE_RECORD_SUMMARY
• SZ_INCLUDE_FEATURE_SCORES

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_BY_ATTRIBUTES_STRONG

public static final Set<SzFlag> SZ_SEARCH_BY_ATTRIBUTES_STRONG

The Set of SzFlag instances indicating that search results should only include strongly matching entities.

The contained SzFlag instances are:

• SZ_SEARCH_INCLUDE_RESOLVED
• SZ_SEARCH_INCLUDE_POSSIBLY_SAME
• SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
• SZ_ENTITY_INCLUDE_ENTITY_NAME
• SZ_ENTITY_INCLUDE_RECORD_SUMMARY
• SZ_INCLUDE_FEATURE_SCORES

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL

public static final Set<SzFlag> SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL

The Set of SzFlag instances indicating that search results should include all matching entities regardless of match level while returning minimal data for those matching entities.

This is equivalent to SZ_SEARCH_INCLUDE_ALL_ENTITIES.

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG

public static final Set<SzFlag> SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG

The Set of SzFlag instances indicating that search results should only include strongly matching entities while returning minimal data for those matching entities.

The contained SzFlag instances are:

• SZ_SEARCH_INCLUDE_RESOLVED
• SZ_SEARCH_INCLUDE_POSSIBLY_SAME

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS

public static final Set<SzFlag> SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS

The Set of SzFlag instances that are a good default for searching by attributes and returning basic entity data.

This is equivalent to SZ_SEARCH_BY_ATTRIBUTES_ALL.

All the flags in this Set are guaranteed to belong to the SzFlagUsageGroup.SZ_SEARCH_FLAGS usage group.

See Also:

• https://docs.senzing.com/flags/index.html

Method Details

values

public static SzFlag[] 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

public static SzFlag valueOf(String name)

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 name

NullPointerException - if the argument is null

toLong

public long toLong()

Converts this instance to its 64-bit long integer equivalent representing the bitwise flags.

Returns:

The 64-bit long integer equivalent representing the bitwise flags.

getGroups

public Set<SzFlagUsageGroup> getGroups()

Gets the unmodifiable Set of SzFlagUsageGroup instances describing which usage groups that this SzFlag belongs to. The returned unmodifiable Set will be backed by an EnumSet.

Returns:

The unmodifiable Set of SzFlagUsageGroup instances describing which usage groups that this SzFlag belongs to.

toLong

public static long toLong(Set<SzFlag> set)

Converts the specified EnumSet to its 64-bit long integer equivalent representing the bitwise flags. If null is specified it will be treated as an empty Set.

Parameters:

set - The Set for which the bitwise equivalent is being requested.

Returns:

The 64-bit long integer equivalent representing the bitwise flags of the specified Set.

intersects

public static boolean intersects(Set<SzFlag> set1,
 Set<SzFlag> set2)

Checks if any intersection exists between two sets of SzFlag instances.

Parameters:

set1 - The first Set of SzFlag instances.

set2 - The second Set of SzFlag instances.

Returns:

true if there is any intersection between the specified sets, or false if there is no intersection.

intersect

public static EnumSet<SzFlag> intersect(Set<SzFlag> set1,
 Set<SzFlag> set2)

Creates a new EnumSet of SzFlag instances that represents the intersection between the two specified sets of SzFlag instances.

Parameters:

set1 - The first Set of SzFlag instances.

set2 - The second Set of SzFlag instances.

Returns:

A new Set of SzFlag instances representing intersection between the two specified sets.

union

public static EnumSet<SzFlag> union(Set<SzFlag> set1,
 Set<SzFlag> set2)

Creates a new EnumSet of SzFlag instances that represents the union between the two specified sets of SzFlag instances.

Parameters:

set1 - The first Set of SzFlag instances.

set2 - The second Set of SzFlag instances.

Returns:

A new Set of SzFlag instances representing union between the two specified sets.

toString

public static String toString(Set<SzFlag> flagSet)

Returns the String representation describing the SzFlag instances in the specified Set.

Parameters:

flagSet - The Set of SzFlag instances to convert to a String.

Returns:

The String representation describing the specified Set of SzFlag instances.