Class FileSynchronizationRequest
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
FullSynchronizationRequest
,SynchronizationBatchCsvInJobRequest
,SynchronizationBatchExcelInJobRequest
,SynchronizationBatchJsonInJobRequest
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Whether the import should continue if some of the import commands are invalid or failed to execute.protected boolean
Whether the file should be deleted after the synchronization job is finished, regardless of the result.protected File
The file to upload.protected UUID
Theid
of uploaded file.protected String
The name of the file to upload.protected @Size(min=1,max=50) @NotNull String
The synchronizationid
used to distinguish different synchronizations.Fields inherited from class BaseImportRequest
batchSize, DEFAULT_BATCH_SIZE, requestSource, saveResult, sendNotification, simulation
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
getFile()
The file to upload.Theid
of uploaded file.The name of the file to upload.The synchronizationid
used to distinguish different synchronizations.int
hashCode()
boolean
Whether the import should continue if some of the import commands are invalid or failed to execute.boolean
Whether the file should be deleted after the synchronization job is finished, regardless of the result.void
setContinueOnError
(boolean continueOnError) Whether the import should continue if some of the import commands are invalid or failed to execute.void
setDeleteFile
(boolean deleteFile) Whether the file should be deleted after the synchronization job is finished, regardless of the result.void
The file to upload.void
Theid
of uploaded file.void
setFileName
(String fileName) The name of the file to upload.void
setSynchronizationId
(String synchronizationId) The synchronizationid
used to distinguish different synchronizations.toString()
Methods inherited from class BaseImportRequest
getBatchSize, getRequestSource, isSaveResult, isSendNotification, isSimulation, setBatchSize, setRequestSource, setSaveResult, setSendNotification, setSimulation
-
Field Details
-
synchronizationId
@Size(min=1, max=50) @NotNull @PathParam("synchronizationId") protected @Size(min=1,max=50) @NotNull String synchronizationIdThe synchronizationid
used to distinguish different synchronizations. -
fileId
Theid
of uploaded file.NOTE: if this field is used,
file
should not be set. -
file
-
fileName
-
deleteFile
@DefaultValue("false") protected boolean deleteFileWhether the file should be deleted after the synchronization job is finished, regardless of the result. The default value isfalse
.NOTE: if the file corresponds to an attachment, the attachment will be deleted. When import operation fails then file will not be deleted.
-
continueOnError
@DefaultValue("false") protected boolean continueOnErrorWhether the import should continue if some of the import commands are invalid or failed to execute. The default value isfalse
.If
true
, the valid commands are still committed to the database, which can lead to partial results being stored.
-
-
Constructor Details
-
FileSynchronizationRequest
protected FileSynchronizationRequest()
-
-
Method Details
-
getSynchronizationId
The synchronizationid
used to distinguish different synchronizations. -
getFileId
Theid
of uploaded file.NOTE: if this field is used,
file
should not be set. -
getFile
-
getFileName
-
isDeleteFile
public boolean isDeleteFile()Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value isfalse
.NOTE: if the file corresponds to an attachment, the attachment will be deleted. When import operation fails then file will not be deleted.
-
isContinueOnError
public boolean isContinueOnError()Whether the import should continue if some of the import commands are invalid or failed to execute. The default value isfalse
.If
true
, the valid commands are still committed to the database, which can lead to partial results being stored. -
setSynchronizationId
The synchronizationid
used to distinguish different synchronizations. -
setFileId
Theid
of uploaded file.NOTE: if this field is used,
file
should not be set. -
setFile
-
setFileName
-
setDeleteFile
public void setDeleteFile(boolean deleteFile) Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value isfalse
.NOTE: if the file corresponds to an attachment, the attachment will be deleted. When import operation fails then file will not be deleted.
-
setContinueOnError
public void setContinueOnError(boolean continueOnError) Whether the import should continue if some of the import commands are invalid or failed to execute. The default value isfalse
.If
true
, the valid commands are still committed to the database, which can lead to partial results being stored. -
toString
- Overrides:
toString
in classBaseImportRequest
-
equals
- Overrides:
equals
in classBaseImportRequest
-
canEqual
- Overrides:
canEqual
in classBaseImportRequest
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBaseImportRequest
-