All Classes and Interfaces

Class	Description
AbsoluteIntervalFilterDTO	Initializes the filter with a fix interval between two dates.
AbstractDocTypeRequestDTO
AbstractDocTypeResponseDTO
AbstractDocTypeTemplateDTO
AbstractQueryDocumentsRequestDTO
AbstractQueryDocumentsRequestDTO.OrderByField	Query sort statement
AbstractRequestDTO	Abstract DTO superclass with typical request data.
AbstractResponseDTO	Abstract DTO superclass with typical response data
AbstractResponseItemDTO	Abstract DTO superclass for item responses, sometimes contained in main responses.
AcknowledgeEventsRequestDTO	Request DTO for acknowledging events.
AcknowledgeEventsResponseDTO	Response DTO for acknowledging events.
AcknowledgeFileRequestDTO	Contains information about the result of a file transfer.
AcknowledgeFileResponseDTO	Contains the result for an acknowledge file request.
AcknowledgePublishedDataFeedPartsRequestDTO	Request parameter for Response (result) for {@link IDataFeedBF#acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO}.
AcknowledgePublishedDataFeedPartsResponseDTO	Response (result) for IDataFeedBF.acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO).
AcknowledgePublishedDataTransferPackagesRequestDTO	Request parameter for IDataTransferBF.acknowledgePublishedDataTransferPackages(AcknowledgeGetPublishedDataTransferPackageRequestDTO).
AcknowledgePublishedDataTransferPackagesResponseDTO	Response (result) for IDataTransferBF.acknowledgePublishedDataTransferPackages(AcknowledgeGetPublishedDataTransferPackageRequestDTO).
AFExecuteProcessParmsDTO	Parameters of application facade invocation when this is to be done via create process: The client has to invoke the process as specified by the properties of this object.
AFShellExecuteParmsDTO	Parameters of application facade invocation when this is to be done via shellexecute: The client has to create a file with the given name in a temporary directory, the contents of the file is given in the variable 'contents'.
AnnounceStopParmDTO	parameter necessary to announce a stop of the server
AnnounceStopResultDTO	the result of the announce stop business facade
ApplicationFacadeDTO	A data transfer object which describes an application facade.
ApplicationFacadeParmsDTO	A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
CancelAnnounceStopParmDTO	parameter necessary to cancel an announced stop
CancelAnnounceStopResultDTO	Contains the result information of the cancel announce stop bf
ChangeAdminPasswordParmDTO	This class contains the old and the new admin password
ChangeAdminPasswordResultDTO	Contains the result information of the change admin password bf
ClientDTO	Data Transfer Object for Clients
ClientFeatureDTO
ClientFeatureSetDTO
ClientRolesDTO	Response DTO for listing client specific roles in GetRolesResponseDTO.
ComboboxEntryDTO	For common use in BF methods which return combobox entries, e.g.
CreateClientFromTemplateRequestDTO	Request parameters for creating a client by duplicating another.
CreateClientFromTemplateResponseDTO	Result DTO for starting a client duplication process.
CreateClientRequestDTO	this DTO is used for the method IFoundationBF.createClient(CreateClientRequestDTO) to encapsulate the request parameters.
CreateClientResponseDTO	this DTO is used for the method IFoundationBF.createClient(CreateClientRequestDTO) to encapsulate the response parameters.
CreateDocTypeRequestDTO
CreateDocTypeResponseDTO
CreateDocTypeTemplateDTO
CreateDocumentInstanceRequestDTO	Parameters for a single document creation.
CreateDocumentInstanceResponseDTO
CreateDocumentRequestDTO	Parameters for a single document creation.
CreateDocumentResponseDTO	Contains the created document and accompanying information.
CreateDocumentTemplateRequestDTO	Input for IDocumentServiceBF.createDocumentTemplate(CreateDocumentTemplateRequestDTO)
CreateDocumentTemplateResponseDTO	Response of IDocumentServiceBF.createDocumentTemplate(CreateDocumentTemplateRequestDTO).
DateAndZoneDTO	Date and timezone.
DateTimeIntervalRangeFilterDTO	Represents a possibility to pass a date time interval range filter.
DeleteDocTypeRequestDTO
DeleteDocTypeResponseDTO
DeleteDocumentInstanceRequestDTO	The parameters to delete document instances of a reference object.
DeleteDocumentInstanceResponseDTO	Contains the result of the deletion.
DeleteDocumentReferenceObjectRequestDTO	The parameters to delete a document reference object.
DeleteDocumentReferenceObjectResponseDTO
DeleteDocumentReferenceObjectTypeRequestDTO	The parameters to delete a document reference object type.
DeleteDocumentReferenceObjectTypeResponseDTO
DeleteDocumentRequestDTO	The parameters to delete a document.
DeleteDocumentResponseDTO	Contains the result of the deletion.
DeleteDocumentTemplateRequestDTO	Input for IDocumentServiceBF.deleteDocumentTemplate(DeleteDocumentTemplateRequestDTO)
DeleteDocumentTemplateResponseDTO	Response of IDocumentServiceBF.deleteDocumentTemplate(DeleteDocumentTemplateRequestDTO).
DeletePrintRequestRequestDTO
DeletePrintRequestResponseDTO
DLFilesRefsRequestDTO	Contains information on how to select files for transferring, e.g.
DLFilesRefsResponseDTO	Contains the result for a request to get the number of files available for download
DocTemplateInfoDTO
DocTypeDTO	DTO class for a document type for maintenance purposes.
DocTypeReferenceDTO	Represents a reference to a document type which is known to the document service.
DocTypeTranslationDTO	Text translations for the document type
DocumentContentStoreInfoDTO	Information about the document content in document store
DocumentCoreTaskException	Special exception for failed task processing in the IDocumentCoreBF interface.
DocumentInfoDTO	Information about the document which is stored/staged for a certain period of time.
DocumentInstanceInfoDTO	Information about the document which is stored/staged for a certain period of time.
DocumentInstanceReferenceDTO	Represents a reference to a document instance is known to the document service.
DocumentPrintOptionsDTO	Settings for printing the document content.
DocumentProcessingInfoDTO	Structured information on a template processing problem (problem that arises during the document processing, e.g.
DocumentProcessingOptionsDTO	Processing options for a single document generation (format etc.).
DocumentProcessingParameterDTO	Generic processing parameter, specific to each document processor.
DocumentProcessorInfoDTO	Information on a specific document processor (supported formats, parameters etc.)
DocumentReferenceDTO	A Document Service document references an external object that is not stored in the engine.
DocumentReferenceObjectDTO
DocumentReferenceObjectReferenceDTO
DocumentReferenceObjectTypeDTO	DTO class for a document reference object type for maintenance purposes.
DocumentReferenceObjectTypeTranslationDTO	Text translations for the document reference object type
DocumentReferencesDTO
DocumentServiceTaskException	Special exception for failed task processing in the IDocumentServiceBF interface.
DocumentStorageOptionsDTO	Settings for the document content storage processing.
DocumentTemplateArchiveFieldDTO
DocumentTemplateDocumentationDTO
DocumentTemplateDocumentationTextDTO
DocumentTemplateDTO	This DTO can be used to reference or transfer document templates to the engine.
DocumentTemplateExampleFileDTO
DocumentTemplateInfoDTO	Document template descriptor
DocumentTemplateInputRequestDTO
DocumentTemplateLocalizedTextDTO
DocumentTemplateLocalizedTextsDTO
DocumentTemplateReferenceDTO	Represents a reference to a document templates which is known to the document service.
DocumentTemplateSchemaDTO
DocumentTemplateSchemaFieldDocumentationDTO
DocumentTemplateSchemaFieldDTO
DocumentTemplateSchemaObjectTypeDTO
DocumentValidationInfoDTO	Structured information on a template validation problem
DOCXDocumentTemplateDTO	An empty implementation of DocumentTemplateDTO, with predefined constants for the DOCX processor (MS Word).
DownloadFileRequestDTO	Contains information on how to select a file for transferring, e.g.
DownloadFileResponseDTO	Contains the result for a download file request.
DuplicateClientProgressResponseDTO	Contains information about the current progress of a client duplication.
DuplicateClientRequestDTO	DTO with the configuration for duplication of a client.
DuplicateClientResponseDTO	Response for duplicateClient() call.
DuplicateClientUserDTO	DTO for creating a user when duplicating a client.
ExternalTelemetryReportDTO	Data for a single telemetry report.
ExternalTMIdentificationRequestDTO	Basic Request DTO for telemetry requests.
ExternalTMRDateEntryDTO	telemetry report entry for date values
ExternalTMRDoubleEntryDTO	telemetry report entry for double values
ExternalTMReportRequestDTO	Request DTO for sending a report from a third party system to the telemetry infrastructure.
ExternalTMResponseDTO	Response DTO for all calls to the IExternalTelemetryBF interface.
ExternalTMRIntegerEntryDTO	telemetry report entry for integer values
ExternalTMRLongEntryDTO	telemetry report entry for long values
ExternalTMRStringArrayEntryDTO	telemetry report entry for string array values
ExternalTMRStringEntryDTO	telemetry report entry for string values
ExternalTMStatusResponseDTO	Response DTO for the IExternalTelemetryBF.getTelemetryStatus(de.aeb.xnsg.foundation.bf.telemetry.ExternalTMIdentificationRequestDTO) method.
FileDTO	Data Transfer Object for a file.
GenerateClientIdentCodeRequestDTO	this DTO is used for the method IFoundationBF.generateClientIdentCode(ClientIdentCodeGenerationRequestDTO) to encapsulate the request parameters.
GenerateDocumentRequestDTO	The parameters for a single document generation.
GenerateDocumentResponseDTO	Contains the generated document and accompanying information.
GenericDataFieldDTO	A field of a generic data record.
GenericDataRecordDTO	A generic record of data. From within Java, consider to use the wrapper class de.aeb.xnsg.foundation.bc.genericdata.GenericDataRecordDTOWrapper for easier handling and de.aeb.xnsg.foundation.bc.genericdata.GenericDataRecordDTOMapping for mapping from and to other DTOs.
GetClientFeaturesRequestDTO
GetClientFeaturesResponseDTO
GetCreateClientFromTemplateStatusRequestDTO	Request parameters for querying a duplication process' status.
GetCreateClientFromTemplateStatusResponseDTO	Status of an ongoing or completed client duplication process started by IInternalProvisioningBF.createClientFromTemplate(CreateClientFromTemplateRequestDTO)
GetDataFeedPartContentRequestDTO	Request parameter for IDataFeedBF.getDataFeedPartContent(GetDataFeedPartRequestDTO).
GetDataFeedPartContentResponseDTO	Response (result) for IDataFeedBF.getDataFeedPartContent(GetDataFeedPartRequestDTO).
GetDocTypeRequestDTO
GetDocTypeResponseDTO
GetDocTypesRequestDTO
GetDocTypesResponseDTO
GetDocumentInstanceRequestDTO	The parameters to fetch a document instance.
GetDocumentInstanceResponseDTO	Contains the document content of the requested document and its DocumentInstanceInfoDTOs.
GetDocumentInstancesRequestDTO	The parameters to fetch document instances of a reference object.
GetDocumentInstancesResponseDTO	Contains the DocumentInstanceInfoDTOs of a reference object.
GetDocumentReferenceObjectRequestDTO
GetDocumentReferenceObjectResponseDTO
GetDocumentReferenceObjectsRequestDTO
GetDocumentReferenceObjectsRequestDTO.OrderByField	Query sort statement
GetDocumentReferenceObjectsResponseDTO
GetDocumentReferenceObjectTypeRequestDTO
GetDocumentReferenceObjectTypeResponseDTO
GetDocumentReferenceObjectTypesRequestDTO
GetDocumentReferenceObjectTypesResponseDTO
GetDocumentRequestDTO	The parameters to fetch a created document.
GetDocumentResponseDTO	Contains the document content of the requested document and its DocumentInfoDTOs.
GetPartnerSystemSubscriptionsRequestDTO
GetPartnerSystemSubscriptionsResponseDTO
GetPrintRequestsRequestDTO
GetPrintRequestsResponseDTO
GetPrintRequestStateRequestDTO
GetPrintRequestStateResponseDTO
GetPublishedDataFeedPartsRequestDTO	Request parameter for IDataFeedBF.getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
GetPublishedDataFeedPartsResponseDTO	Response (result) for IDataFeedBF.getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
GetPublishedDataTransferPackageRequestDTO	Request parameter for IDataTransferBF.getPublishedDataTransferPackage(GetPublishedDataTransferPackageRequestDTO).
GetPublishedDataTransferPackageResponseDTO	Response (result) for IDataTransferBF.getPublishedDataTransferPackage(GetPublishedDataTransferPackageRequestDTO).
GetRolesRequestDTO	DTO for GetRoles requests
GetRolesResponseDTO
IDataFeedBF
IDataTransferBF	Business facade for fetching published data transfer packages.
IDocumentCoreBF	Defines the business facades for processing document templates
IDocumentServiceAF
IDocumentServiceBF	External interface for document processing.
IDocumentServiceExtBF	Internal interface for document processing (not public).
IExternalTelemetryBF	Business facade for sending telemetry data from a third party system.
IFoundationAF	Application facade for the XNSGFoundation
IFoundationBF	Business facade for the XNSGFoundation
IInternalProvisioningBF	Internal business facade for provisioning clients from a template.
ImagePrintOptionsDTO	Settings for printing printer pictures/images
IntervalFromNowFilterDTO	Initializes the filter with a time interval relative to 'today'.
IReferenceObjectTypeAware	Interface providing common methods or constants for DTOs using DocumentReferenceObjectType
IRemoteAdminBF	Remote Administration tools use this methods.
ISyncBF	Business facade for synchronizing data asynchronous from an engine to a client system.
ISyncInternalBF	Internal business facade for setting events into the synchronization journal.
JobProcessingOptionsDTO	Technical processing options for the document generation job.
LocalizedIdentCodeDTO	Result object describing an ident code with translation.
MoIdentCodeRestDTO
MonitoringDataProviderDTO	Data Transfer Object for monitoring provider
NamedGenericDataRecordDTO	A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
NiceLabelDocumentServiceTemplateDTO	An empty implementation of DocumentTemplateDTO, with predefined constants for the NICELABEL processor.
NiceLabelDocumentTemplateDTO	An empty implementation of DocumentTemplateDTO, with predefined constants for the nice label processor
OutputSettingsPrinterDTO	The output settings contain information of a document in the current output owner context (e.g.
PageNumberMappingDTO	Contains page name and corresponding page numbers.
PageRequestDTO	Parameters for query result pagination.
PageResponseDTO	Additional information for query results with applied PageRequestDTO.
ParseDocumentTemplateContentRequestDTO	The parameters for an extraction of a part of the document template.
ParseDocumentTemplateContentResponseDTO	Contains the generated result and accompanying information.
ParseDocumentTemplateRequestDTO	The parameters for an extraction of a part of the document template.
ParseDocumentTemplateResponseDTO	Contains the generated document and accompanying information.
ParseProcessingOptionsDTO	Technical processing options for the document template parsing.
PDFPageNumberMappingDTO	DTO class containing page name and corresponding page numbers.
PDFPageOffsetDTO	The information about the adjustment of a page
PDFPrintSettingsDTO	Options for printing a document.
PDFTemplateDTO	This DTO can be used to reference or transfer PDF templates to the engine.
PDFTemplateFormRequestDTO	Request parameter to get the XFA form data of a template
PDFTemplateFormResponseDTO	Result of the request to get XFA form data of a template
PDFTemplatePagesRequestDTO	The parameters for the get page names business facade
PDFTemplatePagesResponseDTO	The return information that contains the page names of a PDF-XFA template
PDFTemplateValidationProblemInfoDTO	Structured information on a validation problem
PDFTemplateValidationRequestDTO	The parameters for the validation business facade
PDFTemplateValidationResponseDTO	The return information that contains the conversion problems of a PDF-XFA template (if it should be converted to Classic PDF)
PDFXFADocumentServiceTemplateDTO	An empty implementation of DocumentTemplateDTO, with predefined constants for the PDFXFA processor.
PDFXFADocumentTemplateDTO	An empty implementation of DocumentTemplateDTO, with predefined constants for the PDFXFA processor.
PrepareDocumentInstanceRequestDTO	The parameters for a single document asynchronous creation.
PrepareDocumentInstanceResponseDTO	Contains just the documentId of the staged document.
PrepareDocumentRequestDTO	The parameters for a single document asynchronous creation.
PrepareDocumentResponseDTO	Contains just the documentId of the staged document.
PrintDocumentInstanceRequestDTO
PrintDocumentInstanceResponseDTO
PrinterRawPrintOptionsDTO	Settings for printing printer raw data (in a specific printer language like PS, PCL, EPL, ZPL etc.)
PrintMonitoringOptionsDTO
PrintPDFClassicRequestDTO	Parameter DTO for printing a classic PDF document.
PrintRequestQueueACSettingsDTO	Parameter for application facade method IDocumentServiceAF.openPrintRequestQueue(de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO, PrintRequestQueueACSettingsDTO)
ProcessPDFOptionsDTO	Processing options for the pdf document.
ProcessPDFRequestDTO	Encapsulates all parameters of IDocumentCoreBF.processPDF(..)
ProcessPDFResponseDTO	The return information that contains resulting PDF-XFA PDF or Classic PDF
ProductInfoDTO	This class holds various information items of the server which serves this request.
PublishedDataFeedPartDTO	DTO to hold the data of a published data feed part.
PublishedDataTransferPackageDTO	DTO to hold the data of a published data transfer package.
PutDocTypeRequestDTO
PutDocTypeResponseDTO
PutDocTypeTemplateDTO
PutDocumentInstanceRequestDTO
PutDocumentInstanceResponseDTO
PutDocumentReferenceObjectRequestDTO
PutDocumentReferenceObjectResponseDTO
PutDocumentReferenceObjectTypeRequestDTO
PutDocumentReferenceObjectTypeResponseDTO
PutDocumentRequestDTO	Parameters to upload an external document
PutDocumentResponseDTO	Contains the documentId of the external document if the upload was successful.
PutDocumentTemplateRequestDTO	Input for IDocumentServiceBF.putDocumentTemplate(PutDocumentTemplateRequestDTO)
PutDocumentTemplateResponseDTO	Response of IDocumentServiceBF.putDocumentTemplate(PutDocumentTemplateRequestDTO).
QueryDocumentsByIdRequestDTO	The parameters to query for documents by the document id.
QueryDocumentsByRefRequestDTO	The parameters to query for documents by the reference fields.
QueryDocumentsRequestDTO	The parameters to query for documents.
QueryDocumentsResponseDTO	Contains the DocumentInfoDTOs of the queried documents.
RelativeIntervalFilterDTO	Initializes the filter with a relative time range.
ReplaceDocTypeRequestDTO
ReplaceDocTypeResponseDTO
ReplaceDocTypeTemplateDTO
ReplaceDocumentTemplateRequestDTO	Input for IDocumentServiceBF.replaceDocumentTemplate(ReplaceDocumentTemplateRequestDTO)
ReplaceDocumentTemplateResponseDTO	Response of IDocumentServiceBF.replaceDocumentTemplate(ReplaceDocumentTemplateRequestDTO).
ResponseMessageDTO	Result messages like errors or warnings.
RoleInfoDTO
RuntimeInfoDTO	This class holds various runtime information items of the server which serves this request.
RuntimeStateParmDTO	This class contains parameter about asking the server about its runtime state.
RuntimeStateResultDTO	This class holds various information items of the server which serves this request.
SchemaToXsdRequestDTO	Input for IDocumentServiceBF.schemaToXsd(SchemaToXsdRequestDTO).
SchemaToXsdResponseDTO	Response of IDocumentServiceBF.schemaToXsd(SchemaToXsdRequestDTO).
ScriptExecutionRowDTO	This dto contains the data of a single line in script result
ScriptExecutionStateParmDTO	parameters necessary to ask the server for the current state of the script execution
ScriptExecutionStateResultDTO	Contains the result information of the script execution bf
SendMailAttachmentParmDTO	Contains an attachment for an email.
SendMailParmDTO	Parameter necessary for sending a mail, describes receivers replytos ccs bccs subject content contenttype (e.g.
SendMailResultDTO	Contains the result of the sendMail method.
SetClientFeaturesRequestDTO
SetClientFeaturesResponseDTO
SetSyncEventRequestDTO	Request DTO for setting an event.
SetSyncEventResponseDTO	Response DTO for setting an event.
SimpleFileDTO	Meta-data for a transfer file.
StagedDocumentEditorParmsDTO	Parameter for application facade method IDocumentServiceAF.openStagedDocumentEditor(de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO, StagedDocumentEditorParmsDTO)
StagedDocumentOptionsDTO	Optional parameters to define, that the created document should be stored in the engine for a certain time.
StagedDocumentSearchParmsDTO	Parameter for application facade method IDocumentServiceAF.openStagedDocumentSearch(de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO, StagedDocumentSearchParmsDTO)
StartScriptExecutionParmDTO	parameters for start script execution
StartScriptExecutionResultDTO	result of start script execution
StartTableUpdateParmDTO	parameter necessary for the table update
StartTableUpdateResultDTO	Contains the result information of the start table update bf
SubscribePartnerSystemRequestDTO
SubscribePartnerSystemResponseDTO
SyncDocumentInstanceRequestDTO	Parameters for synchronizing a single external document.
SyncDocumentInstanceResponseDTO	Contains the state of the synchronization and accompanying information about the document instance.
SyncEventDTO	DTO to hold data of one synchronized event.
SyncEventsRequestDTO	Request DTO for synchronizing events.
SyncEventsResponseDTO	Response DTO for synchronizing events.
SyncPartnerSystemDTO	Identification and other data of a single partner system subscription.
SystemSearchParameterDTO	DTO used as argument to systemSearch function
SystemSearchResultDTO	DTO contained in the result array of systemSearch function
TableUpdateStateParmDTO	the parameter necessary to ask the server for the current state of the table update
TableUpdateStateResultDTO	Contains the result information of the get table update state bf
TextInLanguageDTO	A translated text in one of the specified languages.
TextTranslationDTO	Abstract superclass of DTOs to hold data text translation data.
TextTranslationRestDTO
TransferFileParameterDTO	A generic parameter for use-case specific information, e.g.
TransferFileRequestDTO	Contains information on how to chose a file transfer for further processing.
TransferFileResponseDTO	Contains the result for a transfer file request.
UnsubscribePartnerSystemRequestDTO
UnsubscribePartnerSystemResponseDTO
UpdatePrintRequestRequestDTO
UpdatePrintRequestResponseDTO
UploadFileMultiPartRequestDTO	Contains information on how a transmitted file should be processed, e.g.
UploadFileRequestDTO	Contains information on how a transmitted file should be processed, e.g.
UploadFileResponseDTO	Contains the result for a upload file request.
UploadSettingsRequestDTO	retrieves the server settings for uploading files via SFT interface
UploadSettingsResponseDTO	retrieves the server settings for uploading files via SFT interface
ValidateDocumentTemplateRequestDTO	The parameters for the document template validation
ValidateDocumentTemplateResponseDTO	Information on format or syntactic problems in a document template.
VersionInfoDTO	This class holds version information about a solution or product in a server.
WorkstationDTO
XLSXDocumentTemplateDTO	An empty implementation of DocumentTemplateDTO, with predefined constants for the XLSX processor (MS Excel).
XsdToSchemaRequestDTO	Input for IDocumentServiceBF.xsdToSchema(XsdToSchemaRequestDTO).
XsdToSchemaResponseDTO	Response of IDocumentServiceBF.xsdToSchema(XsdToSchemaRequestDTO).