Package com.senzing.sdk

Class SzFlags

java.lang.Object
com.senzing.sdk.SzFlags
public final class SzFlags extends Object
Enumerates all the flags used by the Senzing SDK.

  • Field Details

    • SZ_NO_FLAGS

      public static final long SZ_NO_FLAGS
      The value representing no flags are being passed. Alternatively, a null value will indicate no flags as well.
      See Also:

    • SZ_WITH_INFO

      public static final long SZ_WITH_INFO
      The bitwise flag for indicating that the Senzing engine should produce and return the INFO document describing the affected entities from an operation that modifies record data in the repository.
      See Also:

    • SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES

      public static final long SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES
      The bitwise flag for export functionality to indicate that we should include "resolved" relationships.
      See Also:

    • SZ_EXPORT_INCLUDE_POSSIBLY_SAME

      public static final long SZ_EXPORT_INCLUDE_POSSIBLY_SAME
      The bitwise flag for export functionality to indicate that we should include "possibly same" relationships.
      See Also:

    • SZ_EXPORT_INCLUDE_NAME_ONLY

      public static final long SZ_EXPORT_INCLUDE_NAME_ONLY
      The bitwise flag for export functionality to indicate that we should include "name only" relationships.
      See Also:

    • SZ_EXPORT_INCLUDE_DISCLOSED

      public static final long SZ_EXPORT_INCLUDE_DISCLOSED
      The bitwise flag for export functionality to indicate that we should include "disclosed" relationships.
      See Also:

    • SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES

      public static final long SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES
      The bitwise flag for export functionality to indicate that we should include singleton entities.
      See Also:

    • SZ_EXPORT_INCLUDE_ALL_ENTITIES

      public static final long SZ_EXPORT_INCLUDE_ALL_ENTITIES
      The bitwise flag for export functionality to indicate that we should include all entities.
      See Also:

    • SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS

      public static final long SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS
      The bitwise flag for export functionality to indicate that we should include all relationships.
      See Also:

    • SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS

      public static final long SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS
      The bitwise flag for including possibly-same relations for entities.
      See Also:

    • SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS

      public static final long SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS
      The bitwise flag for including name-only relations for entities.
      See Also:

    • SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS

      public static final long SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS
      The bitwise flag for including disclosed relations for entities.
      See Also:

    • SZ_ENTITY_INCLUDE_ALL_RELATIONS

      public static final long SZ_ENTITY_INCLUDE_ALL_RELATIONS
      The bitwise flag for including all relations for entities.
      See Also:

    • SZ_ENTITY_INCLUDE_ALL_FEATURES

      public static final long SZ_ENTITY_INCLUDE_ALL_FEATURES
      The bitwise flag for including all features for entities.
      See Also:

    • SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES

      public static final long SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
      The bitwise flag for including representative features for entities.
      See Also:

    • SZ_ENTITY_INCLUDE_ENTITY_NAME

      public static final long SZ_ENTITY_INCLUDE_ENTITY_NAME
      The bitwise flag for including the name of the entity.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_SUMMARY

      public static final long SZ_ENTITY_INCLUDE_RECORD_SUMMARY
      The bitwise flag for including the record summary of the entity.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_TYPES

      public static final long SZ_ENTITY_INCLUDE_RECORD_TYPES
      The bitwise flag for including the record types of the entity.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_DATA

      public static final long SZ_ENTITY_INCLUDE_RECORD_DATA
      The bitwise flag for including the basic record data for the entity.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO

      public static final long SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO
      The bitwise flag for including the record matching info for the entity.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_JSON_DATA

      public static final long SZ_ENTITY_INCLUDE_RECORD_JSON_DATA
      The bitwise flag for including the record json data for the entity.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA

      public static final long SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA
      The bitwise flag for including the record unmapped data for the entity.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_FEATURES

      public static final long SZ_ENTITY_INCLUDE_RECORD_FEATURES
      The bitwise flag to include the features identifiers at the record level, referencing the entity features.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS

      public static final long SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS
      The bitwise flag for including full feature details at the record level of an entity response or in a record response.
      See Also:

    • SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS

      public static final long SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS
      The bitwise flag for including full feature statistics at the record level of an entity response or in a record response.
      See Also:

    • SZ_ENTITY_INCLUDE_INTERNAL_FEATURES

      public static final long SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
      The bitwise flag for including internal features in entity output.
      See Also:

    • SZ_ENTITY_INCLUDE_FEATURE_STATS

      public static final long SZ_ENTITY_INCLUDE_FEATURE_STATS
      The bitwise flag for including feature statistics in entity output.
      See Also:

    • SZ_INCLUDE_MATCH_KEY_DETAILS

      public static final long SZ_INCLUDE_MATCH_KEY_DETAILS
      The bitwise flag for including internal features.
      See Also:

    • SZ_FIND_PATH_STRICT_AVOID

      public static final long SZ_FIND_PATH_STRICT_AVOID
      The bitwise flag for find-path functionality to indicate that avoided entities are not allowed under any circumstance -- even if they are the only means by which a path can be found between two entities.
      See Also:

    • SZ_FIND_PATH_INCLUDE_MATCHING_INFO

      public static final long SZ_FIND_PATH_INCLUDE_MATCHING_INFO
      The bitwise flag for find-path functionality to include matching info on entity paths.
      See Also:

    • SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO

      public static final long SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO
      The bitwise flag for find-path functionality to include matching info on entity paths.
      See Also:

    • SZ_INCLUDE_FEATURE_SCORES

      public static final long SZ_INCLUDE_FEATURE_SCORES
      The bitwise flag for including feature scores.
      See Also:

    • SZ_SEARCH_INCLUDE_STATS

      public static final long SZ_SEARCH_INCLUDE_STATS
      The bitwise flag for including statistics from search results.
      See Also:

    • SZ_SEARCH_INCLUDE_RESOLVED

      public static final long SZ_SEARCH_INCLUDE_RESOLVED
      The bitwise flag for search functionality to indicate that we should include "resolved" match level results.
      See Also:

    • SZ_SEARCH_INCLUDE_POSSIBLY_SAME

      public static final long SZ_SEARCH_INCLUDE_POSSIBLY_SAME
      The bitwise flag for search functionality to indicate that we should include "possibly same" match level results.
      See Also:

    • SZ_SEARCH_INCLUDE_NAME_ONLY

      public static final long SZ_SEARCH_INCLUDE_NAME_ONLY
      The bitwise flag for search functionality to indicate that we should include "name only" match level results.
      See Also:

    • SZ_WITH_INFO_FLAGS

      public static final long SZ_WITH_INFO_FLAGS
      The bitwise flag 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.
      See Also:

    • SZ_SEARCH_INCLUDE_ALL_ENTITIES

      public static final long SZ_SEARCH_INCLUDE_ALL_ENTITIES
      The bitwise flag for search functionality to indicate that we should include all match level results.
      See Also:

    • SZ_RECORD_DEFAULT_FLAGS

      public static final long SZ_RECORD_DEFAULT_FLAGS
      The default recommended bitwise flag values for getting records.
      See Also:

    • SZ_ENTITY_DEFAULT_FLAGS

      public static final long SZ_ENTITY_DEFAULT_FLAGS
      The default recommended bitwise flag values for getting entities.
      See Also:

    • SZ_ENTITY_BRIEF_DEFAULT_FLAGS

      public static final long SZ_ENTITY_BRIEF_DEFAULT_FLAGS
      The default recommended bitwise flag values for getting entities.
      See Also:

    • SZ_EXPORT_DEFAULT_FLAGS

      public static final long SZ_EXPORT_DEFAULT_FLAGS
      The default recommended bitwise flag values for exporting entities.
      See Also:

    • SZ_FIND_PATH_DEFAULT_FLAGS

      public static final long SZ_FIND_PATH_DEFAULT_FLAGS
      The default recommended bitwise flag values for finding entity paths.
      See Also:

    • SZ_FIND_NETWORK_DEFAULT_FLAGS

      public static final long SZ_FIND_NETWORK_DEFAULT_FLAGS
      The default recommended bitwise flag values for finding entity networks.
      See Also:

    • SZ_WHY_ENTITIES_DEFAULT_FLAGS

      public static final long SZ_WHY_ENTITIES_DEFAULT_FLAGS
      The default recommended bitwise flag values for why-entities analysis on entities.
      See Also:

    • SZ_WHY_RECORDS_DEFAULT_FLAGS

      public static final long SZ_WHY_RECORDS_DEFAULT_FLAGS
      The default recommended bitwise flag values for why-records analysis on entities.
      See Also:

    • SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS

      public static final long SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS
      The default recommended bitwise flag values for why-record-in analysis on entities.
      See Also:

    • SZ_HOW_ENTITY_DEFAULT_FLAGS

      public static final long SZ_HOW_ENTITY_DEFAULT_FLAGS
      The default recommended bitwise flag values for how-analysis on entities.
      See Also:

    • SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS

      public static final long SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS
      The default recommended bitwise flag values for virtual-entity-analysis on entities.
      See Also:

    • SZ_SEARCH_BY_ATTRIBUTES_ALL

      public static final long SZ_SEARCH_BY_ATTRIBUTES_ALL
      The default recommended bitwise flag values for searching by attributes, returning all matching entities.
      See Also:

    • SZ_SEARCH_BY_ATTRIBUTES_STRONG

      public static final long SZ_SEARCH_BY_ATTRIBUTES_STRONG
      The default recommended bitwise flag values for searching by attributes, returning only strongly matching entities.
      See Also:

    • SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL

      public static final long SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL
      The default recommended bitwise flag values for searching by attributes, returning minimal data with all matches.
      See Also:

    • SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG

      public static final long SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG
      The default recommended bitwise flag values for searching by attributes, returning the minimal data, and returning only the strongest matches.
      See Also:

    • SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS

      public static final long SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS
      The default recommended bitwise flag values for searching by attributes.
      See Also: