Uses of Class
com.senzing.sdk.SzException

Packages that use SzException

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

Uses of SzException in com.senzing.sdk

Subclasses of SzException in com.senzing.sdk

Modifier and Type	Class	Description
class	SzBadInputException	Defines an exceptional condition when an invalid input value is provided to a Senzing operation preventing the successful completion of that operation.
class	SzConfigurationException	Defines an exceptional condition when a failure has occurred pertaining to the Senzing configuration.
class	SzDatabaseConnectionLostException	Extends SzRetryableException to define an exceptional condition where a database connection was lost causing a Senzing operation to fail.
class	SzDatabaseException	Extends SzUnrecoverableException to define an exceptional condition triggered by a database error from which we cannot recover (e.g.: missing or unexpected schema definition).
class	SzDatabaseTransientException	Extends SzRetryableException to define an exceptional condition where an operation failed because a database condition that is transient and would like be resolved on a repeated attempt.
class	SzLicenseException	Extends SzUnrecoverableException to define an exceptional condition triggered by an invalid, expired or exhausted Senzing license.
class	SzNotFoundException	Extends SzBadInputException to define an exceptional condition where the provided bad input to a Senzing operation is an identifier that could not be used to successfully locate required data for that operation.
class	SzNotInitializedException	Extends SzUnrecoverableException to define an exceptional condition triggered by Senzing not being initialized.
class	SzReplaceConflictException	Describes an exceptional condition when an attempt is made to replace a Senzing value with a new value providing it has not not already been changed, however, the current value is no longer the expected value and has therefore already been changed.
class	SzRetryableException	Defines an exceptional condition where the failure is an intermittent condition and the operation may be retried with the same parameters with an expectation of success.
class	SzRetryTimeoutExceededException	Extends SzRetryableException to define an exceptional condition where an operation failed because a timeout was exceeded.
class	SzUnhandledException	Extends SzUnrecoverableException to define an exceptional condition caused by an otherwise unhandled and unexpected failure in the Senzing SDK.
class	SzUnknownDataSourceException	Extends SzBadInputException to define an exceptional condition where a specified data source code is not configured in the current active configuration and therefore the data source could not be found.
class	SzUnrecoverableException	Defines an exceptional condition where the failure is not recoverable and all operations should be stopped until the system can be modified to resolve the condition causing the failure.

Methods in com.senzing.sdk that throw SzException

Modifier and Type	Method	Description
default String	SzEngine.addRecord(SzRecordKey recordKey, String recordDefinition)	Convenience method for calling SzEngine.addRecord(SzRecordKey, String, Set) using SzFlag.SZ_ADD_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.addRecord(SzRecordKey recordKey, String recordDefinition, Set<SzFlag> flags)	Loads a record into the repository and performs entity resolution.
String	SzDiagnostic.checkRepositoryPerformance(int secondsToRun)	Conducts a rudimentary repository test to gauge I/O and network performance.
void	SzEngine.closeExportReport(long exportHandle)	Closes an export report.
long	SzEngine.countRedoRecords()	Gets the number of redo records pending processing.
SzConfig	SzConfigManager.createConfig()	Creates a new SzConfig instance from the template configuration definition.
SzConfig	SzConfigManager.createConfig(long configId)	Creates a new SzConfig instance for a configuration ID.
SzConfig	SzConfigManager.createConfig(String configDefinition)	Creates a new SzConfig instance from a configuration definition.
default String	SzEngine.deleteRecord(SzRecordKey recordKey)	Convenience method for calling SzEngine.deleteRecord(SzRecordKey, Set) using SzFlag.SZ_DELETE_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.deleteRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Deletes a record from the repository and performs entity resolution.
String	SzConfig.export()	Retrieves the definition for this configuration.
default long	SzEngine.exportCsvEntityReport(String csvColumnList)	Convenience method for calling SzEngine.exportCsvEntityReport(String, Set) using SzFlag.SZ_EXPORT_DEFAULT_FLAGS as the value for the flags parameter.
long	SzEngine.exportCsvEntityReport(String csvColumnList, Set<SzFlag> flags)	Initiates an export report of entity data in CSV format.
default long	SzEngine.exportJsonEntityReport()	Convenience method for calling SzEngine.exportJsonEntityReport(Set) using SzFlag.SZ_EXPORT_DEFAULT_FLAGS as the value for the flags parameter.
long	SzEngine.exportJsonEntityReport(Set<SzFlag> flags)	Initiates an export report of entity data in JSON Lines format.
String	SzEngine.fetchNext(long exportHandle)	Fetches the next line of entity data from an open export report.
default String	SzEngine.findInterestingEntities(long entityId)	Convenience method for calling SzEngine.findInterestingEntities(long, Set) with SzFlag.SZ_FIND_INTERESTING_ENTITIES_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findInterestingEntities(long entityId, Set<SzFlag> flags)	Experimental method.
default String	SzEngine.findInterestingEntities(SzRecordKey recordKey)	Convenience method for calling SzEngine.findInterestingEntities(SzRecordKey, Set) with SzFlag.SZ_FIND_INTERESTING_ENTITIES_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findInterestingEntities(SzRecordKey recordKey, Set<SzFlag> flags)	Experimental method.
default String	SzEngine.findNetwork(SzEntityIds entityIds, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities)	Convenience method for calling SzEngine.findNetwork(SzEntityIds, int, int, int, Set) with SzFlag.SZ_FIND_NETWORK_DEFAULT_FLAGS as the value for the flags parameter.
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.
default String	SzEngine.findNetwork(SzRecordKeys recordKeys, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities)	Convenience method for calling SzEngine.findNetwork(SzRecordKeys, int, int, int, Set) with SzFlag.SZ_FIND_NETWORK_DEFAULT_FLAGS as the value for the flags parameter.
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)	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 and SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.findPath(long startEntityId, long endEntityId, int maxDegrees, SzEntityIds avoidEntityIds, Set<String> requiredDataSources)	Convenience method for calling SzEngine.findPath(long, long, int, SzEntityIds, Set, Set) using SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findPath(long startEntityId, long endEntityId, int maxDegrees, SzEntityIds avoidEntityIds, Set<String> requiredDataSources, Set<SzFlag> flags)	Searches for the shortest relationship path between two entities, specified by entity 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)	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 and SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.findPath(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, SzRecordKeys avoidRecordKeys, Set<String> requiredDataSources)	Convenience method for calling SzEngine.findPath(SzRecordKey, SzRecordKey, int, SzRecordKeys, Set, Set) using SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findPath(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, SzRecordKeys avoidRecordKeys, Set<String> requiredDataSources, Set<SzFlag> flags)	Searches for the shortest relationship path between two entities, specified by record IDs.
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.
long	SzEnvironment.getActiveConfigId()	Gets the currently active configuration ID for the SzEnvironment.
SzConfigManager	SzEnvironment.getConfigManager()	Provides a reference to the SzConfigManager instance associated with this SzEnvironment.
String	SzConfigManager.getConfigRegistry()	Gets the configuration registry.
String	SzConfig.getDataSourceRegistry()	Gets the data source registry for this configuration.
long	SzConfigManager.getDefaultConfigId()	Gets the default configuration ID for the repository.
SzDiagnostic	SzEnvironment.getDiagnostic()	Provides a reference to the SzDiagnostic instance associated with this SzEnvironment.
SzEngine	SzEnvironment.getEngine()	Provides a reference to the SzEngine instance associated with this SzEnvironment.
default String	SzEngine.getEntity(long entityId)	Convenience method for calling SzEngine.getEntity(long,Set) using SzFlag.SZ_ENTITY_DEFAULT_FLAGS as the value for theflags parameter.
String	SzEngine.getEntity(long entityId, Set<SzFlag> flags)	Retrieves information about an entity, specified by entity ID.
default String	SzEngine.getEntity(SzRecordKey recordKey)	Convenience method for calling SzEngine.getEntity(SzRecordKey,Set) using SzFlag.SZ_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.getEntity(SzRecordKey recordKey, Set<SzFlag> flags)	Retrieves information about an entity, specified by record ID.
String	SzDiagnostic.getFeature(long featureId)	Experimental/internal for Senzing support use.
String	SzProduct.getLicense()	Gets the details and entitlements of the applied product license.
SzProduct	SzEnvironment.getProduct()	Provides a reference to the SzProduct instance associated with this SzEnvironment.
default String	SzEngine.getRecord(SzRecordKey recordKey)	Convenience method for calling SzEngine.getRecord(SzRecordKey, Set) using SzFlag.SZ_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.getRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Retrieves information about a record.
default String	SzEngine.getRecordPreview(String recordDefinition)	Convenience method for calling SzEngine.getRecordPreview(String, Set) using SzFlag.SZ_RECORD_PREVIEW_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.getRecordPreview(String recordDefinition, Set<SzFlag> flags)	Describes the features resulting from the hypothetical load of a record.
String	SzEngine.getRedoRecord()	Retrieves and removes a pending redo record.
String	SzDiagnostic.getRepositoryInfo()	Returns overview information about the repository.
String	SzEngine.getStats()	Gets and resets the internal engine workload statistics for the current operating system process.
String	SzProduct.getVersion()	Gets the product version details.
default String	SzEngine.getVirtualEntity(Set<SzRecordKey> recordKeys)	Convenience method for calling SzEngine.getVirtualEntity(Set, Set) using SzFlag.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.getVirtualEntity(Set<SzRecordKey> recordKeys, Set<SzFlag> flags)	Describes how an entity would look if composed of a given set of records.
default String	SzEngine.howEntity(long entityId)	Convenience method for calling SzEngine.howEntity(long, Set) using SzFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.howEntity(long entityId, Set<SzFlag> flags)	Explains how an entity was constructed from its records.
void	SzEngine.primeEngine()	Pre-loads engine resources.
default String	SzEngine.processRedoRecord(String redoRecord)	Convenience method for calling SzEngine.processRedoRecord(String, Set) using SzFlag.SZ_REDO_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.processRedoRecord(String redoRecord, Set<SzFlag> flags)	Processes the provided redo record.
void	SzDiagnostic.purgeRepository()	Permanently deletes all data in the repository, except the configuration.
default String	SzEngine.reevaluateEntity(long entityId)	Convenience method for calling SzEngine.reevaluateEntity(long, Set) using SzFlag.SZ_REEVALUATE_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.reevaluateEntity(long entityId, Set<SzFlag> flags)	Reevaluates an entity by entity ID.
default String	SzEngine.reevaluateRecord(SzRecordKey recordKey)	Convenience method for calling SzEngine.reevaluateRecord(SzRecordKey, Set) using SzFlag.SZ_REEVALUATE_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.reevaluateRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Reevaluates an entity by record ID.
long	SzConfigManager.registerConfig(String configDefinition)	Registers a configuration definition in the repository with an auto-generated comment.
long	SzConfigManager.registerConfig(String configDefinition, String configComment)	Registers a configuration definition in the repository.
String	SzConfig.registerDataSource(String dataSourceCode)	Adds a data source to this configuration.
void	SzEnvironment.reinitialize(long configId)	Reinitializes the SzEnvironment with the specified configuration ID.
void	SzConfigManager.replaceDefaultConfigId(long currentDefaultConfigId, long newDefaultConfigId)	Replaces the existing default configuration ID with a new configuration ID.
default String	SzEngine.searchByAttributes(String attributes)	Convenience method for calling SzEngine.searchByAttributes(String, String, Set) with a null value for the search profile parameter and SzFlag.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.searchByAttributes(String attributes, String searchProfile)	Convenience method for calling SzEngine.searchByAttributes(String, String, Set) using SzFlag.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS as the value for the flags parameter.
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.
long	SzConfigManager.setDefaultConfig(String configDefinition)	Registers a configuration in the repository and then sets its ID as the default for the repository with an auto-generated comment.
long	SzConfigManager.setDefaultConfig(String configDefinition, String configComment)	Registers a configuration in the repository and then sets its ID as the default for the repository.
void	SzConfigManager.setDefaultConfigId(long configId)	Sets the default configuration ID.
void	SzConfig.unregisterDataSource(String dataSourceCode)	Removes a data source from this configuration.
default String	SzEngine.whyEntities(long entityId1, long entityId2)	Convenience method for calling SzEngine.whyEntities(long, long, Set) with SzFlag.SZ_WHY_ENTITIES_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.whyEntities(long entityId1, long entityId2, Set<SzFlag> flags)	Describes the ways two entities relate to each other.
default String	SzEngine.whyRecordInEntity(SzRecordKey recordKey)	Convenience method for calling SzEngine.whyRecordInEntity(SzRecordKey, Set) with SzFlag.SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.whyRecordInEntity(SzRecordKey recordKey, Set<SzFlag> flags)	Describes the ways a record relates to the rest of its respective entity.
default String	SzEngine.whyRecords(SzRecordKey recordKey1, SzRecordKey recordKey2)	Convenience method for calling SzEngine.whyRecords(SzRecordKey, SzRecordKey, Set) with SzFlag.SZ_WHY_RECORDS_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.whyRecords(SzRecordKey recordKey1, SzRecordKey recordKey2, Set<SzFlag> flags)	Describes the ways two records relate to each other.
default String	SzEngine.whySearch(String attributes, long entityId)	Convenience method for calling SzEngine.whySearch(String, long, String, Set) with a null value for the search profile parameter and SzFlag.SZ_WHY_SEARCH_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.whySearch(String attributes, long entityId, String searchProfile)	Convenience method for calling SzEngine.whySearch(String, long, String, Set) using SzFlag.SZ_WHY_SEARCH_DEFAULT_FLAGS as the value for the flags parameter.
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.

Uses of SzException in com.senzing.sdk.core

Methods in com.senzing.sdk.core that return SzException

Modifier and Type	Method	Description
static SzException	SzCoreUtilities.createSzException(int errorCode, String message)	Creates the appropriate SzException instance for the specified error code.

Methods in com.senzing.sdk.core that throw SzException

Modifier and Type	Method	Description
long	SzCoreEnvironment.getActiveConfigId()
SzConfigManager	SzCoreEnvironment.getConfigManager()
SzDiagnostic	SzCoreEnvironment.getDiagnostic()
SzEngine	SzCoreEnvironment.getEngine()
SzProduct	SzCoreEnvironment.getProduct()
void	SzCoreEnvironment.reinitialize(long configId)