Uses of Enum Class
com.senzing.sdk.SzFlag

Packages that use SzFlag

Package	Description
com.senzing.sdk	This package provides the interfaces, utility classes, enumerations, constants and exception types pertaining to the Senzing SDK for Java.

Uses of SzFlag in com.senzing.sdk

Fields in com.senzing.sdk with type parameters of type SzFlag

Modifier and Type	Field	Description
static final Set<SzFlag>	SzFlag.SZ_ADD_RECORD_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_ADD_RECORD_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_ADD_RECORD_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for "add record".
static final Set<SzFlag>	SzFlag.SZ_DELETE_RECORD_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_DELETE_RECORD_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_DELETE_RECORD_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for "delete record".
static final Set<SzFlag>	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>	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>	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>	SzFlag.SZ_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances representing the default' level of detail when retrieving entities.
static final Set<SzFlag>	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>	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>	SzFlag.SZ_EXPORT_DEFAULT_FLAGS	The Set of SzFlag instances representing the default flags for exporting entities.
static final Set<SzFlag>	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>	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>	SzFlag.SZ_FIND_INTERESTING_ENTITIES_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_FIND_INTERESTING_ENTITIES_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_FIND_INTERESTING_ENTITIES_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for "find interesting entities" operations.
static final Set<SzFlag>	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>	SzFlag.SZ_FIND_NETWORK_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "find network" operations.
static final Set<SzFlag>	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>	SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "find path" operations.
static final Set<SzFlag>	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>	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>	SzFlag.SZ_NO_FLAGS	An unmodifiable Set of SzFlag instances containing NO flags (an empty set).
static final Set<SzFlag>	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>	SzFlag.SZ_RECORD_DEFAULT_FLAGS	The Set of SzFlag instances representing the default level of detail when retrieving records.
static final Set<SzFlag>	SzFlag.SZ_RECORD_PREVIEW_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_RECORD_PREVIEW_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_RECORD_PREVIEW_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for record preview operations.
static final Set<SzFlag>	SzFlag.SZ_REDO_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_REDO_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_REDO_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for "process redo" operations.
static final Set<SzFlag>	SzFlag.SZ_REEVALUATE_ENTITY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_REEVALUATE_ENTITY_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_REEVALUATE_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for "reevaluate entity" operations.
static final Set<SzFlag>	SzFlag.SZ_REEVALUATE_RECORD_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_REEVALUATE_RECORD_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_REEVALUATE_RECORD_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for "reevaluate record" operations.
static final Set<SzFlag>	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>	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>	SzFlag.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for searching by attributes and returning basic entity data.
static final Set<SzFlag>	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>	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>	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>	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>	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>	SzFlag.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults when retrieving virtual entities.
static final Set<SzFlag>	SzFlag.SZ_WHY_ENTITIES_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_WHY_ENTITIES_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_WHY_ENTITIES_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "why entities" operations.
static final Set<SzFlag>	SzFlag.SZ_WHY_RECORD_IN_ENTITY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_WHY_RECORD_IN_ENTITY_FLAGS usage group.
static final Set<SzFlag>	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>	SzFlag.SZ_WHY_RECORDS_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_WHY_RECORDS_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_WHY_RECORDS_DEFAULT_FLAGS	The Set of SzFlag instances representing the defaults for "why records" operations.
static final Set<SzFlag>	SzFlag.SZ_WHY_SEARCH_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_WHY_SEARCH_FLAGS usage group.
static final Set<SzFlag>	SzFlag.SZ_WHY_SEARCH_DEFAULT_FLAGS	The Set of SzFlag instances that are a recommended default for "why search" operations and returning basic entity data.
static final Set<SzFlag>	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 response should contain an "INFO" message describing how the repository was affected as a result of the operation.

Methods in com.senzing.sdk that return SzFlag

Modifier and Type	Method	Description
static SzFlag	SzFlag.valueOf(String name)	Returns the enum constant of this class with the specified name.
static SzFlag[]	SzFlag.values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods in com.senzing.sdk that return types with arguments of type SzFlag

Modifier and Type	Method	Description
Set<SzFlag>	SzFlagUsageGroup.getFlags()	Gets the EnumSet of SzFlag instances that have this SzFlagUsageGroup.
static EnumSet<SzFlag>	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.
Set<SzFlag>	SzFlagUsageGroup.toFlagSet(long flagsValue)	Creates a Set of SzFlag instances representing the flags for the corresponding bit flags in the specified long value according to the SzFlag instances included for this SzFlagUsageGroup.
static EnumSet<SzFlag>	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.

Method parameters in com.senzing.sdk with type arguments of type SzFlag

Modifier and Type	Method	Description
String	SzEngine.addRecord(SzRecordKey recordKey, String recordDefinition, Set<SzFlag> flags)	Loads a record into the repository and performs entity resolution.
String	SzEngine.deleteRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Deletes a record from the repository and performs entity resolution.
long	SzEngine.exportCsvEntityReport(String csvColumnList, Set<SzFlag> flags)	Initiates an export report of entity data in CSV format.
long	SzEngine.exportJsonEntityReport(Set<SzFlag> flags)	Initiates an export report of entity data in JSON Lines format.
String	SzEngine.findInterestingEntities(long entityId, Set<SzFlag> flags)	Experimental method.
String	SzEngine.findInterestingEntities(SzRecordKey recordKey, Set<SzFlag> flags)	Experimental method.
String	SzEngine.findNetwork(SzEntityIds entityIds, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Retrieves a network of relationships among entities, specified by entity IDs.
String	SzEngine.findNetwork(SzRecordKeys recordKeys, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Retrieves a network of relationships among entities, specified by record IDs.
default String	SzEngine.findPath(long startEntityId, long endEntityId, int maxDegrees, Set<SzFlag> flags)	Convenience method for calling SzEngine.findPath(long, long, int, SzEntityIds, Set, Set) using null as the value for both the "avoid entity ID's" and the "required data sources" parameters.
default String	SzEngine.findPath(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, Set<SzFlag> flags)	Convenience method for calling SzEngine.findPath(SzRecordKey, SzRecordKey, int, SzRecordKeys, Set, Set) using null as the value for both the "avoid record keys" and the "required data sources" parameters.
String	SzEngine.getEntity(long entityId, Set<SzFlag> flags)	Retrieves information about an entity, specified by entity ID.
String	SzEngine.getEntity(SzRecordKey recordKey, Set<SzFlag> flags)	Retrieves information about an entity, specified by record ID.
String	SzEngine.getRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Retrieves information about a record.
String	SzEngine.getRecordPreview(String recordDefinition, Set<SzFlag> flags)	Describes the features resulting from the hypothetical load of a record.
String	SzEngine.howEntity(long entityId, Set<SzFlag> flags)	Explains how an entity was constructed from its records.
static EnumSet<SzFlag>	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	SzFlag.intersects(Set<SzFlag> set1, Set<SzFlag> set2)	Checks if any intersection exists between two sets of SzFlag instances.
String	SzEngine.processRedoRecord(String redoRecord, Set<SzFlag> flags)	Processes the provided redo record.
String	SzEngine.reevaluateEntity(long entityId, Set<SzFlag> flags)	Reevaluates an entity by entity ID.
String	SzEngine.reevaluateRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Reevaluates an entity by record ID.
String	SzEngine.searchByAttributes(String attributes, String searchProfile, Set<SzFlag> flags)	Searches for entities that match or relate to the provided attributes.
default String	SzEngine.searchByAttributes(String attributes, Set<SzFlag> flags)	Convenience method for calling SzEngine.searchByAttributes(String, String, Set) with a null value for the search profile parameter.
static long	SzFlag.toLong(Set<SzFlag> set)	Converts the specified EnumSet to its 64-bit long integer equivalent representing the bitwise flags.
static String	SzFlag.toString(Set<SzFlag> flagSet)	Returns the String representation describing the SzFlag instances in the specified Set.
static EnumSet<SzFlag>	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.
String	SzEngine.whyEntities(long entityId1, long entityId2, Set<SzFlag> flags)	Describes the ways two entities relate to each other.
String	SzEngine.whyRecordInEntity(SzRecordKey recordKey, Set<SzFlag> flags)	Describes the ways a record relates to the rest of its respective entity.
String	SzEngine.whyRecords(SzRecordKey recordKey1, SzRecordKey recordKey2, Set<SzFlag> flags)	Describes the ways two records relate to each other.
String	SzEngine.whySearch(String attributes, long entityId, String searchProfile, Set<SzFlag> flags)	Describes the ways a set of search attributes relate to an entity.
default String	SzEngine.whySearch(String attributes, long entityId, Set<SzFlag> flags)	Convenience method for calling SzEngine.whySearch(String, long, String, Set) with a null value for the search profile parameter.