Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- absoluteInterval - Variable in class de.aeb.xnsg.foundation.bf.DateTimeIntervalRangeFilterDTO
-
Pass this value if you like to have a fix interval.
- AbsoluteIntervalFilterDTO - Class in de.aeb.xnsg.foundation.bf
-
Initializes the filter with a fix interval between two dates.
- AbsoluteIntervalFilterDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AbsoluteIntervalFilterDTO
- AbstractDocTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- AbstractDocTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeRequestDTO
- AbstractDocTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- AbstractDocTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeResponseDTO
- AbstractDocTypeTemplateDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- AbstractDocTypeTemplateDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
- AbstractQueryDocumentsRequestDTO - Class in de.aeb.xnsg.docservice.bf
- AbstractQueryDocumentsRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
- AbstractQueryDocumentsRequestDTO.OrderByField - Enum Class in de.aeb.xnsg.docservice.bf
-
Query sort statement
- AbstractRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
Abstract DTO superclass with typical request data.
- AbstractRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AbstractRequestDTO
- AbstractResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Abstract DTO superclass with typical response data
- AbstractResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
- AbstractResponseItemDTO - Class in de.aeb.xnsg.foundation.bf
-
Abstract DTO superclass for item responses, sometimes contained in main responses.
- AbstractResponseItemDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
- acceptTechnology - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: VAADIN) if
null
a default technology is chosen - acknowledgeEvents(AcknowledgeEventsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncBF
-
Acknowledge events got with
ISyncBF.getNotAcknowledgedEvents(SyncEventsRequestDTO)
. - AcknowledgeEventsRequestDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
Request DTO for acknowledging events.
- AcknowledgeEventsRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.AcknowledgeEventsRequestDTO
- AcknowledgeEventsResponseDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
Response DTO for acknowledging events.
- AcknowledgeEventsResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.AcknowledgeEventsResponseDTO
- acknowledgeFile(AcknowledgeFileRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Informs the system about a received file.
- AcknowledgeFileRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains information about the result of a file transfer.
- AcknowledgeFileRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AcknowledgeFileRequestDTO
- AcknowledgeFileResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result for an acknowledge file request.
- AcknowledgeFileResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AcknowledgeFileResponseDTO
- acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IDataFeedBF
-
Acknowledge the processed published data feed parts retrieved with
IDataFeedBF.getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO)
. - AcknowledgePublishedDataFeedPartsRequestDTO - Class in de.aeb.xnsg.foundation.bf.extraction.feed.sync
-
Request parameter for Response (result) for {@link IDataFeedBF#acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO}.
- AcknowledgePublishedDataFeedPartsRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.extraction.feed.sync.AcknowledgePublishedDataFeedPartsRequestDTO
- AcknowledgePublishedDataFeedPartsResponseDTO - Class in de.aeb.xnsg.foundation.bf.extraction.feed.sync
-
Response (result) for
IDataFeedBF.acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO)
. - AcknowledgePublishedDataFeedPartsResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.extraction.feed.sync.AcknowledgePublishedDataFeedPartsResponseDTO
- acknowledgePublishedDataTransferPackages(AcknowledgePublishedDataTransferPackagesRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IDataTransferBF
-
Acknowledge the processed published data transfer packages got with
IDataTransferBF.getPublishedDataTransferPackage(GetPublishedDataTransferPackageRequestDTO)
. - AcknowledgePublishedDataTransferPackagesRequestDTO - Class in de.aeb.xnsg.foundation.bf.datatransfer.sync
- AcknowledgePublishedDataTransferPackagesRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.datatransfer.sync.AcknowledgePublishedDataTransferPackagesRequestDTO
- AcknowledgePublishedDataTransferPackagesResponseDTO - Class in de.aeb.xnsg.foundation.bf.datatransfer.sync
- AcknowledgePublishedDataTransferPackagesResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.datatransfer.sync.AcknowledgePublishedDataTransferPackagesResponseDTO
- action - Variable in class de.aeb.xnsg.docservice.af.StagedDocumentEditorParmsDTO
-
Supported editor actions: EDIT, PREVIEW, PRINT_DIALOG.
- action - Variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
- actionTimeout - Variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
-
Optional parameter to set maximum timeout in seconds for update actions.
- active - Variable in class de.aeb.xnsg.foundation.bf.ClientFeatureSetDTO
- activeSessionsCount - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
Total count of active sessions (summarized over all GUI-frameworks).
- additionalInfo - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
Additional runtime info.
- additionalProcessingOptions - Variable in class de.aeb.xnsg.docservice.bf.DocumentStorageOptionsDTO
-
For each additional processing options in this list, a new document will be created together with the original one.
- adminBfUsers - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientRequestDTO
-
The clientadmin bf users that should be created for the new client.
- adminBfUsers - Variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateRequestDTO
-
The clientadmin bf users that should be created for the new client.
- adminUiUsers - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientRequestDTO
-
The clientadmin users that should be created for the new client.
- AFExecuteProcessParmsDTO - Class in de.aeb.xnsg.foundation.af
-
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.
- AFExecuteProcessParmsDTO() - Constructor for class de.aeb.xnsg.foundation.af.AFExecuteProcessParmsDTO
- AFShellExecuteParmsDTO - Class in de.aeb.xnsg.foundation.af
-
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'.
- AFShellExecuteParmsDTO() - Constructor for class de.aeb.xnsg.foundation.af.AFShellExecuteParmsDTO
- ageInDays - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
-
Only for the initializing of delta-transmissions (if
SyncEventsRequestDTO.syncId
== null) - ajpPort - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
This is the AJP port used by the server at runtime.
- announceStop(AnnounceStopParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Announce a stop of the server at a defined time for a defined period
- AnnounceStopParmDTO - Class in de.aeb.xnsg.foundation.bf
-
parameter necessary to announce a stop of the server
- AnnounceStopParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AnnounceStopParmDTO
- AnnounceStopResultDTO - Class in de.aeb.xnsg.foundation.bf
-
the result of the announce stop business facade
- AnnounceStopResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.AnnounceStopResultDTO
- apiPredefined - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- ApplicationFacadeDTO - Class in de.aeb.xnsg.foundation.af
-
A data transfer object which describes an application facade.
- ApplicationFacadeDTO() - Constructor for class de.aeb.xnsg.foundation.af.ApplicationFacadeDTO
- ApplicationFacadeParmsDTO - Class in de.aeb.xnsg.foundation.af
-
A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
- ApplicationFacadeParmsDTO() - Constructor for class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
- archivedAt - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Time when the document contents have been archived.
- archivedState - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Archiving state
- archiveFields - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
- archiveFields - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
- ascending - Variable in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
- assignableByClientAdmin - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- attachments - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
Attachments of the mail
- authenticationStrategy - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
AuthenticationStrategy name
- autoCreateReferenceObject - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
If set to
true
the document reference object defined inDocumentInstanceReferenceDTO
will be created. - autoCreateReferenceObject - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
If set to
true
the document reference object defined inDocumentInstanceReferenceDTO
will be created. - autoCreateReferenceObjectType - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeRequestDTO
-
If set to
true
the reference object type will be created, too.
B
- bccs - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
bccs of the mail
- binaryVersion - Variable in class de.aeb.xnsg.foundation.bf.VersionInfoDTO
-
The version of the solution/product as numeric value.
- blockSize - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
-
For defining the block size.
- businessObjectId - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
-
Unique ID of the business object.
- businessObjectQualifier - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
-
Optional qualifier which can be used to specify the object in a more detailed way.
- businessObjectType - Variable in class de.aeb.xnsg.foundation.bf.sync.AcknowledgeEventsRequestDTO
-
Should be the same value, which was passed with
SyncEventsRequestDTO.businessObjectType
with the last call toISyncBF.getNotAcknowledgedEvents(SyncEventsRequestDTO)
. - businessObjectType - Variable in class de.aeb.xnsg.foundation.bf.sync.GetPartnerSystemSubscriptionsRequestDTO
-
Optional.
- businessObjectType - Variable in class de.aeb.xnsg.foundation.bf.sync.SubscribePartnerSystemRequestDTO
-
Code which identifies the subscribed business object type.
- businessObjectType - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
-
Code which identifies the business object type the event belongs to.
- businessObjectType - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
-
Optional parameter to restrict the events to be polled to that business object type.
- businessObjectType - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncPartnerSystemDTO
-
Code which identifies the subscribed business object type.
- businessObjectType - Variable in class de.aeb.xnsg.foundation.bf.sync.UnsubscribePartnerSystemRequestDTO
-
Code which identifies the subscribed business object type.
C
- cancelAnnounceStop(CancelAnnounceStopParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Cancels an announced stop of the server
- CancelAnnounceStopParmDTO - Class in de.aeb.xnsg.foundation.bf
-
parameter necessary to cancel an announced stop
- CancelAnnounceStopParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.CancelAnnounceStopParmDTO
- CancelAnnounceStopResultDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result information of the cancel announce stop bf
- CancelAnnounceStopResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.CancelAnnounceStopResultDTO
- category - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchParameterDTO
-
category to which this parameter belongs to.
- category - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
search category where this result belongs to
- category - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDateEntryDTO
-
category for the value (see TMDataCategory enum for valid values)
- category - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDoubleEntryDTO
-
category for the value (see TMDataCategory enum for valid values)
- category - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRIntegerEntryDTO
-
category for the value (see TMDataCategory enum for valid values)
- category - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRLongEntryDTO
-
category for the value (see TMDataCategory enum for valid values)
- category - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringArrayEntryDTO
-
category for the value (see TMDataCategory enum for valid values)
- category - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringEntryDTO
-
category for the value (see TMDataCategory enum for valid values)
- ccs - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
ccs of the mail
- changeAdminPassword(ChangeAdminPasswordParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Verify the old password with the old password in the parameter DTO and if its equal then changes the admin password to the new value using AdminPasswordHelper
- ChangeAdminPasswordParmDTO - Class in de.aeb.xnsg.foundation.bf
-
This class contains the old and the new admin password
- ChangeAdminPasswordParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ChangeAdminPasswordParmDTO
- ChangeAdminPasswordResultDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result information of the change admin password bf
- ChangeAdminPasswordResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ChangeAdminPasswordResultDTO
- changePwdAfterFirstLogin - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientUserDTO
- channelID - Variable in class de.aeb.xnsg.foundation.bf.TransferFileRequestDTO
-
Indicates the use-case for transferring a file.
- checksum - Variable in class de.aeb.xnsg.foundation.bf.FileDTO
-
MD5-hash of a file
- checksum - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
MD5-hash of a file
- client - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
The client of the new session.
- client - Variable in class de.aeb.xnsg.foundation.bf.remoteadministration.role.ClientRolesDTO
- CLIENT_CREATED - Static variable in class de.aeb.xnsg.foundation.bf.CreateClientResponseDTO
- CLIENT_IDENTCODE_EXISTS - Static variable in class de.aeb.xnsg.foundation.bf.CreateClientResponseDTO
- CLIENT_IDENTCODE_IS_NULL - Static variable in class de.aeb.xnsg.foundation.bf.CreateClientResponseDTO
- CLIENT_IDENTICAL_EXISTS - Static variable in class de.aeb.xnsg.foundation.bf.CreateClientResponseDTO
- clientDependentOnly - Variable in class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypesRequestDTO
-
Limit to records that belong to the current client.
- ClientDTO - Class in de.aeb.xnsg.foundation.bf
-
Data Transfer Object for Clients
- ClientDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ClientDTO
- ClientFeatureDTO - Class in de.aeb.xnsg.foundation.bf
- ClientFeatureDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ClientFeatureDTO
- clientFeatures - Variable in class de.aeb.xnsg.foundation.bf.GetClientFeaturesResponseDTO
- clientFeatures - Variable in class de.aeb.xnsg.foundation.bf.SetClientFeaturesRequestDTO
- ClientFeatureSetDTO - Class in de.aeb.xnsg.foundation.bf
- ClientFeatureSetDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ClientFeatureSetDTO
- clientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.AbstractRequestDTO
-
Client identification code.
- clientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.CreateClientRequestDTO
-
The identification code of the client.
- clientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.GenerateClientIdentCodeRequestDTO
-
client ident code of a client in the requesting application for which a unique non existing client ident code should be generated
- clientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- clientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.TransferFileRequestDTO
-
An identCode of the client.
- clientIdentCodes - Variable in class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesRequestDTO
-
When given the client dependent roles are restricted to the Client's with the correspondent identCodes.
- clientRoles - Variable in class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesResponseDTO
- ClientRolesDTO - Class in de.aeb.xnsg.foundation.bf.remoteadministration.role
-
Response DTO for listing client specific roles in
GetRolesResponseDTO
. - ClientRolesDTO() - Constructor for class de.aeb.xnsg.foundation.bf.remoteadministration.role.ClientRolesDTO
- clientSystemId - Variable in class de.aeb.xnsg.foundation.bf.AbstractRequestDTO
-
Id of the sending client system.
- clientSystemId - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncPartnerSystemDTO
-
Id of the sending client system (e.g.
- clientToDuplicateIdentCode - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientRequestDTO
-
The id of the client that should be duplicated.
- clone() - Method in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
- clusterRemark - Variable in class de.aeb.xnsg.foundation.bf.RuntimeStateResultDTO
-
The remark for the installation cluster.
- clusterRole - Variable in class de.aeb.xnsg.foundation.bf.RuntimeStateResultDTO
-
The role of the installation cluster.
- code - Variable in class de.aeb.xnsg.docservice.bf.LocalizedIdentCodeDTO
- columns - Variable in class de.aeb.xnsg.foundation.bf.ScriptExecutionRowDTO
-
columns of a row
- ComboboxEntryDTO - Class in de.aeb.xnsg.foundation.bf
-
For common use in BF methods which return combobox entries, e.g.
- ComboboxEntryDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ComboboxEntryDTO
- compareTo(VersionInfoDTO) - Method in class de.aeb.xnsg.foundation.bf.VersionInfoDTO
- content - Variable in class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentResponseDTO
-
The content of the resulting data as byte array.
- content - Variable in class de.aeb.xnsg.documentcore.bf.DocumentTemplateDTO
-
Contains optionally the content of the document template.
- content - Variable in class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateResponseDTO
-
The content of the resulting data as byte array.
- content - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateDTO
-
Contains optionally the content of the PDF template.
- content - Variable in class de.aeb.xnsg.foundation.bf.FileDTO
-
The content of a file
- content - Variable in class de.aeb.xnsg.foundation.bf.ScriptExecutionStateResultDTO
-
this table represents the result of the script execution
- content - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
content of the mail
- contents - Variable in class de.aeb.xnsg.foundation.af.AFShellExecuteParmsDTO
-
this is the contents that has to be written to the file
- contentType - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
content-type of the mail
- contentVariant - Variable in class de.aeb.xnsg.docservice.bf.DocumentContentStoreInfoDTO
-
Variant of the document content to distinguish the contents of a document by its format
- contentVariant - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstanceRequestDTO
-
A document may contain multiple contents, which are distinguished by the contentVariant (format of the documentContent).
- contentVariant - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentRequestDTO
-
A document may contain multiple contents, which are distinguished by the contentVariant (format of the documentContent).
- convertToUploadFileRequestDTO() - Method in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
- countAll - Variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
-
Indicates that the total number of available elements will be calculated and returned in the response.
- createClient(CreateClientRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Create a new client with the given parameters
- createClientFromTemplate(CreateClientFromTemplateRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IInternalProvisioningBF
-
Creates a new client by duplicating it from a given template client.
- CreateClientFromTemplateRequestDTO - Class in de.aeb.xnsg.foundation.bf.provisioning
-
Request parameters for creating a client by duplicating another.
- CreateClientFromTemplateRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateRequestDTO
- CreateClientFromTemplateResponseDTO - Class in de.aeb.xnsg.foundation.bf.provisioning
-
Result DTO for starting a client duplication process.
- CreateClientFromTemplateResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateResponseDTO
- CreateClientRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
this DTO is used for the method
IFoundationBF.createClient(CreateClientRequestDTO)
to encapsulate the request parameters. - CreateClientRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.CreateClientRequestDTO
- CreateClientResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
this DTO is used for the method
IFoundationBF.createClient(CreateClientRequestDTO)
to encapsulate the response parameters. - CreateClientResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.CreateClientResponseDTO
- CreateClientResponseDTO(String) - Constructor for class de.aeb.xnsg.foundation.bf.CreateClientResponseDTO
- CREATED_AT_ASC - Enum constant in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Sorted by date/time of document creation, oldest first.
- CREATED_AT_ASC - Enum constant in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- CREATED_AT_DESC - Enum constant in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Sorted by date/time of document creation, newest first.
- CREATED_AT_DESC - Enum constant in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- createdAt - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Time when the document creation has been requested.
- createdAtRange - Variable in class de.aeb.xnsg.docservice.af.StagedDocumentSearchParmsDTO
-
Only documents within the defined range will be returned.
- createdAtRange - Variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
Only documents within the defined range will be returned.
- createDefaultResources - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
-
If true, default resources (e.g.
- createDefaultResources - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
-
If true, default resources (e.g.
- CreateDocTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- CreateDocTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.CreateDocTypeRequestDTO
- CreateDocTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- CreateDocTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.CreateDocTypeResponseDTO
- CreateDocTypeTemplateDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- CreateDocTypeTemplateDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.CreateDocTypeTemplateDTO
- createDocument(CreateDocumentRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Creates a document from the referenced template and document data.
- createDocumentInstance(CreateDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Creates a document from the referenced document type and document data.
- CreateDocumentInstanceRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
Parameters for a single document creation.
- CreateDocumentInstanceRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
- CreateDocumentInstanceResponseDTO - Class in de.aeb.xnsg.docservice.bf
- CreateDocumentInstanceResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceResponseDTO
- CreateDocumentRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
Parameters for a single document creation.
- CreateDocumentRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
- CreateDocumentResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the created document and accompanying information.
- CreateDocumentResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO
- createDocumentTemplate(CreateDocumentTemplateRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Creates an externally managed document template.
- CreateDocumentTemplateRequestDTO - Class in de.aeb.xnsg.docservice.bf.template
- CreateDocumentTemplateRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.CreateDocumentTemplateRequestDTO
- CreateDocumentTemplateResponseDTO - Class in de.aeb.xnsg.docservice.bf.template
- CreateDocumentTemplateResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.CreateDocumentTemplateResponseDTO
- createDocumentType(CreateDocTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Creates a document type.
- createdUserName - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
User account name who created the document.
- creationTimeMillis - Variable in class de.aeb.xnsg.foundation.bf.FileDTO
-
file attribute creationTime as FileTime millis
- creationTimeMillis - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
file attribute creationTime as FileTime millis
D
- dataFeedDefinitionIdentCode - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Ident code of the corresponding data feed definition
- dataFeedPartContent - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetDataFeedPartContentResponseDTO
-
The content of the requested data feed part
- dataFeedPartId - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
The id of the published data feed part.
- dataPoolName - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionParmDTO
-
Data pool name for sql and oql scripts
- DATE_TIME_FORMAT - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for dateTime format: "yyyy-MM-dd'T'HH:mm:ss"
- DateAndZoneDTO - Class in de.aeb.xnsg.foundation.bf
-
Date and timezone.
- DateAndZoneDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DateAndZoneDTO
- dateEntries - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTelemetryReportDTO
-
all dates that should be reported
- dateInTimezone - Variable in class de.aeb.xnsg.foundation.bf.DateAndZoneDTO
-
String representation of the date/time stamp in the format yyyy-MM-dd HH:mm:ss
- DateTimeIntervalRangeFilterDTO - Class in de.aeb.xnsg.foundation.bf
-
Represents a possibility to pass a date time interval range filter.
- DateTimeIntervalRangeFilterDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DateTimeIntervalRangeFilterDTO
- de.aeb.xnsg.docservice.af - package de.aeb.xnsg.docservice.af
- de.aeb.xnsg.docservice.bf - package de.aeb.xnsg.docservice.bf
- de.aeb.xnsg.docservice.bf.doctype - package de.aeb.xnsg.docservice.bf.doctype
- de.aeb.xnsg.docservice.bf.refobject - package de.aeb.xnsg.docservice.bf.refobject
- de.aeb.xnsg.docservice.bf.reftype - package de.aeb.xnsg.docservice.bf.reftype
- de.aeb.xnsg.docservice.bf.schema - package de.aeb.xnsg.docservice.bf.schema
- de.aeb.xnsg.docservice.bf.template - package de.aeb.xnsg.docservice.bf.template
- de.aeb.xnsg.documentcore.bf - package de.aeb.xnsg.documentcore.bf
- de.aeb.xnsg.foundation.af - package de.aeb.xnsg.foundation.af
-
This business facade allows the creation of an Application session and to create applications within this session.
- de.aeb.xnsg.foundation.bf - package de.aeb.xnsg.foundation.bf
-
This business facade provides basic features of an XNSG business server, providing some information with which clients, which components and versions this server is running.
- de.aeb.xnsg.foundation.bf.datatransfer.sync - package de.aeb.xnsg.foundation.bf.datatransfer.sync
- de.aeb.xnsg.foundation.bf.extraction.feed.sync - package de.aeb.xnsg.foundation.bf.extraction.feed.sync
- de.aeb.xnsg.foundation.bf.genericdata - package de.aeb.xnsg.foundation.bf.genericdata
- de.aeb.xnsg.foundation.bf.paging - package de.aeb.xnsg.foundation.bf.paging
- de.aeb.xnsg.foundation.bf.provisioning - package de.aeb.xnsg.foundation.bf.provisioning
- de.aeb.xnsg.foundation.bf.remoteadministration.role - package de.aeb.xnsg.foundation.bf.remoteadministration.role
- de.aeb.xnsg.foundation.bf.rest - package de.aeb.xnsg.foundation.bf.rest
- de.aeb.xnsg.foundation.bf.sync - package de.aeb.xnsg.foundation.bf.sync
- de.aeb.xnsg.foundation.bf.telemetry - package de.aeb.xnsg.foundation.bf.telemetry
- debtorNumber - Variable in class de.aeb.xnsg.foundation.bf.ClientDTO
- debtorNumber - Variable in class de.aeb.xnsg.foundation.bf.CreateClientRequestDTO
-
The debtor number (Kundennummer) of a client.
- debtorNumber - Variable in class de.aeb.xnsg.foundation.bf.GenerateClientIdentCodeRequestDTO
- DEFAULT_LIMIT - Static variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- DEFAULT_MAX_RESULTS - Static variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
Default for
AbstractQueryDocumentsRequestDTO.maxResults
- DEFAULT_MAX_RESULTS - Static variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
Default for
GetDocumentReferenceObjectsRequestDTO.maxResults
- defaultDocumentLocal - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
Deprecated.
- defaultDocumentLocale - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
The default language locale for the document resources (optional, not supported for all documents).
- defaultDocumentLocale - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingOptionsDTO
-
The default language locale for the document resources (optional, not supported for all documents).
- DeleteDocTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- DeleteDocTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.DeleteDocTypeRequestDTO
- DeleteDocTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- DeleteDocTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.DeleteDocTypeResponseDTO
- deleteDocument(DeleteDocumentRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Deletes the document with the requested documentId.
- deleteDocumentInstance(DeleteDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Deletes the document instance for the given reference object and document type.
- DeleteDocumentInstanceRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to delete document instances of a reference object.
- DeleteDocumentInstanceRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DeleteDocumentInstanceRequestDTO
- DeleteDocumentInstanceResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the result of the deletion.
- DeleteDocumentInstanceResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DeleteDocumentInstanceResponseDTO
- deleteDocumentReferenceObject(DeleteDocumentReferenceObjectRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Deletes the document reference object with the requested reference type and reference number.
- DeleteDocumentReferenceObjectRequestDTO - Class in de.aeb.xnsg.docservice.bf.refobject
-
The parameters to delete a document reference object.
- DeleteDocumentReferenceObjectRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.DeleteDocumentReferenceObjectRequestDTO
- DeleteDocumentReferenceObjectResponseDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- DeleteDocumentReferenceObjectResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.DeleteDocumentReferenceObjectResponseDTO
- deleteDocumentReferenceObjectType(DeleteDocumentReferenceObjectTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Deletes the document reference object type with the requested identCode.
- DeleteDocumentReferenceObjectTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.reftype
-
The parameters to delete a document reference object type.
- DeleteDocumentReferenceObjectTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.DeleteDocumentReferenceObjectTypeRequestDTO
- DeleteDocumentReferenceObjectTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.reftype
- DeleteDocumentReferenceObjectTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.DeleteDocumentReferenceObjectTypeResponseDTO
- DeleteDocumentRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to delete a document.
- DeleteDocumentRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DeleteDocumentRequestDTO
- DeleteDocumentResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the result of the deletion.
- DeleteDocumentResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DeleteDocumentResponseDTO
- deleteDocumentTemplate(DeleteDocumentTemplateRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Deletes the document template with the given name if the template exists and if it is managed externally.
- DeleteDocumentTemplateRequestDTO - Class in de.aeb.xnsg.docservice.bf.template
- DeleteDocumentTemplateRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DeleteDocumentTemplateRequestDTO
- DeleteDocumentTemplateResponseDTO - Class in de.aeb.xnsg.docservice.bf.template
- DeleteDocumentTemplateResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DeleteDocumentTemplateResponseDTO
- deleteDocumentType(DeleteDocTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Deletes the document type with the requested identCode.
- deletePrintRequest(DeletePrintRequestRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Removes print request from queue, deletes persistent record.
- DeletePrintRequestRequestDTO - Class in de.aeb.xnsg.docservice.bf
- DeletePrintRequestRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DeletePrintRequestRequestDTO
- DeletePrintRequestResponseDTO - Class in de.aeb.xnsg.docservice.bf
- DeletePrintRequestResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DeletePrintRequestResponseDTO
- depth - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
an integer >= 0 describing the hierarchical level of the result; it can be used to format the textual output
- description - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeTranslationDTO
-
The description of the document type
- description - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
The description of the document
- description - Variable in class de.aeb.xnsg.docservice.bf.DocumentStorageOptionsDTO
-
User defined document description
- description - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
Document textual description (optional, not localized).
- description - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateDocumentationTextDTO
-
Short (one-line) template title / description.
- description - Variable in class de.aeb.xnsg.docservice.bf.WorkstationDTO
-
Description explaining the meaning of the workstation (e.g.
- description - Variable in class de.aeb.xnsg.foundation.bf.ClientFeatureDTO
- description - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientProgressResponseDTO
-
The description of the current stage of the duplication.
- description - Variable in class de.aeb.xnsg.foundation.bf.provisioning.GetCreateClientFromTemplateStatusResponseDTO
-
The description of the current stage of the duplication in the first requested language.
- description - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- description - Variable in class de.aeb.xnsg.foundation.bf.sync.SubscribePartnerSystemRequestDTO
-
Optional description of the subscription.
- description - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncPartnerSystemDTO
-
Description of the subscription.
- descriptions - Variable in class de.aeb.xnsg.foundation.bf.ComboboxEntryDTO
-
The description of the entry in the requested result languages.
- DIFFERING_FORMAT_WARNING - Static variable in interface de.aeb.xnsg.docservice.bf.IReferenceObjectTypeAware
-
Possible messageIdentCode: "DIFFERING_FORMAT_WARNING": A document reference object type has been found for the requested ident code but has a different format.
- displayFullWorkplace - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
true
to display the complete workspace (central, user and info panel). - displayStatusbar - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
true
to display statusbar,false
- displayTitlebar - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
true
to display header,false
if ac should not show header - DLFilesRefsRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains information on how to select files for transferring, e.g.
- DLFilesRefsRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DLFilesRefsRequestDTO
- DLFilesRefsResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result for a request to get the number of files available for download
- DLFilesRefsResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DLFilesRefsResponseDTO
- DocTemplateInfoDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- DocTemplateInfoDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.DocTemplateInfoDTO
- DocTypeDTO - Class in de.aeb.xnsg.docservice.bf.doctype
-
DTO class for a document type for maintenance purposes.
- DocTypeDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
- DocTypeReferenceDTO - Class in de.aeb.xnsg.docservice.bf
-
Represents a reference to a document type which is known to the document service.
- DocTypeReferenceDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocTypeReferenceDTO
- DocTypeTranslationDTO - Class in de.aeb.xnsg.docservice.bf.doctype
-
Text translations for the document type
- DocTypeTranslationDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.DocTypeTranslationDTO
- document - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
The raw document content.
- document - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentRequestDTO
-
The raw document content.
- document - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
The raw document content.
- documentation - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
- documentation - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
- documentation - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDTO
- documentationTexts - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateDocumentationDTO
- documentContent - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceResponseDTO
-
The content of the result document file as stream/byte array.
- documentContent - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO
-
The content of the result document file as stream/byte array.
- documentContent - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstanceResponseDTO
-
The content of the result document file as stream/byte array.
- documentContent - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentResponseDTO
-
The content of the result document file(s) as stream/byte array.
- documentContent - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentResponseDTO
-
The content of the result document file as byte array.
- DocumentContentStoreInfoDTO - Class in de.aeb.xnsg.docservice.bf
-
Information about the document content in document store
- DocumentContentStoreInfoDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentContentStoreInfoDTO
- documentContentStoreInfos - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Meta values of the available document contents.
- DocumentCoreTaskException - Exception in de.aeb.xnsg.documentcore.bf
-
Special exception for failed task processing in the
IDocumentCoreBF
interface. - DocumentCoreTaskException(String) - Constructor for exception de.aeb.xnsg.documentcore.bf.DocumentCoreTaskException
- DocumentCoreTaskException(String, Throwable) - Constructor for exception de.aeb.xnsg.documentcore.bf.DocumentCoreTaskException
- documentId - Variable in class de.aeb.xnsg.docservice.af.StagedDocumentEditorParmsDTO
-
The documentId of the document to be edited.
- documentId - Variable in class de.aeb.xnsg.docservice.af.StagedDocumentSearchParmsDTO
-
Criteria for the document ID of the document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceResponseDTO
-
The unique documentId for a stored document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO
-
The unique documentId for a stored document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.DeleteDocumentInstanceResponseDTO
-
ID of the deleted document instance.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.DeleteDocumentRequestDTO
-
The documentId of the document to be deleted.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Unique document identifier
- documentId - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentRequestDTO
-
The documentId of the document to be fetched.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
The unique documentId which defines the document to be printed
- documentId - Variable in class de.aeb.xnsg.docservice.bf.PrepareDocumentInstanceResponseDTO
-
The unique documentId for a stored document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.PrepareDocumentResponseDTO
-
The unique documentId for a stored document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
-
The documentId of the document to be printed.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceResponseDTO
-
The unique documentId for a stored document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentResponseDTO
-
The unique documentId for a stored document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsRequestDTO
-
Criteria for the document ID of the document.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.StagedDocumentOptionsDTO
-
The unique documentId for the stored document which has to be updated.
- documentId - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
The unique documentId for the external document to be synchronized.
- documentIdInList - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsByIdRequestDTO
-
List of document IDs (max.
- documentIdInList - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsRequestDTO
-
Deprecated.
- documentInfo - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstanceResponseDTO
-
Information about the document and other contents in the document.
- documentInfo - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentResponseDTO
-
Information about the document and other contents in the document.
- documentInfo - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceResponseDTO
-
Information about the document to be printed.
- documentInfo - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceResponseDTO
-
Information about the document and other contents in the document.
- DocumentInfoDTO - Class in de.aeb.xnsg.docservice.bf
-
Information about the document which is stored/staged for a certain period of time.
- DocumentInfoDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
- documentInfos - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstancesResponseDTO
-
Information about the queried documents and their contents.
- documentInfos - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsResponseDTO
-
Information about the queried documents and its contents.
- documentInfos - Variable in class de.aeb.xnsg.docservice.bf.refobject.DocumentReferenceObjectDTO
-
Information about the documents and its contents of the reference object.
- DocumentInstanceInfoDTO - Class in de.aeb.xnsg.docservice.bf
-
Information about the document which is stored/staged for a certain period of time.
- DocumentInstanceInfoDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentInstanceInfoDTO
- documentInstanceReference - Variable in class de.aeb.xnsg.docservice.bf.DocumentInstanceInfoDTO
-
Information describing the referenced document instance
- DocumentInstanceReferenceDTO - Class in de.aeb.xnsg.docservice.bf
-
Represents a reference to a document instance is known to the document service.
- DocumentInstanceReferenceDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentInstanceReferenceDTO
- documentLocale - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
The language locale for the document resources (optional, not supported for all documents).
- documentLocale - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingOptionsDTO
-
The language locale for the document resources (optional, not supported for all documents).
- documentName - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingOptionsDTO
-
Suggested base file name for the document (without extension).
- documentPrintOptions - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
Additional parameters for directly printable document content (e.g.: printable raw printer data)
- documentPrintOptions - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
Additional parameters of the document content (e.g.
- DocumentPrintOptionsDTO - Class in de.aeb.xnsg.docservice.bf
-
Settings for printing the document content.
- DocumentPrintOptionsDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentPrintOptionsDTO
- DocumentProcessingInfoDTO - Class in de.aeb.xnsg.documentcore.bf
-
Structured information on a template processing problem (problem that arises during the document processing, e.g.
- DocumentProcessingInfoDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentProcessingInfoDTO
- documentProcessingOptions - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
Document processing options (format, page settings, etc.).
- documentProcessingOptions - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentRequestDTO
-
Document processing options (format, page settings, etc.).
- DocumentProcessingOptionsDTO - Class in de.aeb.xnsg.documentcore.bf
-
Processing options for a single document generation (format etc.).
- DocumentProcessingOptionsDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentProcessingOptionsDTO
- DocumentProcessingParameterDTO - Class in de.aeb.xnsg.documentcore.bf
-
Generic processing parameter, specific to each document processor.
- DocumentProcessingParameterDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
- DocumentProcessingParameterDTO(String) - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
- DocumentProcessingParameterDTO(String, String) - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
- DocumentProcessingParameterDTO(String, String, DocumentProcessingParameterDTO[]) - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
- DocumentProcessorInfoDTO - Class in de.aeb.xnsg.documentcore.bf
-
Information on a specific document processor (supported formats, parameters etc.)
- DocumentProcessorInfoDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentProcessorInfoDTO
- documentReference - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Information describing/identifying the referenced (external) document
- documentReference - Variable in class de.aeb.xnsg.docservice.bf.StagedDocumentOptionsDTO
-
Document reference (type of the document, type of the reference object and its number).
- DocumentReferenceDTO - Class in de.aeb.xnsg.docservice.bf
-
A Document Service document references an external object that is not stored in the engine.
- DocumentReferenceDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentReferenceDTO
- DocumentReferenceObjectDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- DocumentReferenceObjectDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.DocumentReferenceObjectDTO
- documentReferenceObjectRef - Variable in class de.aeb.xnsg.docservice.bf.DocumentInstanceReferenceDTO
-
Reference of document's reference object (type of the reference object and its number).
- DocumentReferenceObjectReferenceDTO - Class in de.aeb.xnsg.docservice.bf
- DocumentReferenceObjectReferenceDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentReferenceObjectReferenceDTO
- DocumentReferenceObjectTypeDTO - Class in de.aeb.xnsg.docservice.bf.reftype
-
DTO class for a document reference object type for maintenance purposes.
- DocumentReferenceObjectTypeDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.DocumentReferenceObjectTypeDTO
- DocumentReferenceObjectTypeTranslationDTO - Class in de.aeb.xnsg.docservice.bf.reftype
-
Text translations for the document reference object type
- DocumentReferenceObjectTypeTranslationDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.DocumentReferenceObjectTypeTranslationDTO
- DocumentReferencesDTO - Class in de.aeb.xnsg.docservice.bf
- DocumentReferencesDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentReferencesDTO
- documentReferencesInList - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsByRefRequestDTO
-
List of document references (combination of a
referenceType
, list ofreferenceNumber
s and list ofdocumentType
s). - DocumentServiceTaskException - Exception in de.aeb.xnsg.docservice.bf
-
Special exception for failed task processing in the
IDocumentServiceBF
interface. - DocumentServiceTaskException(String) - Constructor for exception de.aeb.xnsg.docservice.bf.DocumentServiceTaskException
- DocumentServiceTaskException(String, Throwable) - Constructor for exception de.aeb.xnsg.docservice.bf.DocumentServiceTaskException
- documentStorageKeys - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
A list of
StorageKeyFieldDTO
which are defined/set by the business application to specify the search in the document storage.
These keys are only used if the archiving is enabled in the document type. - documentStorageKeys - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
A list of
StorageKeyFieldDTO
which are defined/set by the business application to specify the storage and search in the document storage.
These keys are only used if the archiving is enabled in the document type. - documentStorageOptions - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
Document storage options (reference-id, name, keys, additional formats etc.).
- documentStorageOptions - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentRequestDTO
-
Document storage options (name, keys).
- DocumentStorageOptionsDTO - Class in de.aeb.xnsg.docservice.bf
-
Settings for the document content storage processing.
- DocumentStorageOptionsDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentStorageOptionsDTO
- DocumentTemplateArchiveFieldDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateArchiveFieldDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateArchiveFieldDTO
- DocumentTemplateDocumentationDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateDocumentationDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateDocumentationDTO
- DocumentTemplateDocumentationTextDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateDocumentationTextDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateDocumentationTextDTO
- DocumentTemplateDTO - Class in de.aeb.xnsg.documentcore.bf
-
This DTO can be used to reference or transfer document templates to the engine.
- DocumentTemplateDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentTemplateDTO
- DocumentTemplateDTO(String) - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentTemplateDTO
- DocumentTemplateExampleFileDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateExampleFileDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateExampleFileDTO
- DocumentTemplateInfoDTO - Class in de.aeb.xnsg.docservice.bf
-
Document template descriptor
- DocumentTemplateInfoDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentTemplateInfoDTO
- DocumentTemplateInputRequestDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateInputRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
- DocumentTemplateLocalizedTextDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateLocalizedTextDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateLocalizedTextDTO
- DocumentTemplateLocalizedTextsDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateLocalizedTextsDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateLocalizedTextsDTO
- DocumentTemplateReferenceDTO - Class in de.aeb.xnsg.docservice.bf
-
Represents a reference to a document templates which is known to the document service.
- DocumentTemplateReferenceDTO() - Constructor for class de.aeb.xnsg.docservice.bf.DocumentTemplateReferenceDTO
- DocumentTemplateReferenceDTO(String) - Constructor for class de.aeb.xnsg.docservice.bf.DocumentTemplateReferenceDTO
- DocumentTemplateSchemaDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateSchemaDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaDTO
- DocumentTemplateSchemaFieldDocumentationDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateSchemaFieldDocumentationDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDocumentationDTO
- DocumentTemplateSchemaFieldDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateSchemaFieldDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDTO
- DocumentTemplateSchemaObjectTypeDTO - Class in de.aeb.xnsg.docservice.bf.template
- DocumentTemplateSchemaObjectTypeDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaObjectTypeDTO
- documentType - Variable in class de.aeb.xnsg.docservice.af.StagedDocumentSearchParmsDTO
-
Criteria for the document type of the document.
- documentType - Variable in class de.aeb.xnsg.docservice.bf.doctype.GetDocTypeResponseDTO
-
Returns the
DocTypeDTO
. - documentType - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferenceDTO
-
Brief name of the referenced (external) document, e.g.
- documentType - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsRequestDTO
-
Criteria for the document type of the document.
- documentTypeInList - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferencesDTO
-
List of the referenced (external) document types, e.g.
- documentTypeRef - Variable in class de.aeb.xnsg.docservice.bf.DocumentInstanceReferenceDTO
-
Reference of the associated document type.
- documentTypes - Variable in class de.aeb.xnsg.docservice.bf.doctype.GetDocTypesResponseDTO
-
Returns all
DocTypeDTO
s. - DocumentValidationInfoDTO - Class in de.aeb.xnsg.documentcore.bf
-
Structured information on a template validation problem
- DocumentValidationInfoDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.DocumentValidationInfoDTO
- DOCXDocumentTemplateDTO - Class in de.aeb.xnsg.documentcore.bf
-
An empty implementation of DocumentTemplateDTO, with predefined constants for the DOCX processor (MS Word).
- DOCXDocumentTemplateDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
- doubleEntries - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTelemetryReportDTO
-
all double values that should be reported
- downloadableFilesReferences - Variable in class de.aeb.xnsg.foundation.bf.DLFilesRefsResponseDTO
-
The references of files available for download
- downloadFile - Variable in class de.aeb.xnsg.foundation.bf.DownloadFileResponseDTO
-
The requested file, selected or generated depending on the use-case.
- downloadFile(DownloadFileRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Requests a file for transferring.
- DownloadFileRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains information on how to select a file for transferring, e.g.
- DownloadFileRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DownloadFileRequestDTO
- DownloadFileResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result for a download file request.
- DownloadFileResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DownloadFileResponseDTO
- dummy - Variable in class de.aeb.xnsg.foundation.bf.ScriptExecutionRowDTO
- DuplicateClientProgressResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains information about the current progress of a client duplication.
- DuplicateClientProgressResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DuplicateClientProgressResponseDTO
- DuplicateClientRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
DTO with the configuration for duplication of a client.
- DuplicateClientRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DuplicateClientRequestDTO
- DuplicateClientResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Response for duplicateClient() call.
- DuplicateClientResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DuplicateClientResponseDTO
- DuplicateClientUserDTO - Class in de.aeb.xnsg.foundation.bf
-
DTO for creating a user when duplicating a client.
- DuplicateClientUserDTO() - Constructor for class de.aeb.xnsg.foundation.bf.DuplicateClientUserDTO
- DUPLICATION_FAILED - Static variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateResponseDTO
-
Error code that indicates the duplication process could not be started.
- DUPLICATION_PROCESS_ERROR - Static variable in class de.aeb.xnsg.foundation.bf.provisioning.GetCreateClientFromTemplateStatusResponseDTO
-
Error code that indicates the duplication process failed.
- DUPLICATION_PROCESS_WARNING - Static variable in class de.aeb.xnsg.foundation.bf.provisioning.GetCreateClientFromTemplateStatusResponseDTO
-
Error code that indicates warnings in the duplication process.
- duplicationAllowed - Variable in class de.aeb.xnsg.foundation.bf.ClientDTO
-
true if the client can be duplicated with BF call
- duration - Variable in class de.aeb.xnsg.foundation.bf.IntervalFromNowFilterDTO
-
Defines the duration for the interval from 'now'.
E
- EDIT - Static variable in class de.aeb.xnsg.docservice.af.StagedDocumentEditorParmsDTO
-
Open editor to modify document content.
- effectiveOutputSettings - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceResponseDTO
-
The expected printer settings in the context known at the current time.
- element - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingInfoDTO
-
Full path to the processed element.
- element - Variable in class de.aeb.xnsg.documentcore.bf.DocumentValidationInfoDTO
-
Full path to the validated element
- element - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationProblemInfoDTO
-
Full path to the validated element
- EMPTY_MANDATORY_FIELD - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
Possible messageIdentCode: "EMPTY_MANDATORY_FIELD " : One ore more of the mandatory fields are empty.
- EMPTY_MANDATORY_FIELD - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
-
Possible messageIdentCode: "EMPTY_MANDATORY_FIELD": One ore more of the mandatory fields are empty.
- equals(Object) - Method in class de.aeb.xnsg.foundation.bf.DateAndZoneDTO
- equals(Object) - Method in class de.aeb.xnsg.foundation.bf.SimpleFileDTO
- errorCode - Variable in class de.aeb.xnsg.foundation.bf.TransferFileResponseDTO
-
A short error code.
- errorMessage - Variable in class de.aeb.xnsg.foundation.bf.SendMailResultDTO
-
error-message, if an error occured
- errorMessage - Variable in class de.aeb.xnsg.foundation.bf.TransferFileResponseDTO
-
A human-readable error message which can be used for logging or displayed by the calling process.
- errors - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientProgressResponseDTO
-
Errors that happened during the duplication process.
- event - Variable in class de.aeb.xnsg.foundation.bf.sync.SetSyncEventRequestDTO
-
The event to set.
- eventDate - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
-
Date when the event happened.
- events - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsResponseDTO
-
The resulting events, matching the requested parameters.
- eventType - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
-
Type of the event (e.g.
- exampleFiles - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
- exampleFiles - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
- executableFile - Variable in class de.aeb.xnsg.foundation.af.AFExecuteProcessParmsDTO
-
the name of the executable (including path name, or expected to be found within search path) This must not contain any parameters, and it must not be enclosed with quotes even if the string contains spaces.
- executeProcess - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeDTO
-
parameters when application is to be invoked via create process
- expectedDowntimeMinutes - Variable in class de.aeb.xnsg.foundation.bf.AnnounceStopParmDTO
-
the server will be down for the period in minutes
- externalSystemId - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMIdentificationRequestDTO
-
Id of the external system.
- externalSystemId - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMResponseDTO
-
Id of the external system.
- externalSystemId - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMStatusResponseDTO
-
Id of the external system.
- externalTag - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
-
Document template will be tagged with this value.
- externalTag - Variable in class de.aeb.xnsg.docservice.bf.DocTypeReferenceDTO
-
The desired external tag of the document template which is used by the document type.
- externalTag - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateReferenceDTO
-
The desired external tag of the document template.
- externalTag - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
-
Document template will be tagged with this value.
- ExternalTelemetryReportDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
Data for a single telemetry report.
- ExternalTelemetryReportDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTelemetryReportDTO
- ExternalTMIdentificationRequestDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
Basic Request DTO for telemetry requests.
- ExternalTMIdentificationRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMIdentificationRequestDTO
- ExternalTMRDateEntryDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
telemetry report entry for date values
- ExternalTMRDateEntryDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDateEntryDTO
- ExternalTMRDoubleEntryDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
telemetry report entry for double values
- ExternalTMRDoubleEntryDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDoubleEntryDTO
- ExternalTMReportRequestDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
Request DTO for sending a report from a third party system to the telemetry infrastructure.
- ExternalTMReportRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMReportRequestDTO
- ExternalTMResponseDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
Response DTO for all calls to the
IExternalTelemetryBF
interface. - ExternalTMResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMResponseDTO
- ExternalTMRIntegerEntryDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
telemetry report entry for integer values
- ExternalTMRIntegerEntryDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRIntegerEntryDTO
- ExternalTMRLongEntryDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
telemetry report entry for long values
- ExternalTMRLongEntryDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRLongEntryDTO
- ExternalTMRStringArrayEntryDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
telemetry report entry for string array values
- ExternalTMRStringArrayEntryDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringArrayEntryDTO
- ExternalTMRStringEntryDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
telemetry report entry for string values
- ExternalTMRStringEntryDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringEntryDTO
- ExternalTMStatusResponseDTO - Class in de.aeb.xnsg.foundation.bf.telemetry
-
Response DTO for the
IExternalTelemetryBF.getTelemetryStatus(de.aeb.xnsg.foundation.bf.telemetry.ExternalTMIdentificationRequestDTO)
method. - ExternalTMStatusResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMStatusResponseDTO
F
- field - Variable in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
- fields - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaObjectTypeDTO
- fields - Variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataRecordDTO
-
The fields of the record.
- fileContent - Variable in class de.aeb.xnsg.foundation.bf.SendMailAttachmentParmDTO
-
Content of the attachment file
- fileContentType - Variable in class de.aeb.xnsg.foundation.bf.SendMailAttachmentParmDTO
-
Content-type of the attachment (e.g.
- FileDTO - Class in de.aeb.xnsg.foundation.bf
-
Data Transfer Object for a file.
- FileDTO() - Constructor for class de.aeb.xnsg.foundation.bf.FileDTO
- FileDTO(File) - Constructor for class de.aeb.xnsg.foundation.bf.FileDTO
- fileExtension - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Extension of the data feed part as a file, e.g.
- filename - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateInfoDTO
-
The base file name of the document template.
- filename - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateReferenceDTO
-
The relative file name of the document template in the file system (without path).
- filename - Variable in class de.aeb.xnsg.documentcore.bf.DocumentTemplateDTO
-
The relative file name of the document template in the file system (without path).
- filename - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateDTO
-
The relative file name of the PDF template in the file system (without path).
- fileName - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
The file name of the document file.
- fileName - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentRequestDTO
-
The file name of the document file.
- fileName - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
The file name of the document file.
- fileName - Variable in class de.aeb.xnsg.foundation.af.AFShellExecuteParmsDTO
-
this is the name of the file that has to be created in some temporary directory and filled with what contents contains
- fileName - Variable in class de.aeb.xnsg.foundation.bf.SendMailAttachmentParmDTO
-
Name of the attachment file
- fileReference - Variable in class de.aeb.xnsg.foundation.bf.AcknowledgeFileRequestDTO
-
The file which was transferred.
- fileReference - Variable in class de.aeb.xnsg.foundation.bf.DownloadFileRequestDTO
-
reference to file for download
- format - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingOptionsDTO
-
Output format tag.
- FORMAT_DOCX - Static variable in class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
-
DOCX (MS Word default)
- FORMAT_HTML - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
HTML, layout and data preview
- FORMAT_HTML_EDIT - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
HTML, layout and data editor
- FORMAT_PDF - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
PDF - print as PDF
- FORMAT_PDF - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF 1.5, layout and data (standard for e-distribution)
- FORMAT_PDF_DATA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF 1.5, data only (currently unused - see the PDF/a version)
- FORMAT_PDF_PRINTDATA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF 1.5, layout preview, print data only
- FORMAT_PDFA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF/a, layout and data
- FORMAT_PDFA_DATA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF/a, data only
- FORMAT_PRN - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
PRN - printer native language (ZPL/EPL), according to the selected printer
- FORMAT_XFA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF-XFA, layout and data (standard for editing)
- FORMAT_XFA_DATA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF-XFA, data only (currently unused - has practically no sense)
- FORMAT_XFA_PRINTDATA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
PDF-XFA, layout preview, print data only
- FORMAT_XLSX - Static variable in class de.aeb.xnsg.documentcore.bf.XLSXDocumentTemplateDTO
-
XLSX (MS Excel default)
- from - Variable in class de.aeb.xnsg.foundation.bf.AbsoluteIntervalFilterDTO
-
Start date of the interval in the format 'yyyy-MM-dd[ HH:mm:ss[z]]' (the time and zone is optional).
- from - Variable in class de.aeb.xnsg.foundation.bf.RelativeIntervalFilterDTO
-
Defines the 'from' interval.
- fromArchive - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstanceResponseDTO
-
true
if the document and its contents was fetched from the archive. - fromArchive - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentResponseDTO
-
true
if the document and its contents was fetched from the archive.
G
- generate(GenerateDocumentRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Generates a document from the provided template and document data.
- generateClientIdentCode(GenerateClientIdentCodeRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Generates a unique non existing client ident code for the given parameters
- GenerateClientIdentCodeRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
this DTO is used for the method
IFoundationBF.generateClientIdentCode(ClientIdentCodeGenerationRequestDTO)
to encapsulate the request parameters. - GenerateClientIdentCodeRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.GenerateClientIdentCodeRequestDTO
- GenerateClientIdentCodeRequestDTO(String, String) - Constructor for class de.aeb.xnsg.foundation.bf.GenerateClientIdentCodeRequestDTO
- GenerateDocumentRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
The parameters for a single document generation.
- GenerateDocumentRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.GenerateDocumentRequestDTO
- GenerateDocumentResponseDTO - Class in de.aeb.xnsg.documentcore.bf
-
Contains the generated document and accompanying information.
- GenerateDocumentResponseDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.GenerateDocumentResponseDTO
- generationState - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Document content generation/creation state.
- GenericDataFieldDTO - Class in de.aeb.xnsg.foundation.bf.genericdata
-
A field of a generic data record.
- GenericDataFieldDTO() - Constructor for class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
- GenericDataRecordDTO - Class in de.aeb.xnsg.foundation.bf.genericdata
-
A generic record of data.
From within Java, consider to use the wrapper classde.aeb.xnsg.foundation.bc.genericdata.GenericDataRecordDTOWrapper
for easier handling andde.aeb.xnsg.foundation.bc.genericdata.GenericDataRecordDTOMapping
for mapping from and to other DTOs. - GenericDataRecordDTO() - Constructor for class de.aeb.xnsg.foundation.bf.genericdata.GenericDataRecordDTO
- getAllActiveClients() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Returns all active Client's defined in the system.
- getAllClients() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Returns all Client's defined in the system.
- getAllMonitoringValues() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Returns all available monitoring values of the server
- getAscending() - Method in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
- getAscending() - Method in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- getBuildForSolution(String) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Return the build information of a solution that is deployed in the product on this server.
- getClientFeatures(GetClientFeaturesRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IInternalProvisioningBF
-
Retrieve all client features for a given client.
- GetClientFeaturesRequestDTO - Class in de.aeb.xnsg.foundation.bf
- GetClientFeaturesRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.GetClientFeaturesRequestDTO
- GetClientFeaturesResponseDTO - Class in de.aeb.xnsg.foundation.bf
- GetClientFeaturesResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.GetClientFeaturesResponseDTO
- getCreateClientFromTemplateStatus(GetCreateClientFromTemplateStatusRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IInternalProvisioningBF
-
Retrieve the status of an ongoing or completed client duplication process started by
IInternalProvisioningBF.createClientFromTemplate(CreateClientFromTemplateRequestDTO)
. - GetCreateClientFromTemplateStatusRequestDTO - Class in de.aeb.xnsg.foundation.bf.provisioning
-
Request parameters for querying a duplication process' status.
- GetCreateClientFromTemplateStatusRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.provisioning.GetCreateClientFromTemplateStatusRequestDTO
- GetCreateClientFromTemplateStatusResponseDTO - Class in de.aeb.xnsg.foundation.bf.provisioning
-
Status of an ongoing or completed client duplication process started by
IInternalProvisioningBF.createClientFromTemplate(CreateClientFromTemplateRequestDTO)
- GetCreateClientFromTemplateStatusResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.provisioning.GetCreateClientFromTemplateStatusResponseDTO
- getDataFeedPartContent(GetDataFeedPartContentRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IDataFeedBF
-
Retrieve the data feed part content.
- GetDataFeedPartContentRequestDTO - Class in de.aeb.xnsg.foundation.bf.extraction.feed.sync
-
Request parameter for
IDataFeedBF.getDataFeedPartContent(GetDataFeedPartRequestDTO)
. - GetDataFeedPartContentRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetDataFeedPartContentRequestDTO
- GetDataFeedPartContentResponseDTO - Class in de.aeb.xnsg.foundation.bf.extraction.feed.sync
-
Response (result) for
IDataFeedBF.getDataFeedPartContent(GetDataFeedPartRequestDTO)
. - GetDataFeedPartContentResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetDataFeedPartContentResponseDTO
- GetDocTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- GetDocTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.GetDocTypeRequestDTO
- GetDocTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- GetDocTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.GetDocTypeResponseDTO
- GetDocTypesRequestDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- GetDocTypesRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.GetDocTypesRequestDTO
- GetDocTypesResponseDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- GetDocTypesResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.GetDocTypesResponseDTO
- getDocument(GetDocumentRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns the requested document content if it is available for the user.
- getDocumentInstance(GetDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns the document instance for the given reference object and document type.
- GetDocumentInstanceRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to fetch a document instance.
- GetDocumentInstanceRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetDocumentInstanceRequestDTO
- GetDocumentInstanceResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the document content of the requested document and its
DocumentInstanceInfoDTO
s. - GetDocumentInstanceResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetDocumentInstanceResponseDTO
- getDocumentInstances(GetDocumentInstancesRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns the document instances for the given reference object (and optionally document type).
- GetDocumentInstancesRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to fetch document instances of a reference object.
- GetDocumentInstancesRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetDocumentInstancesRequestDTO
- GetDocumentInstancesResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the
DocumentInstanceInfoDTO
s of a reference object. - GetDocumentInstancesResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetDocumentInstancesResponseDTO
- getDocumentReferenceObject(GetDocumentReferenceObjectRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns the requested document reference object if it is available for the user.
- GetDocumentReferenceObjectRequestDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- GetDocumentReferenceObjectRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectRequestDTO
- GetDocumentReferenceObjectResponseDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- GetDocumentReferenceObjectResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectResponseDTO
- getDocumentReferenceObjects(GetDocumentReferenceObjectsRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Executes a search query on the document reference objects.
- GetDocumentReferenceObjectsRequestDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- GetDocumentReferenceObjectsRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
- GetDocumentReferenceObjectsRequestDTO.OrderByField - Enum Class in de.aeb.xnsg.docservice.bf.refobject
-
Query sort statement
- GetDocumentReferenceObjectsResponseDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- GetDocumentReferenceObjectsResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsResponseDTO
- getDocumentReferenceObjectType(GetDocumentReferenceObjectTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns the requested document reference object type if it is available for the user.
- GetDocumentReferenceObjectTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.reftype
- GetDocumentReferenceObjectTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypeRequestDTO
- GetDocumentReferenceObjectTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.reftype
- GetDocumentReferenceObjectTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypeResponseDTO
- getDocumentReferenceObjectTypes(GetDocumentReferenceObjectTypesRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Executes a search query on the document reference object types.
- GetDocumentReferenceObjectTypesRequestDTO - Class in de.aeb.xnsg.docservice.bf.reftype
- GetDocumentReferenceObjectTypesRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypesRequestDTO
- GetDocumentReferenceObjectTypesResponseDTO - Class in de.aeb.xnsg.docservice.bf.reftype
- GetDocumentReferenceObjectTypesResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypesResponseDTO
- GetDocumentRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to fetch a created document.
- GetDocumentRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetDocumentRequestDTO
- GetDocumentResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the document content of the requested document and its
DocumentInfoDTO
s. - GetDocumentResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetDocumentResponseDTO
- getDocumentTemplateInfos(String) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns a list of available templates for the specified processor.
- getDocumentType(GetDocTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns the requested document type if it is available for the user.
- getDocumentTypes(GetDocTypesRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Executes a search query on the document types.
- getDownloadableFilesRefs(DLFilesRefsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Returns the number of files available for download.
- getField() - Method in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
- getField() - Method in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- getFileChecksum(File) - Static method in class de.aeb.xnsg.foundation.bf.FileDTO
-
Get the MD5 Hash from a file.
- getFormOfPDFXFATemplate(PDFTemplateFormRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Deprecated.use
IDocumentCoreBF.parse(ParseDocumentTemplateRequestDTO)
with the "PDFXFA" processor (seePDFXFADocumentTemplateDTO.PROCESSOR
) and query "XFAForm" (seePDFXFADocumentTemplateDTO.PARSE_QUERY_XFA_FORM
- getMonitoringValue(String, String) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Returns the current monitoring value for the given group and name
- getNotAcknowledgedEvents(SyncEventsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncBF
-
Poll any not acknowledged events for the client system.
This method does not require, that the client system fillsSyncEventsRequestDTO.syncId
.
However, it requires, that a call toISyncBF.acknowledgeEvents(AcknowledgeEventsRequestDTO)
is done for acknowledge of the events. - getNumberOfClients() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
- getPageNamesOfPDFXFATemplate(PDFTemplatePagesRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Deprecated.use
IDocumentCoreBF.parse(ParseDocumentTemplateRequestDTO)
with the "PDFXFA" processor (seePDFXFADocumentTemplateDTO.PROCESSOR
) and query "PageNames" (seePDFXFADocumentTemplateDTO.PARSE_QUERY_PAGE_NAMES
- getPartnerSystemSubscriptions(GetPartnerSystemSubscriptionsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncBF
-
Fetch a list of registered subscriptions (either all or filtered by the business object type).
Only subscription belonging to the providedclientSystemId
are returned (mandatory field) - GetPartnerSystemSubscriptionsRequestDTO - Class in de.aeb.xnsg.foundation.bf.sync
- GetPartnerSystemSubscriptionsRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.GetPartnerSystemSubscriptionsRequestDTO
- GetPartnerSystemSubscriptionsResponseDTO - Class in de.aeb.xnsg.foundation.bf.sync
- GetPartnerSystemSubscriptionsResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.GetPartnerSystemSubscriptionsResponseDTO
- getPrintRequests(GetPrintRequestsRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns list of all print requests for the specified queue (default: active only).
- GetPrintRequestsRequestDTO - Class in de.aeb.xnsg.docservice.bf
- GetPrintRequestsRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetPrintRequestsRequestDTO
- GetPrintRequestsResponseDTO - Class in de.aeb.xnsg.docservice.bf
- GetPrintRequestsResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetPrintRequestsResponseDTO
- getPrintRequestState(GetPrintRequestStateRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns the state of a print request identified by its unique ID (obtained by
IDocumentServiceBF.printDocumentInstance(PrintDocumentInstanceRequestDTO)
. - GetPrintRequestStateRequestDTO - Class in de.aeb.xnsg.docservice.bf
- GetPrintRequestStateRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetPrintRequestStateRequestDTO
- GetPrintRequestStateResponseDTO - Class in de.aeb.xnsg.docservice.bf
- GetPrintRequestStateResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
- getProcessorInfo(String) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Returns an information on functions and/or features supported by the processor.
- getProcessorInfo(String) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Returns an information on functions and/or features supported by the processor.
- getProductInfo() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Return information about the server that is answering this request.
- getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IDataFeedBF
-
Poll data about the next 10 published data feed parts.
- GetPublishedDataFeedPartsRequestDTO - Class in de.aeb.xnsg.foundation.bf.extraction.feed.sync
-
Request parameter for
IDataFeedBF.getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO)
. - GetPublishedDataFeedPartsRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetPublishedDataFeedPartsRequestDTO
- GetPublishedDataFeedPartsResponseDTO - Class in de.aeb.xnsg.foundation.bf.extraction.feed.sync
-
Response (result) for
IDataFeedBF.getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO)
. - GetPublishedDataFeedPartsResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetPublishedDataFeedPartsResponseDTO
- getPublishedDataTransferPackage(GetPublishedDataTransferPackageRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IDataTransferBF
-
Poll the next published data transfer package.
Since a package can be very large a maximum of one packet is returned per request. - GetPublishedDataTransferPackageRequestDTO - Class in de.aeb.xnsg.foundation.bf.datatransfer.sync
-
Request parameter for
IDataTransferBF.getPublishedDataTransferPackage(GetPublishedDataTransferPackageRequestDTO)
. - GetPublishedDataTransferPackageRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.datatransfer.sync.GetPublishedDataTransferPackageRequestDTO
- GetPublishedDataTransferPackageResponseDTO - Class in de.aeb.xnsg.foundation.bf.datatransfer.sync
-
Response (result) for
IDataTransferBF.getPublishedDataTransferPackage(GetPublishedDataTransferPackageRequestDTO)
. - GetPublishedDataTransferPackageResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.datatransfer.sync.GetPublishedDataTransferPackageResponseDTO
- getRoles(GetRolesRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IRemoteAdminBF
-
Returns the client independent roles of this installation and client dependent roles of all clients (or restricted by the request parameter).
- GetRolesRequestDTO - Class in de.aeb.xnsg.foundation.bf.remoteadministration.role
-
DTO for GetRoles requests
- GetRolesRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesRequestDTO
- GetRolesResponseDTO - Class in de.aeb.xnsg.foundation.bf.remoteadministration.role
- GetRolesResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesResponseDTO
- getRuntimeInfo() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Return runtime information about the server that is answering this request.
- getScriptExecutionState(ScriptExecutionStateParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Asks the server for the result of the script execution
- getSupportedProcessors() - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Collects tags of all document processors that are supported in this service.
- getSupportedProcessors() - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Collects tags of all document processors that are supported in the system.
- getTableUpdateState(TableUpdateStateParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Asks the server for the current state of the table update
- getTelemetryStatus(ExternalTMIdentificationRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IExternalTelemetryBF
- getTelemetryStatusByParams(String, String) - Method in interface de.aeb.xnsg.foundation.bf.IExternalTelemetryBF
- getUploadSettings(UploadSettingsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Receives information about uploadFile server settings
- getVersionForSolution(String) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Return the version information of a solution that is deployed in the product on this server.
- getWorkplaceURL() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Returns the HTTP URL to open the workplace.
- getWorkstations() - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
- globalPageOffset - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
Global page offset adjustments when converting XFA -> classic PDF.
- groupName - Variable in class de.aeb.xnsg.foundation.bf.MonitoringDataProviderDTO
-
Name of the group.
H
- hasErrors - Variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
True, if there are any errors.
- hasErrors - Variable in class de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
-
True, if there are any error messages.
- hashCode() - Method in class de.aeb.xnsg.foundation.bf.DateAndZoneDTO
- hashCode() - Method in class de.aeb.xnsg.foundation.bf.SimpleFileDTO
- hashvalue - Variable in class de.aeb.xnsg.documentcore.bf.DocumentTemplateDTO
-
The unique hash value for the document template.
- hashvalue - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateDTO
-
The unique hash value for each PDF template.
- hasMore - Variable in class de.aeb.xnsg.foundation.bf.paging.PageResponseDTO
-
Indicates that there are more elements available to return.
- hasOnlyRetryableErrors - Variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
True if the errors signal a temporary problem, like a locked resource.
- hasWarnings - Variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
True, if there are any warnings.
- hasWarnings - Variable in class de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
-
True, if there are any warning messages.
- hint - Variable in class de.aeb.xnsg.documentcore.bf.DocumentValidationInfoDTO
-
Correction hint for the template editor/designer
- hintLCD - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationProblemInfoDTO
-
Correction hint for the Adobe LifeCycle Designer
- hostName - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
This is the name of the host, where the server is running which has answered the request
- httpPort - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
This is the HTTP port used by the server at runtime.
- httpUrl - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeDTO
-
used when the application facade is to be opened in a browser An http:// or https:// URL which is a web side to display the application facade,
I
- I18N_WARNING - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
Possible messageIdentCode: "I18N_WARNING": One of the resultLanguageIsoCodes was not supported, so there are missing languages in ResponseMessageDTO.messageTexts
- id - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetDataFeedPartContentRequestDTO
-
Unique ID of the data feed part.
- IDataFeedBF - Interface in de.aeb.xnsg.foundation.bf
- IDataTransferBF - Interface in de.aeb.xnsg.foundation.bf
-
Business facade for fetching published data transfer packages.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeRequestDTO
-
The unique identCode of the type.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.doctype.DeleteDocTypeRequestDTO
-
Unique Id of the document type to be deleted.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
-
The unique identCode of the type.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.doctype.GetDocTypeRequestDTO
-
Unique Id of the document type.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.DocTypeReferenceDTO
-
The unique identCode of the document type in the document service.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.reftype.DeleteDocumentReferenceObjectTypeRequestDTO
-
Unique Id of the document reference object type to be deleted.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.reftype.DocumentReferenceObjectTypeDTO
-
The unique identCode of the type.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypeRequestDTO
-
Unique Id of the reference object type.
- identCode - Variable in class de.aeb.xnsg.docservice.bf.reftype.PutDocumentReferenceObjectTypeRequestDTO
-
The unique identCode of the type.
- identCode - Variable in class de.aeb.xnsg.foundation.bf.ClientDTO
-
The ident code of the client length=10
- identCode - Variable in class de.aeb.xnsg.foundation.bf.ComboboxEntryDTO
-
The identCode of the entry.
- identCode - Variable in class de.aeb.xnsg.foundation.bf.datatransfer.sync.PublishedDataTransferPackageDTO
-
identCode of the published data transfer package.
- identCode - Variable in class de.aeb.xnsg.foundation.bf.rest.MoIdentCodeRestDTO
- identCode - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- IDocumentCoreBF - Interface in de.aeb.xnsg.documentcore.bf
-
Defines the business facades for processing document templates
- IDocumentServiceAF - Interface in de.aeb.xnsg.docservice.af
- IDocumentServiceBF - Interface in de.aeb.xnsg.docservice.bf
-
External interface for document processing.
- IDocumentServiceExtBF - Interface in de.aeb.xnsg.docservice.bf
-
Internal interface for document processing (not public).
- IExternalTelemetryBF - Interface in de.aeb.xnsg.foundation.bf
-
Business facade for sending telemetry data from a third party system.
- IFoundationAF - Interface in de.aeb.xnsg.foundation.af
-
Application facade for the XNSGFoundation
- IFoundationBF - Interface in de.aeb.xnsg.foundation.bf
-
Business facade for the XNSGFoundation
- ignorePendingContent - Variable in class de.aeb.xnsg.docservice.bf.DeleteDocumentInstanceRequestDTO
-
If set to
true
, the document will be deleted even when the document content is yet being generated or archived. - ignorePendingContent - Variable in class de.aeb.xnsg.docservice.bf.DeleteDocumentRequestDTO
-
If set to
true
, the document will be deleted even when the document content is yet being generated or archived. - IInternalProvisioningBF - Interface in de.aeb.xnsg.foundation.bf
-
Internal business facade for provisioning clients from a template.
- image - Variable in class de.aeb.xnsg.docservice.bf.DocumentPrintOptionsDTO
-
Settings for printing printer pictures/images
- ImagePrintOptionsDTO - Class in de.aeb.xnsg.docservice.bf
-
Settings for printing printer pictures/images
- ImagePrintOptionsDTO() - Constructor for class de.aeb.xnsg.docservice.bf.ImagePrintOptionsDTO
- impliedRoles - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- indentationLevel - Variable in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
-
The indentation level of the message.
- info - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDTO
- info - Variable in class de.aeb.xnsg.foundation.bf.ScriptExecutionStateResultDTO
-
information about the script execution
- info - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionResultDTO
-
information about the start
- info - Variable in class de.aeb.xnsg.foundation.bf.TableUpdateStateResultDTO
-
The current task of the table update
- installationDate - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
Date of last installation/update
- instance - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
The definition of the document instance to be used
- instance - Variable in class de.aeb.xnsg.docservice.bf.DeleteDocumentInstanceRequestDTO
-
Reference on the document instances to be deleted.
- instance - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstanceRequestDTO
-
Reference on the document instance and document type to be fetched.
- instance - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstancesRequestDTO
-
Reference on the document instance to be fetched.
- instance - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
The definition of the document instance to be used
- instance - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
The definition of the document instance to be used
- integerEntries - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTelemetryReportDTO
-
all integer values that should be reported
- INTERNAL_SERVER_ERROR - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
Possible messageIdentCode: "INTERNAL_SERVER_ERROR": An unexpected exception occured when handling the request, e.g.
- IntervalFromNowFilterDTO - Class in de.aeb.xnsg.foundation.bf
-
Initializes the filter with a time interval relative to 'today'.
- IntervalFromNowFilterDTO() - Constructor for class de.aeb.xnsg.foundation.bf.IntervalFromNowFilterDTO
- INVALID_DATA_ERROR - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
Possible messageIdentCode: "INVALID_DATA_ERROR": One of the ident codes send was not recognized by the engine.
- INVALID_DATA_ERROR - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
-
Possible messageIdentCode: "INVALID_DATA_ERROR": One of the ident codes sent was not recognized by the engine, e.g.
- INVALID_DATA_WARNING - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
Possible messageIdentCode: "INVALID_DATA_WARNING": One of the ident codes send was not recognized by the engine, but this was not treated as an error.
- IReferenceObjectTypeAware - Interface in de.aeb.xnsg.docservice.bf
-
Interface providing common methods or constants for DTOs using DocumentReferenceObjectType
- IRemoteAdminBF - Interface in de.aeb.xnsg.foundation.bf
-
Remote Administration tools use this methods.
- isACEmbedded - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
true
to display header and statusbar, false if ac should be embedded in another - isActive - Variable in class de.aeb.xnsg.foundation.bf.ClientDTO
-
True if active client
- isBusy - Variable in class de.aeb.xnsg.foundation.bf.ScriptExecutionStateResultDTO
-
Returns true, if the script execution is running
- isBusy - Variable in class de.aeb.xnsg.foundation.bf.TableUpdateStateResultDTO
-
Returns true, if the schema synchronisation is running
- isClientCustomized - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTemplateInfoDTO
-
true
, if the template is customized for the current client - isClientCustomized - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateInfoDTO
-
true
, if the template is customized for the current client - isClientCustomized - Variable in class de.aeb.xnsg.docservice.bf.reftype.DocumentReferenceObjectTypeDTO
-
true
, if the template is customized for the current client - isComplete - Variable in class de.aeb.xnsg.foundation.bf.datatransfer.sync.GetPublishedDataTransferPackageResponseDTO
-
true
if the synchronization is complete and currently no further published data transfer packages are available. - isComplete - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetPublishedDataFeedPartsResponseDTO
-
true
if the synchronization is complete and currently no further published data feed parts are available. - isComplete - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsResponseDTO
-
True, if the synchronization is complete and currently no further events are available.
- isConvertToPDF14 - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
If set to
true
, PDF 1.4 is created (instead of PDF 1.5). - isCritical - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingInfoDTO
-
Flag for critical errors that lead to strongly wrong or unusable results
- isCritical - Variable in class de.aeb.xnsg.documentcore.bf.DocumentValidationInfoDTO
-
Flag for critical errors that lead to strongly wrong or unusable conversion results
- isCritical - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationProblemInfoDTO
-
Flag for critical errors that lead to strongly wrong or unusable conversion results
- isCustomized - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTemplateInfoDTO
-
true
, if the template is customized (for all clients or for the current client) - isCustomized - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateInfoDTO
-
true
, if the template is customized (for all clients or for the current client) - isDataOnlyModeSupported - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateDocumentationDTO
-
Whether option 'Print with background' is supported.
- isDBReadyToUse - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
True, if the DB is ready to use (connected, valid and not locked).
- isDebtorNumberKnown(String) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
- isDemo - Variable in class de.aeb.xnsg.foundation.bf.ClientDTO
-
True if demo client
- isFailed - Variable in class de.aeb.xnsg.foundation.bf.ScriptExecutionStateResultDTO
-
Returns true, if the script execution failed
- isFailed - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionResultDTO
-
Returns true, if start script execution failed, e.g.
- isFailed - Variable in class de.aeb.xnsg.foundation.bf.TableUpdateStateResultDTO
-
Returns true, if the schema synchronisation failed
- isIgnored - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
Indicates that the print request has to be ignored.
- isList - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDTO
-
Indicates that this field is a list.
- isManagedExternally - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTemplateInfoDTO
-
true
, if the template is managed by an external system - isManagedExternally - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateInfoDTO
-
true
, if the template is managed by an external system - isPreparedForStop - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
True, if an announcement for a job is active.
- isPrintDocument - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
If true, the document will be converted to PDF classic and printed.
- isPrintedOnBlankPaper - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
This option is implemented in order to support printing form background on a blank paper, i.e.
- isReturnPageMapping - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingOptionsDTO
-
If set to
true
the caller gets also page mapping which maps page names to page numbers. - isReturnPageMapping - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
If set to
true
the caller gets also page mapping which maps page names to page numbers. - isReturnPDF - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
Should the business facade return the generated PDF-XFA or PDF-Classic document.
- isSortCopies - Variable in class de.aeb.xnsg.documentcore.bf.PDFPrintSettingsDTO
-
If true, the pages will be printed with multiple copies like 1,2,3,...1,2,3.
- isStandard - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTemplateInfoDTO
-
true
, if the template exists as standard (i.e. - isStandard - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateInfoDTO
-
true
, if the template exists as standard (i.e. - isStateOK - Variable in class de.aeb.xnsg.foundation.bf.RuntimeStateResultDTO
-
Is set to true, if the server is doing fine.
- isTelemetryEnabled - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMStatusResponseDTO
-
If false, either the installation is/was blacklisted during last reporting on ASM side or telemetry is switched off in general.
- isTelemetryEnabledForClient - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMStatusResponseDTO
-
If false, either the installation is/was blacklisted during last reporting on ASM side or telemetry is switched off in general.
- isTrace - Variable in class de.aeb.xnsg.documentcore.bf.JobProcessingOptionsDTO
-
Should the processing activities be traced
- isTrace - Variable in class de.aeb.xnsg.documentcore.bf.ParseProcessingOptionsDTO
-
Should the processing activities be traced
- isTrace - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
Should the conversion activities be traced (e.g.
- ISyncBF - Interface in de.aeb.xnsg.foundation.bf
-
Business facade for synchronizing data asynchronous from an engine to a client system.
- ISyncInternalBF - Interface in de.aeb.xnsg.foundation.bf
-
Internal business facade for setting events into the synchronization journal.
J
- jobProcessingOptions - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
Job processing options (timeout, tracing, etc.)
- jobProcessingOptions - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentRequestDTO
-
Job processing options (timeout, tracing, etc.)
- JobProcessingOptionsDTO - Class in de.aeb.xnsg.documentcore.bf
-
Technical processing options for the document generation job.
- JobProcessingOptionsDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.JobProcessingOptionsDTO
- jsonData - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
The raw JSON data to fill in the template with.
- jsonData - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
The raw JSON data to fill in the template with.
K
- key - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateLocalizedTextDTO
- key - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingInfoDTO
-
Processing category name (message type: trace, warning, error etc.)
- key - Variable in class de.aeb.xnsg.documentcore.bf.DocumentValidationInfoDTO
-
Validation category name (warning type)
- key - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationProblemInfoDTO
-
Validation category name (warning type)
- key - Variable in class de.aeb.xnsg.foundation.bf.ClientFeatureSetDTO
- key - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
key of the object described by this item.
- key - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDateEntryDTO
-
key for the value (must be unique within the
ExternalTelemetryReportDTO
) - key - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDoubleEntryDTO
-
key for the value (must be unique within the
ExternalTelemetryReportDTO
) - key - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRIntegerEntryDTO
-
key for the value (must be unique within the
ExternalTelemetryReportDTO
) - key - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRLongEntryDTO
-
key for the value (must be unique within the
ExternalTelemetryReportDTO
) - key - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringArrayEntryDTO
-
key for the value (must be unique within the
ExternalTelemetryReportDTO
) - key - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringEntryDTO
-
key for the value (must be unique within the
ExternalTelemetryReportDTO
) - key - Variable in class de.aeb.xnsg.foundation.bf.TransferFileParameterDTO
-
Key of the parameter
- keys - Variable in class de.aeb.xnsg.docservice.bf.DocumentStorageOptionsDTO
-
A list of
StorageKeyFieldDTO
which are defined/set by the business application to specify the search.
L
- label - Variable in class de.aeb.xnsg.docservice.bf.LocalizedIdentCodeDTO
- language - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateDocumentationTextDTO
-
2-letter language code as defined in ISO-639.
- language - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateLocalizedTextsDTO
-
2-letter language code as defined in ISO-639.
- language - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDocumentationDTO
-
2-letter language code as defined in ISO-639.
- language - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
The two letter ISO code of the language of the new session.
- language - Variable in class de.aeb.xnsg.foundation.bf.rest.TextTranslationRestDTO
- languageISOCode - Variable in class de.aeb.xnsg.foundation.bf.TextInLanguageDTO
-
2-letter ISO code of the language.
- languageISOCode - Variable in class de.aeb.xnsg.foundation.bf.TextTranslationDTO
-
ISO code of the language of the description.
- lastAccessedAt - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
Time of the last change of the print job.
The format of this value is YYYY-MM-DD HH:MM:SS (in UTC time). - lastAccessTimeMillis - Variable in class de.aeb.xnsg.foundation.bf.FileDTO
-
file attribute lastAccessTime as FileTime millis
- lastAccessTimeMillis - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
file attribute lastAccessTime as FileTime millis
- lastModifiedTimeMillis - Variable in class de.aeb.xnsg.foundation.bf.FileDTO
-
file attribute lastModifiedTime as FileTime millis
- lastModifiedTimeMillis - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
file attribute lastModifiedTime as FileTime millis
- lastReportId - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMResponseDTO
-
Id of the last filed external telemetry report that has been forwarded to the telemetry server.
- lastUpdate - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMResponseDTO
-
Last date an external telemetry report has been filed (is null if nothing filed yet).
- lastUpdateComment - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMResponseDTO
-
Comment that has been sent with the last external telemetry report filing (is null if nothing filed yet).
- lastUpdateReported - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMResponseDTO
-
True if the last filed external telemetry report has been forwarded to the telemetry server.
- leftOffsetmm - Variable in class de.aeb.xnsg.documentcore.bf.PDFPageOffsetDTO
-
The adjustment from the left in mm
- licenseRole - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- limit - Variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
-
The maximum number of elements to be returned from the ordered result list.
- LocalizedIdentCodeDTO - Class in de.aeb.xnsg.docservice.bf
-
Result object describing an ident code with translation.
- LocalizedIdentCodeDTO() - Constructor for class de.aeb.xnsg.docservice.bf.LocalizedIdentCodeDTO
- localizedTexts - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
- localizedTexts - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
- LOCK_ERROR - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
Possible messageIdentCode: "LOCK_ERROR": A locking problem happened.
- LOCK_WARNING - Static variable in class de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
-
Possible messageIdentCode: "LOCK_WARNING": An object necessary for processing the request could not be locked.
- longEntries - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTelemetryReportDTO
-
all long values that should be reported
M
- MAX_LIMIT - Static variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- MAX_OFFSET - Static variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- MAX_RESULTS - Static variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
Maximum allowed value for
AbstractQueryDocumentsRequestDTO.maxResults
- MAX_RESULTS - Static variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestsRequestDTO
-
Maximal number of returned requests
- MAX_RESULTS - Static variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
Maximum allowed value for
GetDocumentReferenceObjectsRequestDTO.maxResults
- MAX_SKIP_FIRST - Static variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
Maximum allowed value for
AbstractQueryDocumentsRequestDTO.skipFirst
- MAX_SKIP_FIRST - Static variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
Maximum allowed value for
GetDocumentReferenceObjectsRequestDTO.skipFirst
- maxFileSize - Variable in class de.aeb.xnsg.foundation.bf.UploadSettingsResponseDTO
-
maximum size of uploadable files
- maxResults - Variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
Defines how many documents will be returned.
- maxResults - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
Defines how many document reference objects will be returned.
- maxResultsExceeded - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsResponseDTO
-
There are more documents than the requested maxResults.
- maxRows - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionParmDTO
-
max.
- message - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingInfoDTO
-
Textual description of the processing info or problem
- messageIdentCode - Variable in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
-
Optional identification code for further classification of the message type.
- messages - Variable in class de.aeb.xnsg.foundation.bf.AbstractResponseDTO
-
Error or warning messages at the request level.
- messages - Variable in class de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
-
Messages for the whole request, e.g.
- messageTexts - Variable in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
-
Detailed message texts in the requested languages.
- messageType - Variable in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
-
Message type
- MESSAGETYPE_ERROR - Static variable in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
-
Possible messageType: "ERROR": One of the possible message types which is returned if an error has occured
- MESSAGETYPE_INFO - Static variable in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
-
Possible messageType: "INFO": One of the possible message types which is used for simple information responses
- MESSAGETYPE_WARNING - Static variable in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
-
Possible messageType: "WARNING": One of the possible message types which is returned if an warning has occured
- mimeCharSet - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
MIME-characterset of the mail
- mimeType - Variable in class de.aeb.xnsg.docservice.bf.DocumentContentStoreInfoDTO
-
MimeType of the document content
- mimeType - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
The standard MIME type of the document file.
- mimeType - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentRequestDTO
-
The standard MIME type of the document file.
- mimeType - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
The standard MIME type of the document file.
- MIN_LIMIT - Static variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- MIN_OFFSET - Static variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- modifiedAt - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Time when the document has been modified.
- modifiedUserName - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
User account name who modified the document.
- MoIdentCodeRestDTO - Class in de.aeb.xnsg.foundation.bf.rest
- MoIdentCodeRestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.rest.MoIdentCodeRestDTO
- MonitoringDataProviderDTO - Class in de.aeb.xnsg.foundation.bf
-
Data Transfer Object for monitoring provider
- MonitoringDataProviderDTO() - Constructor for class de.aeb.xnsg.foundation.bf.MonitoringDataProviderDTO
- monitorPrintJob - Variable in class de.aeb.xnsg.docservice.bf.PrintMonitoringOptionsDTO
-
Supervised printing: if
true
actual printing process is monitored after the print job has been accepted by the printer spooler.
N
- name - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
-
Name of the document template (and, implicitly, name for the template file).
- name - Variable in class de.aeb.xnsg.docservice.bf.DocumentContentStoreInfoDTO
-
Name of the content
- name - Variable in class de.aeb.xnsg.docservice.bf.reftype.DocumentReferenceObjectTypeTranslationDTO
-
The name of the document reference object type
- name - Variable in class de.aeb.xnsg.docservice.bf.template.DeleteDocumentTemplateRequestDTO
-
Name of the document template to be deleted.
- name - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateArchiveFieldDTO
-
Name of the archive field.
- name - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateExampleFileDTO
-
File name (name + extension) of the example.
- name - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
-
Name of the document template (and, implicitly, name for the template file).
- name - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDTO
-
Name of the field.
- name - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaObjectTypeDTO
-
Name of the object type.
- name - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
-
Parameter name.
- name - Variable in class de.aeb.xnsg.foundation.bf.ClientDTO
-
The name of the client length=10
- name - Variable in class de.aeb.xnsg.foundation.bf.ClientFeatureDTO
- name - Variable in class de.aeb.xnsg.foundation.bf.CreateClientRequestDTO
-
The name of the client.
- name - Variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Name of this field, i.e.
- name - Variable in class de.aeb.xnsg.foundation.bf.genericdata.NamedGenericDataRecordDTO
-
The name of this record, i.e.
- name - Variable in class de.aeb.xnsg.foundation.bf.MonitoringDataProviderDTO
-
Name of the entry.
- name - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- name - Variable in class de.aeb.xnsg.foundation.bf.SimpleFileDTO
-
Name of a file
- name - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
Name of a file
- NamedGenericDataRecordDTO - Class in de.aeb.xnsg.foundation.bf.genericdata
-
A generic data record with a name.
Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records. - NamedGenericDataRecordDTO() - Constructor for class de.aeb.xnsg.foundation.bf.genericdata.NamedGenericDataRecordDTO
- newClientDescription - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientRequestDTO
-
The description of new client created by the duplication.
- newClientDescription - Variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateRequestDTO
-
The description of the new client created by this duplication.
- newClientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientRequestDTO
-
The identcode of new client created by the duplication.
- newClientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateRequestDTO
-
The identcode of the new client created by this duplication.
- newDebtorNumber - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientRequestDTO
-
The debtor number (Kundennummer) of a client.
- newDebtorNumber - Variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateRequestDTO
-
The debtor number (Kundennummer) of the client.
- newPassword - Variable in class de.aeb.xnsg.foundation.bf.ChangeAdminPasswordParmDTO
-
the new admin password
- NiceLabelDocumentServiceTemplateDTO - Class in de.aeb.xnsg.docservice.bf
-
An empty implementation of DocumentTemplateDTO, with predefined constants for the NICELABEL processor.
- NiceLabelDocumentServiceTemplateDTO() - Constructor for class de.aeb.xnsg.docservice.bf.NiceLabelDocumentServiceTemplateDTO
- NiceLabelDocumentTemplateDTO - Class in de.aeb.xnsg.documentcore.bf
-
An empty implementation of DocumentTemplateDTO, with predefined constants for the nice label processor
- NiceLabelDocumentTemplateDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
- notificationDisabled - Variable in class de.aeb.xnsg.docservice.bf.PrintMonitoringOptionsDTO
-
If
true
print job will ignorenotificationEmail
even if set. - notificationEmail - Variable in class de.aeb.xnsg.docservice.bf.PrintMonitoringOptionsDTO
-
Target email to receive notification alert when printing fails.
- notificationEmailAddress - Variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateRequestDTO
-
Primary email address to send important notifications to, e.g.
- notUnicodeFontEncoding - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
If
null
, the font encoding "Identity-H" will be taken for embedded True-Type fonts, else the specified encoding (e.g. - numberOfCopies - Variable in class de.aeb.xnsg.documentcore.bf.PDFPrintSettingsDTO
-
Number of copies of the document, which should be printed
- numberOfPartsOfPeriod - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Number of parts in the period
- numberOfRecords - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Number of data records contained in the data feed part
O
- objectTypeName - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDTO
-
Name of the object type of the field.
- offset - Variable in class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
-
The number of elements to be skipped in the ordered result list.
- offset - Variable in class de.aeb.xnsg.foundation.bf.paging.PageResponseDTO
-
Indicates that there are more elements available to return (as applied from the provided
PageRequestDTO
). - offsetX - Variable in class de.aeb.xnsg.docservice.bf.ImagePrintOptionsDTO
- offsetY - Variable in class de.aeb.xnsg.docservice.bf.ImagePrintOptionsDTO
- oldPassword - Variable in class de.aeb.xnsg.foundation.bf.ChangeAdminPasswordParmDTO
-
the old admin password
- onlyActive - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestsRequestDTO
-
If
true
(default value), only pending or failed/blocking requests are returned. - onlyCreated - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstancesRequestDTO
-
Fetch only instances with already created documents.
- openPrintRequestQueue(ApplicationFacadeParmsDTO, PrintRequestQueueACSettingsDTO) - Method in interface de.aeb.xnsg.docservice.af.IDocumentServiceAF
-
Retrieves the URL for the print request overview of a certain context owner.
- openStagedDocumentEditor(ApplicationFacadeParmsDTO, StagedDocumentEditorParmsDTO) - Method in interface de.aeb.xnsg.docservice.af.IDocumentServiceAF
-
Retrieves the URL to edit a stored document.
- openStagedDocumentSearch(ApplicationFacadeParmsDTO, StagedDocumentSearchParmsDTO) - Method in interface de.aeb.xnsg.docservice.af.IDocumentServiceAF
-
Retrieves the URL for the staged document search.
- openToTray - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
Optional field, which may be set if application should be opened to tray (default:
false
) - currently not available for vaadin, will be ignored - orderBy - Variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
Defines how the requested documents are sorted.
- orderBy - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
Defines how the requested document reference objects are sorted.
- OutputSettingsPrinterDTO - Class in de.aeb.xnsg.docservice.bf
-
The output settings contain information of a document in the current output owner context (e.g.
- OutputSettingsPrinterDTO() - Constructor for class de.aeb.xnsg.docservice.bf.OutputSettingsPrinterDTO
P
- packageContent - Variable in class de.aeb.xnsg.foundation.bf.datatransfer.sync.PublishedDataTransferPackageDTO
-
The content of the published data transfer package as a zipped file.
- pageName - Variable in class de.aeb.xnsg.documentcore.bf.PageNumberMappingDTO
-
Template page name
- pageName - Variable in class de.aeb.xnsg.documentcore.bf.PDFPageNumberMappingDTO
- pageName - Variable in class de.aeb.xnsg.documentcore.bf.PDFPageOffsetDTO
-
The name of the page to be offsetted.
- pageNames - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplatePagesResponseDTO
-
The page names of the PDF template file
- pageNr - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingInfoDTO
-
Page number where the problem has arisen
- PageNumberMappingDTO - Class in de.aeb.xnsg.documentcore.bf
-
Contains page name and corresponding page numbers.
- PageNumberMappingDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PageNumberMappingDTO
- PageNumberMappingDTO(String, String) - Constructor for class de.aeb.xnsg.documentcore.bf.PageNumberMappingDTO
- pageNumberMappings - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceResponseDTO
-
Resulting template page name to page range mappings.
- pageNumberMappings - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO
-
Resulting template page name to page range mappings.
- pageNumberMappings - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentResponseDTO
-
Resulting template page name to page range mappings.
- pageNumbers - Variable in class de.aeb.xnsg.documentcore.bf.PageNumberMappingDTO
-
Resulting page numbers as e.g.
- pageNumbers - Variable in class de.aeb.xnsg.documentcore.bf.PDFPageNumberMappingDTO
- pageOffsets - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
Page specific page offset adjustments when converting XFA -> classic PDF.
- PageRequestDTO - Class in de.aeb.xnsg.foundation.bf.paging
-
Parameters for query result pagination.
- PageRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- PageRequestDTO(Integer, Integer) - Constructor for class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- PageRequestDTO(Integer, Integer, Boolean) - Constructor for class de.aeb.xnsg.foundation.bf.paging.PageRequestDTO
- PageResponseDTO - Class in de.aeb.xnsg.foundation.bf.paging
-
Additional information for query results with applied
PageRequestDTO
. - PageResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.paging.PageResponseDTO
- PARAM_CONTENT_VARIANT - Static variable in class de.aeb.xnsg.docservice.bf.NiceLabelDocumentServiceTemplateDTO
-
Overrides the default content variant of a document.
- PARAM_CONTENT_VARIANT - Static variable in class de.aeb.xnsg.docservice.bf.PDFXFADocumentServiceTemplateDTO
-
Overrides the default content variant of a document.
- PARAM_DATA_BINDING - Static variable in class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
-
Data binding syntax
- PARAM_DATA_BINDING - Static variable in class de.aeb.xnsg.documentcore.bf.XLSXDocumentTemplateDTO
-
Data binding syntax
- PARAM_DEVMODE - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
Native printer settings.
- PARAM_FONT_ENCODING - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
By default, the font encoding "Identity-H" will be taken for embedded True-Type fonts, else the specified encoding (e.g.
- PARAM_JOBNAME - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
Name of the job.
- PARAM_PAGE_OFFSETS - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
The information about the position adjustment of the document pages.
- PARAM_PRINTDARKNESS - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
NiceLabel print parameter.
- PARAM_PRINTERNAME - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
Name of the label printer e.g.
- PARAM_PRINTOFFSETX - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
NiceLabel print parameter.
- PARAM_PRINTOFFSETY - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
NiceLabel print parameter.
- PARAM_PRINTSPEED - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
NiceLabel print parameter.
- PARAM_SUBMIT_URL - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Preview or submit URL (XFA edit mode)
- parameter - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
-
Additional values/parameters of the event.
- parameterName - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchParameterDTO
-
name of the query parameter - valid names are defined by the category
- parameters - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingOptionsDTO
-
Optional, processor-specific processing parameters.
- parameters - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
-
Nested parameters.
- parameters - Variable in class de.aeb.xnsg.foundation.af.AFExecuteProcessParmsDTO
-
parameters to the executable.
- parameters - Variable in class de.aeb.xnsg.foundation.bf.DLFilesRefsRequestDTO
-
A list of generic parameters.
- parameters - Variable in class de.aeb.xnsg.foundation.bf.DownloadFileRequestDTO
-
A list of generic parameters.
- parameters - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
A list of generic parameters.
- parameters - Variable in class de.aeb.xnsg.foundation.bf.UploadFileRequestDTO
-
A list of generic parameters.
- parameterValue - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchParameterDTO
-
value of the parameter;
- parse(ParseDocumentTemplateRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Parses the provided template data and returns the required information, as specified in the parse query parameters.
- PARSE_QUERY_DATA_DESCRIPTION - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return the data schema definition (XFA format http://ns.adobe.com/data-description/).
- PARSE_QUERY_EXAMPLE_XML - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
Return a syntactically valid example XML based on the designed label.
- PARSE_QUERY_EXAMPLE_XML - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return a syntactically valid example XML based on the XSD.
- PARSE_QUERY_EXAMPLE_XMLS - Static variable in class de.aeb.xnsg.docservice.bf.NiceLabelDocumentServiceTemplateDTO
-
Return the predefined example XMLs of a document template (plain list of UTF8 strings, one name per line).
- PARSE_QUERY_EXAMPLE_XMLS - Static variable in class de.aeb.xnsg.docservice.bf.PDFXFADocumentServiceTemplateDTO
-
Return the predefined example XMLs of a document template (plain list of UTF8 strings, one page name per line).
- PARSE_QUERY_GRAPH_QL_SCHEMA - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return the data schema definition (GraphQL format).
- PARSE_QUERY_NSG_FIELD_DEF - Static variable in class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
-
Excerpt the NSG data bindings (REP and OPT bookmarks, MERGEFIELDs with Smalltalk access paths) and return them as a data field definition in the NSG format (*.DEF; see Smalltalk class DocumentProcessorItem).
- PARSE_QUERY_NSG_FIELD_DEF - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return the data field definition in the NSG format (*.def; see DocumentProcessorItem).
- PARSE_QUERY_PAGE_NAMES - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return the template page names (plain list of UTF8 strings, one page name per line).
- PARSE_QUERY_TEXT_PLACEHOLDERS - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return the template text placeholders (plain list of UTF8 string, one placeholder name per line).
- PARSE_QUERY_XFA_FORM - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return the XFA form (XML format, schema 'http://www.xfa.org/schema/xfa-template/*', the version may vary per document).
- PARSE_QUERY_XSD - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
Return the data schema definition (XSD format http://www.w3.org/2001/XMLSchema).
- PARSE_QUERY_XSD - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Return the data schema definition (XSD format http://www.w3.org/2001/XMLSchema).
- parseDocumentTemplateContent(ParseDocumentTemplateContentRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Parses the referenced template data and returns the required information, as specified in the parse query parameters.
- ParseDocumentTemplateContentRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters for an extraction of a part of the document template.
- ParseDocumentTemplateContentRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentRequestDTO
- ParseDocumentTemplateContentResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the generated result and accompanying information.
- ParseDocumentTemplateContentResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentResponseDTO
- ParseDocumentTemplateRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
The parameters for an extraction of a part of the document template.
- ParseDocumentTemplateRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateRequestDTO
- ParseDocumentTemplateResponseDTO - Class in de.aeb.xnsg.documentcore.bf
-
Contains the generated document and accompanying information.
- ParseDocumentTemplateResponseDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateResponseDTO
- ParseProcessingOptionsDTO - Class in de.aeb.xnsg.documentcore.bf
-
Technical processing options for the document template parsing.
- ParseProcessingOptionsDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ParseProcessingOptionsDTO
- partNumberInPeriod - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Part number of the data feed part for the period
- password - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientUserDTO
- path - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateArchiveFieldDTO
-
Dot-separated path to a field.
- pdfClassicContent - Variable in class de.aeb.xnsg.documentcore.bf.PrintPDFClassicRequestDTO
-
The content of the PDF classic file.
- pdfContent - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFResponseDTO
-
The content of the result PDF file as byte array.
- PDFPageNumberMappingDTO - Class in de.aeb.xnsg.documentcore.bf
-
DTO class containing page name and corresponding page numbers.
- PDFPageNumberMappingDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFPageNumberMappingDTO
- PDFPageNumberMappingDTO(String, String) - Constructor for class de.aeb.xnsg.documentcore.bf.PDFPageNumberMappingDTO
- PDFPageOffsetDTO - Class in de.aeb.xnsg.documentcore.bf
-
The information about the adjustment of a page
- PDFPageOffsetDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFPageOffsetDTO
- pdfPages - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFResponseDTO
-
Each PDFPageNumberMappingDTO object contains page name and corresponding page numbers.
- PDFPrintSettingsDTO - Class in de.aeb.xnsg.documentcore.bf
-
Options for printing a document.
- PDFPrintSettingsDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFPrintSettingsDTO
- PDFTemplateDTO - Class in de.aeb.xnsg.documentcore.bf
-
This DTO can be used to reference or transfer PDF templates to the engine.
- PDFTemplateDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplateDTO
- PDFTemplateFormRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
Request parameter to get the XFA form data of a template
- PDFTemplateFormRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplateFormRequestDTO
- PDFTemplateFormResponseDTO - Class in de.aeb.xnsg.documentcore.bf
-
Result of the request to get XFA form data of a template
- PDFTemplateFormResponseDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplateFormResponseDTO
- PDFTemplatePagesRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
The parameters for the get page names business facade
- PDFTemplatePagesRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplatePagesRequestDTO
- PDFTemplatePagesResponseDTO - Class in de.aeb.xnsg.documentcore.bf
-
The return information that contains the page names of a PDF-XFA template
- PDFTemplatePagesResponseDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplatePagesResponseDTO
- PDFTemplateValidationProblemInfoDTO - Class in de.aeb.xnsg.documentcore.bf
-
Structured information on a validation problem
- PDFTemplateValidationProblemInfoDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationProblemInfoDTO
- PDFTemplateValidationRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
The parameters for the validation business facade
- PDFTemplateValidationRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationRequestDTO
- PDFTemplateValidationResponseDTO - Class in de.aeb.xnsg.documentcore.bf
-
The return information that contains the conversion problems of a PDF-XFA template (if it should be converted to Classic PDF)
- PDFTemplateValidationResponseDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationResponseDTO
- PDFXFADocumentServiceTemplateDTO - Class in de.aeb.xnsg.docservice.bf
-
An empty implementation of DocumentTemplateDTO, with predefined constants for the PDFXFA processor.
- PDFXFADocumentServiceTemplateDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PDFXFADocumentServiceTemplateDTO
- PDFXFADocumentTemplateDTO - Class in de.aeb.xnsg.documentcore.bf
-
An empty implementation of DocumentTemplateDTO, with predefined constants for the PDFXFA processor.
- PDFXFADocumentTemplateDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
- percentage - Variable in class de.aeb.xnsg.foundation.bf.TableUpdateStateResultDTO
-
How far has the table update went
- periodEndDate - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Date/time stamp in the format yyyy-MM-dd for the end date of the period this data feed part contains data for
- periodStartDate - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Date/time stamp in the format yyyy-MM-dd for the start date of the period this data feed part contains data for
- pinterTray - Variable in class de.aeb.xnsg.documentcore.bf.PDFPrintSettingsDTO
-
The name of the printer tray used to print the document.
- preferredHeight - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
Optional field, which may be set if preferred height of AF should be different from default.
- preferredWidth - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
Optional field, which may be set if preferred width of AF should be different from default.
- prepareDocument(PrepareDocumentRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Prepares a document asynchronously from the referenced template and document data.
- prepareDocumentInstance(PrepareDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Prepares a document asynchronously from the referenced document type and document data.
- PrepareDocumentInstanceRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters for a single document asynchronous creation.
- PrepareDocumentInstanceRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrepareDocumentInstanceRequestDTO
- PrepareDocumentInstanceResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains just the documentId of the staged document.
- PrepareDocumentInstanceResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrepareDocumentInstanceResponseDTO
- PrepareDocumentRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters for a single document asynchronous creation.
- PrepareDocumentRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrepareDocumentRequestDTO
- PrepareDocumentResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains just the documentId of the staged document.
- PrepareDocumentResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrepareDocumentResponseDTO
- preserveDocuments - Variable in class de.aeb.xnsg.docservice.bf.refobject.DeleteDocumentReferenceObjectRequestDTO
-
Flag to preserve or remove documents bound to this reference object (default: false = remove).
- preventedLogonMinutes - Variable in class de.aeb.xnsg.foundation.bf.AnnounceStopParmDTO
-
The server will prevent new logons for this number of minutes before the date specified for the stop.
- PREVIEW - Static variable in class de.aeb.xnsg.docservice.af.StagedDocumentEditorParmsDTO
-
Open preview to display the document content.
- previewURL - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
The URL which should be used to send the preview data to if a preview PDF-XFA document is generated.
- PRINT_DIALOG - Static variable in class de.aeb.xnsg.docservice.af.StagedDocumentEditorParmsDTO
-
Open print preview/dialog.
- PRINT_REQUEST_CANCEL - Static variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
-
Action constant to cancel the print request execution if still possible.
- PRINT_REQUEST_IGNORE - Static variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
-
Action constant to set print request as ignored.
- PRINT_REQUEST_RESET - Static variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
-
Action constant to reset print request in order to remove its error state(s) and retry again.
- printDocumentInstance(PrintDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Creates a print request for the requested document.
- PrintDocumentInstanceRequestDTO - Class in de.aeb.xnsg.docservice.bf
- PrintDocumentInstanceRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
- PrintDocumentInstanceResponseDTO - Class in de.aeb.xnsg.docservice.bf
- PrintDocumentInstanceResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceResponseDTO
- printerId - Variable in class de.aeb.xnsg.docservice.bf.PrinterRawPrintOptionsDTO
-
Some ERP systems responsible for printing need more information about the printer (only relevant for content-type "print/raw")
- printerModelString - Variable in class de.aeb.xnsg.docservice.bf.PrinterRawPrintOptionsDTO
-
Model of the printer (aka printer type) for which the printable printer raw data applies (only relevant for content-type "print/raw")
Example: "ZEBRA GK420d" - printerName - Variable in class de.aeb.xnsg.docservice.bf.OutputSettingsPrinterDTO
-
Printer name as defined in the operating system.
Printers provided by a cloud printing server end with the server name separated by the unicode character ☁ (cloud symbol) - printerName - Variable in class de.aeb.xnsg.documentcore.bf.PDFPrintSettingsDTO
-
The name of the printer used to print the document.
- printerRaw - Variable in class de.aeb.xnsg.docservice.bf.DocumentPrintOptionsDTO
-
Settings for printing printer raw data (in a specific printer language like PS, PCL, EPL, ZPL etc.)
- PrinterRawPrintOptionsDTO - Class in de.aeb.xnsg.docservice.bf
-
Settings for printing printer raw data (in a specific printer language like PS, PCL, EPL, ZPL etc.)
- PrinterRawPrintOptionsDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrinterRawPrintOptionsDTO
- printerType - Variable in class de.aeb.xnsg.docservice.bf.OutputSettingsPrinterDTO
-
Optional printer type/model identifier.
If provided, the value must conform to that ofPrinterRawPrintOptionsDTO.printerModelString
upon printing. - printMonitoringOptions - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
-
Print job/queue monitoring options to allow notifications, monitoring and stop-on-error behaviour.
Optional, non-null values override system configuration for each field. - PrintMonitoringOptionsDTO - Class in de.aeb.xnsg.docservice.bf
- PrintMonitoringOptionsDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PrintMonitoringOptionsDTO
- printPDFClassic(PrintPDFClassicRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Deprecated.this method is no more supported
- PrintPDFClassicRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
Parameter DTO for printing a classic PDF document.
- PrintPDFClassicRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.PrintPDFClassicRequestDTO
- printRequest - Variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestResponseDTO
-
Latest info of the updated print request as returned immediately after update action.
- printRequestId - Variable in class de.aeb.xnsg.docservice.bf.DeletePrintRequestRequestDTO
-
The unique ID of the print request to be deleted.
- printRequestId - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateRequestDTO
-
The unique ID of the print request for which the state is requested.
- printRequestId - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
The unique ID of the print request
- printRequestId - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceResponseDTO
-
The unique ID of the created print request.
- printRequestId - Variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
-
The unique ID of the print request for which the action is called.
- PrintRequestQueueACSettingsDTO - Class in de.aeb.xnsg.docservice.af
-
Parameter for application facade method
IDocumentServiceAF.openPrintRequestQueue(de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO, PrintRequestQueueACSettingsDTO)
- PrintRequestQueueACSettingsDTO() - Constructor for class de.aeb.xnsg.docservice.af.PrintRequestQueueACSettingsDTO
- printRequests - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestsResponseDTO
-
List of requests in the print queue
- printSettings - Variable in class de.aeb.xnsg.documentcore.bf.PrintPDFClassicRequestDTO
-
The print options (printer name, number of copies and so on)
- printSettings - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFRequestDTO
-
Print settings, only to be filled, if printing is required.
- processId - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientResponseDTO
- processId - Variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateResponseDTO
-
The processId that can be used to query the process' status.
- processId - Variable in class de.aeb.xnsg.foundation.bf.provisioning.GetCreateClientFromTemplateStatusRequestDTO
-
The processId obtained by
IInternalProvisioningBF.createClientFromTemplate(CreateClientFromTemplateRequestDTO)
. - PROCESSING_PARAM_CONTENT_VARIANT - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
- processingInfos - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceResponseDTO
-
The processing traces and problems as array of structured information (type, description, element path).
- processingInfos - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO
-
The processing traces and problems as array of structured information (type, description, element path).
- processingInfos - Variable in class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentResponseDTO
-
The processing traces and problems as array of structured information (type, description, element path).
- processingInfos - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentResponseDTO
-
The processing traces and problems as array of structured information (type, description, element path).
- processingInfos - Variable in class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateResponseDTO
-
The processing traces and problems as array of structured information (type, description, element path).
- processingOptions - Variable in class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentRequestDTO
-
Parse processing options (tracing etc.)
- processingOptions - Variable in class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateRequestDTO
-
Parse processing options (tracing etc.)
- processOptions - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFRequestDTO
-
Processing options.
- processor - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateInfoDTO
-
The document processor tag, associated with the template.
- processor - Variable in class de.aeb.xnsg.docservice.bf.DocumentTemplateReferenceDTO
-
The document processor tag.
- processor - Variable in class de.aeb.xnsg.documentcore.bf.DocumentTemplateDTO
-
The document processor tag.
- PROCESSOR - Static variable in class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
-
Document processor tag
- PROCESSOR - Static variable in class de.aeb.xnsg.documentcore.bf.NiceLabelDocumentTemplateDTO
-
Document processor tag
- PROCESSOR - Static variable in class de.aeb.xnsg.documentcore.bf.PDFXFADocumentTemplateDTO
-
Document processor tag
- PROCESSOR - Static variable in class de.aeb.xnsg.documentcore.bf.XLSXDocumentTemplateDTO
-
Document processor tag
- processorCode - Variable in class de.aeb.xnsg.docservice.bf.doctype.CreateDocTypeRequestDTO
-
Document processor code.
- processorCode - Variable in class de.aeb.xnsg.docservice.bf.doctype.CreateDocTypeTemplateDTO
-
Deprecated.
- processorCode - Variable in class de.aeb.xnsg.docservice.bf.doctype.PutDocTypeRequestDTO
-
Document processor code for new templates.
- processorCode - Variable in class de.aeb.xnsg.docservice.bf.template.CreateDocumentTemplateRequestDTO
-
Document processor code.
- processorCode - Variable in class de.aeb.xnsg.docservice.bf.template.PutDocumentTemplateRequestDTO
-
Document processor code for new templates.
- processorType - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
-
Program that prepares the document in the defined format.
- processPDF(ProcessPDFRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Deprecated.use
IDocumentCoreBF.generate(GenerateDocumentRequestDTO)
with the "PDFXFA" processor (seePDFXFADocumentTemplateDTO.PROCESSOR
) - ProcessPDFOptionsDTO - Class in de.aeb.xnsg.documentcore.bf
-
Processing options for the pdf document.
- ProcessPDFOptionsDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
- ProcessPDFRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
Encapsulates all parameters of IDocumentCoreBF.processPDF(..)
- ProcessPDFRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ProcessPDFRequestDTO
- ProcessPDFResponseDTO - Class in de.aeb.xnsg.documentcore.bf
-
The return information that contains resulting PDF-XFA PDF or Classic PDF
- ProcessPDFResponseDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ProcessPDFResponseDTO
- productHomeAbsolutePath - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
Absolute path in server view, where the server is installed.
- ProductInfoDTO - Class in de.aeb.xnsg.foundation.bf
-
This class holds various information items of the server which serves this request.
- ProductInfoDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ProductInfoDTO
- productname - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
Optional field, which may be set if productname differs from standard product name
- productName - Variable in class de.aeb.xnsg.foundation.bf.ProductInfoDTO
-
This is the name of the product that is deployed to this server.
- productName - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
Product name.
- productNameInternal - Variable in class de.aeb.xnsg.foundation.bf.ProductInfoDTO
-
This is the name of the product that is deployed to this server in its original manner.
- productShortName - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
Optional field, which may be set if productShortName differs from standard product name
- productUri - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
This is the URI used by the server at runtime.
- productVersion - Variable in class de.aeb.xnsg.foundation.bf.ProductInfoDTO
-
This data contains the version of the product.
- productVersion - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
Product version as "1.2-20070215".
- progress - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientProgressResponseDTO
-
The progress of the duplication from 0-100.
- progress - Variable in class de.aeb.xnsg.foundation.bf.provisioning.GetCreateClientFromTemplateStatusResponseDTO
-
The progress of the duplication from
0
to100
. - PublishedDataFeedPartDTO - Class in de.aeb.xnsg.foundation.bf.extraction.feed.sync
-
DTO to hold the data of a published data feed part.
- PublishedDataFeedPartDTO() - Constructor for class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
- PublishedDataTransferPackageDTO - Class in de.aeb.xnsg.foundation.bf.datatransfer.sync
-
DTO to hold the data of a published data transfer package.
- PublishedDataTransferPackageDTO() - Constructor for class de.aeb.xnsg.foundation.bf.datatransfer.sync.PublishedDataTransferPackageDTO
- publishedFeedParts - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetPublishedDataFeedPartsResponseDTO
-
Zero or one
PublishedDataFeedPartDTO
.
Since a data feed part can be large a maximum of one part is returned per request. - publishedPackages - Variable in class de.aeb.xnsg.foundation.bf.datatransfer.sync.GetPublishedDataTransferPackageResponseDTO
-
Zero or one
PublishedDataTransferPackageDTO
.
Since a package can be very large a maximum of one packet is returned per request. - PutDocTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- PutDocTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.PutDocTypeRequestDTO
- PutDocTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- PutDocTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.PutDocTypeResponseDTO
- PutDocTypeTemplateDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- PutDocTypeTemplateDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.PutDocTypeTemplateDTO
- putDocument(PutDocumentRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Uploads an external document which does not depend on templates of the document.
LikeIDocumentServiceBF.createDocument(CreateDocumentRequestDTO)
andIDocumentServiceBF.prepareDocument(PrepareDocumentRequestDTO)
the uploaded document can be queried, deleted and fetched by calling the corresponding method with the received documentId
The document also has a date to which this document is at least stored in the document store.
Currently only PDF up to a maximum size of 10MB is supported. - putDocumentInstance(PutDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Uploads an external document which does not depend on templates of the document.
The document type and reference object are resolved in the context of the session client. - PutDocumentInstanceRequestDTO - Class in de.aeb.xnsg.docservice.bf
- PutDocumentInstanceRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
- PutDocumentInstanceResponseDTO - Class in de.aeb.xnsg.docservice.bf
- PutDocumentInstanceResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PutDocumentInstanceResponseDTO
- putDocumentInstanceTrusted(PutDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Like
IDocumentServiceBF.putDocumentInstance(PutDocumentInstanceRequestDTO)
but with less limitations to the uploaded contents. - putDocumentReferenceObject(PutDocumentReferenceObjectRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Create or update a document reference object.
- PutDocumentReferenceObjectRequestDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- PutDocumentReferenceObjectRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.PutDocumentReferenceObjectRequestDTO
- PutDocumentReferenceObjectResponseDTO - Class in de.aeb.xnsg.docservice.bf.refobject
- PutDocumentReferenceObjectResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.refobject.PutDocumentReferenceObjectResponseDTO
- putDocumentReferenceObjectType(PutDocumentReferenceObjectTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Create or update a document reference object type.
- PutDocumentReferenceObjectTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.reftype
- PutDocumentReferenceObjectTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.PutDocumentReferenceObjectTypeRequestDTO
- PutDocumentReferenceObjectTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.reftype
- PutDocumentReferenceObjectTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.reftype.PutDocumentReferenceObjectTypeResponseDTO
- PutDocumentRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
Parameters to upload an external document
- PutDocumentRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PutDocumentRequestDTO
- PutDocumentResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the documentId of the external document if the upload was successful.
- PutDocumentResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.PutDocumentResponseDTO
- putDocumentTemplate(PutDocumentTemplateRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Creates or replaces an externally managed document template.
- PutDocumentTemplateRequestDTO - Class in de.aeb.xnsg.docservice.bf.template
- PutDocumentTemplateRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.PutDocumentTemplateRequestDTO
- PutDocumentTemplateResponseDTO - Class in de.aeb.xnsg.docservice.bf.template
- PutDocumentTemplateResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.PutDocumentTemplateResponseDTO
- putDocumentTrusted(PutDocumentRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Like
IDocumentServiceBF.putDocument(PutDocumentRequestDTO)
but with less limitations to the uploaded contents. - putDocumentType(PutDocTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Creates or replaces a document type.
Q
- query - Variable in class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentRequestDTO
-
Parse query.
- query - Variable in class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateRequestDTO
-
Parse query.
- queryDocuments(QueryDocumentsRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Executes a search query on the documents stored in the document storage.
- queryDocumentsById(QueryDocumentsByIdRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Executes a search query on the documents stored in the document storage.
- QueryDocumentsByIdRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to query for documents by the document id.
- QueryDocumentsByIdRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.QueryDocumentsByIdRequestDTO
- queryDocumentsByRef(QueryDocumentsByRefRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Executes a search query on the documents stored in the document storage.
- QueryDocumentsByRefRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to query for documents by the reference fields.
- QueryDocumentsByRefRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.QueryDocumentsByRefRequestDTO
- QueryDocumentsRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
The parameters to query for documents.
- QueryDocumentsRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.QueryDocumentsRequestDTO
- QueryDocumentsResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the
DocumentInfoDTO
s of the queried documents. - QueryDocumentsResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.QueryDocumentsResponseDTO
- queueStoppedMessage - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestsResponseDTO
-
If the queue is stopped due to an error state of a print request it contains the reason of the error.
If this message is filled no print request is processed till the error is fixed. - queueStoppedMessage - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
If the queue is stopped due to an error state of a previous print request it contains the reason of the error.
If this message is filled the current print request is not processed till the error is fixed.
R
- readOnly - Variable in class de.aeb.xnsg.foundation.bf.ClientFeatureDTO
- receivers - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
receivers of the mail
- record - Variable in class de.aeb.xnsg.foundation.bf.genericdata.NamedGenericDataRecordDTO
-
The record associated with the name.
Especially in case, where the name is repeated in the context of the same parent record, this field may be null to indicate a null in a list of records. - REFERENCE_NUMBER_ASC - Enum constant in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Sorted by document reference number, alphabetically ascending.
- REFERENCE_NUMBER_ASC - Enum constant in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- REFERENCE_NUMBER_DESC - Enum constant in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Sorted by document reference number, alphabetically descending
- REFERENCE_NUMBER_DESC - Enum constant in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- REFERENCE_TYPE_ASC - Enum constant in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Sorted by document reference type, alphabetically ascending.
- REFERENCE_TYPE_ASC - Enum constant in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- REFERENCE_TYPE_DESC - Enum constant in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Sorted by document reference type, alphabetically descending.
- REFERENCE_TYPE_DESC - Enum constant in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
- referenceNumber - Variable in class de.aeb.xnsg.docservice.af.StagedDocumentSearchParmsDTO
-
Criteria for the reference number of the documents.
- referenceNumber - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferenceDTO
-
Identification of the referenced (external) object (e.g.
- referenceNumber - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferenceObjectReferenceDTO
-
Identification of the referenced object.
- referenceNumber - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsRequestDTO
-
Criteria for the reference number of the documents.
- referenceNumber - Variable in class de.aeb.xnsg.docservice.bf.refobject.DeleteDocumentReferenceObjectRequestDTO
-
Number with which the reference object is identified (for example: shipment number).
- referenceNumber - Variable in class de.aeb.xnsg.docservice.bf.refobject.DocumentReferenceObjectDTO
-
Number with which the reference object is identified (for example: shipment number).
- referenceNumber - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectRequestDTO
-
Criteria for the reference number of the document reference objects.
- referenceNumber - Variable in class de.aeb.xnsg.docservice.bf.refobject.PutDocumentReferenceObjectRequestDTO
-
Number with which the reference object is identified (for example: shipment number).
- referenceNumberInList - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferencesDTO
-
List of document reference numbers (max.
- referenceNumberInList - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsRequestDTO
-
Deprecated.Consider using
IDocumentServiceBF.queryDocumentsByRef(QueryDocumentsByRefRequestDTO)
instead. - referenceObject - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectResponseDTO
-
Returns the
DocumentReferenceObjectDTO
. - referenceObjects - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsResponseDTO
-
Returns all
DocumentReferenceObjectDTO
s. - referenceType - Variable in class de.aeb.xnsg.docservice.af.StagedDocumentSearchParmsDTO
-
Criteria for the reference type of the documents.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeRequestDTO
-
Type of the reference object for which the document type is valid.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
-
Type of the reference object which is supported by the document type.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferenceDTO
-
Type of the referenced (external) object, e.g.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferenceObjectReferenceDTO
-
Type of the reference object, e.g.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.DocumentReferencesDTO
-
Type of the referenced (external) object, e.g.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsRequestDTO
-
Criteria for the reference type of the documents.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.refobject.DeleteDocumentReferenceObjectRequestDTO
-
Type of the reference object to be deleted.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.refobject.DocumentReferenceObjectDTO
-
Type of the reference object.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectRequestDTO
-
Criteria for the reference type of the document reference objects.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
Criteria for the reference type of the document reference objects.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.refobject.PutDocumentReferenceObjectRequestDTO
-
Type of the reference object to be created.
- referenceType - Variable in class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypeResponseDTO
-
Returns the
DocumentReferenceObjectTypeDTO
. - referenceTypes - Variable in class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypesResponseDTO
-
Returns all
DocumentReferenceObjectTypeDTO
s. - relativeInterval - Variable in class de.aeb.xnsg.foundation.bf.DateTimeIntervalRangeFilterDTO
-
Pass this value if you like to filter relative interval.
- RelativeIntervalFilterDTO - Class in de.aeb.xnsg.foundation.bf
-
Initializes the filter with a relative time range.
- RelativeIntervalFilterDTO() - Constructor for class de.aeb.xnsg.foundation.bf.RelativeIntervalFilterDTO
- releaseApplicationFacade(String) - Method in interface de.aeb.xnsg.foundation.af.IFoundationAF
-
Release a application facade which is no longer needed.
This call will save resources in the server, because the server must not wait for the timeout of the application facades session but can release it earlier.
The method should only be called if it is definitively known, that no access to the application facade by the user is possible any more, e.g. - relevance - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
relevance of the result; an indication (in percent, ranging from 0 ..
- remark - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeRequestDTO
-
Additional comment on the document type definition.
- remark - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
-
Additional comment on the document type definition.
- remark - Variable in class de.aeb.xnsg.docservice.bf.DocumentStorageOptionsDTO
-
User defined document remark
- ReplaceDocTypeRequestDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- ReplaceDocTypeRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.ReplaceDocTypeRequestDTO
- ReplaceDocTypeResponseDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- ReplaceDocTypeResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.ReplaceDocTypeResponseDTO
- ReplaceDocTypeTemplateDTO - Class in de.aeb.xnsg.docservice.bf.doctype
- ReplaceDocTypeTemplateDTO() - Constructor for class de.aeb.xnsg.docservice.bf.doctype.ReplaceDocTypeTemplateDTO
- replaceDocumentTemplate(ReplaceDocumentTemplateRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Replaces the content of a document template.
- ReplaceDocumentTemplateRequestDTO - Class in de.aeb.xnsg.docservice.bf.template
- ReplaceDocumentTemplateRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.ReplaceDocumentTemplateRequestDTO
- ReplaceDocumentTemplateResponseDTO - Class in de.aeb.xnsg.docservice.bf.template
- ReplaceDocumentTemplateResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.template.ReplaceDocumentTemplateResponseDTO
- replaceDocumentType(ReplaceDocTypeRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Updates a document type by replacing it.
- replaceExistingContent - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
If set to
true
, any existing document content is removed and re-generated using the current output settings. - replytos - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
reply to addresses of the mail
- reportClientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMIdentificationRequestDTO
-
Client IdentCode for which the telemetry is done for.
- reportClientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMResponseDTO
-
Client IdentCode for which the telemetry is done for.
- reportClientIdentCode - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMStatusResponseDTO
-
Client IdentCode for which the telemetry status is checked for.
- reportData - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMReportRequestDTO
-
The actual reporting data.
- requestedAt - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
Time at which the print request was created.
The format of this value is YYYY-MM-DD HH:MM:SS (in UTC time). - requestedAtAfter - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestsRequestDTO
-
If filled, only the print requests that were created strictly after the given time are returned.
The format of this value is YYYY-MM-DD HH:MM:SS (in UTC time). - resolution - Variable in class de.aeb.xnsg.docservice.bf.ImagePrintOptionsDTO
- ResponseMessageDTO - Class in de.aeb.xnsg.foundation.bf
-
Result messages like errors or warnings.
- ResponseMessageDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
- ResponseMessageDTO(String, String, Integer) - Constructor for class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
- restartRFCServer() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
This method is only useful to be called from SAP via RFC.
- resultLanguageIsoCodes - Variable in class de.aeb.xnsg.foundation.bf.AbstractRequestDTO
-
2-letter ISO codes of the languages in which texts will be returned.
- resultState - Variable in class de.aeb.xnsg.foundation.bf.CreateClientResponseDTO
-
the result state of the operation, one of:
CreateClientResponseDTO.CLIENT_CREATED
CreateClientResponseDTO.CLIENT_IDENTCODE_EXISTS
CreateClientResponseDTO.CLIENT_IDENTICAL_EXISTS
- resultType - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
The result type of the PDF document, possible options are: PDFCLASSIC PDFXFAPREVIEW PDFXFAEDIT
- RESULTTYPE_PDFCLASSIC - Static variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
- RESULTTYPE_PDFXFAEDIT - Static variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
- RESULTTYPE_PDFXFAPREVIEW - Static variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
- retentionDaysLimit - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
In general, the documents are kept for 90 days.
- retentionDaysLimit - Variable in class de.aeb.xnsg.docservice.bf.DocumentStorageOptionsDTO
-
In general, archived documents are kept for 11 years.
- retentionDaysLimit - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
In general, the documents are kept for 90 days.
- retentionDaysLimit - Variable in class de.aeb.xnsg.docservice.bf.StagedDocumentOptionsDTO
-
In general, the documents are kept for 90 days.
- retentionTimestamp - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceResponseDTO
-
Date to which this document is at least stored in the document store.
- retentionTimestamp - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO
-
Date to which this document is at least stored in the document store.
- retentionTimestamp - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Date to which this document must be at least retained in the document store.
- retentionTimestamp - Variable in class de.aeb.xnsg.docservice.bf.PrepareDocumentInstanceResponseDTO
-
Date to which this document is at least stored in the document store.
- retentionTimestamp - Variable in class de.aeb.xnsg.docservice.bf.PrepareDocumentResponseDTO
-
Date to which this document is at least retained in the document store.
- retentionTimestamp - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceResponseDTO
-
Date to which this document is at least stored in the document store.
- retentionTimestamp - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentResponseDTO
-
Date to which this document is at least stored in the document store.
- RETRY_OFF - Static variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
- RETRY_TIMEOUT_DEFAULT - Static variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
- retryTimeout - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
-
In case the request can't be processed immediately, e.g.
- returnTotalCount - Variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
If
true
, the total number of documents found is returned in fieldQueryDocumentsResponseDTO.totalCount
. - returnTotalCount - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
If
true
, the total number of document reference objects found is returned in fieldGetDocumentReferenceObjectsResponseDTO.totalCount
. - returnTotalCount - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
-
If
true
, the total number of events is returned in fieldSyncEventsResponseDTO.totalCount
. - revisionComment - Variable in class de.aeb.xnsg.docservice.bf.doctype.PutDocTypeTemplateDTO
-
Revision comment.
- revisionComment - Variable in class de.aeb.xnsg.docservice.bf.doctype.ReplaceDocTypeTemplateDTO
-
Revision comment.
- revisionComment - Variable in class de.aeb.xnsg.docservice.bf.template.PutDocumentTemplateRequestDTO
-
Revision comment.
- revisionComment - Variable in class de.aeb.xnsg.docservice.bf.template.ReplaceDocumentTemplateRequestDTO
-
Revision comment.
- RoleInfoDTO - Class in de.aeb.xnsg.foundation.bf
- RoleInfoDTO() - Constructor for class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- roleInfos - Variable in class de.aeb.xnsg.foundation.bf.remoteadministration.role.ClientRolesDTO
- rolesInfos - Variable in class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesResponseDTO
- rootTypeName - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaDTO
- RuntimeInfoDTO - Class in de.aeb.xnsg.foundation.bf
-
This class holds various runtime information items of the server which serves this request.
- RuntimeInfoDTO() - Constructor for class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
- runtimeProperties - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
Runtime-Properties These are valid cluster-wide and stored in the DB, replacing/supplementing properties in product_configuration.properties
- RuntimeStateParmDTO - Class in de.aeb.xnsg.foundation.bf
-
This class contains parameter about asking the server about its runtime state.
- RuntimeStateParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.RuntimeStateParmDTO
- RuntimeStateResultDTO - Class in de.aeb.xnsg.foundation.bf
-
This class holds various information items of the server which serves this request.
- RuntimeStateResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.RuntimeStateResultDTO
S
- schema - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
-
Schema of the template.
- schema - Variable in class de.aeb.xnsg.docservice.bf.schema.SchemaToXsdRequestDTO
-
The schema to be parsed as XSD.
- schema - Variable in class de.aeb.xnsg.docservice.bf.schema.XsdToSchemaResponseDTO
-
The structured schema that was parsed from XSD.
- schema - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
-
Schema of the template.
- schemaToXsd(SchemaToXsdRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Converts the given structured
DocumentTemplateSchemaDTO
schema and returns it as a XSD file. - SchemaToXsdRequestDTO - Class in de.aeb.xnsg.docservice.bf.schema
- SchemaToXsdRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.schema.SchemaToXsdRequestDTO
- SchemaToXsdResponseDTO - Class in de.aeb.xnsg.docservice.bf.schema
- SchemaToXsdResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.schema.SchemaToXsdResponseDTO
- scope - Variable in class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesRequestDTO
-
Defines the amount of information to be returned: Valid values are "all" (all kind of roles), "basic" (only roles which are not system role nor technical role), "user" (roles that are not apiPredefined).
- scriptContent - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionParmDTO
-
string value represents the content of script
- ScriptExecutionRowDTO - Class in de.aeb.xnsg.foundation.bf
-
This dto contains the data of a single line in script result
- ScriptExecutionRowDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ScriptExecutionRowDTO
- ScriptExecutionStateParmDTO - Class in de.aeb.xnsg.foundation.bf
-
parameters necessary to ask the server for the current state of the script execution
- ScriptExecutionStateParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ScriptExecutionStateParmDTO
- ScriptExecutionStateResultDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result information of the script execution bf
- ScriptExecutionStateResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.ScriptExecutionStateResultDTO
- scriptType - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionParmDTO
-
type of script, sql, oql and java script are supported
- searchInArchive - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstanceRequestDTO
-
Defines whether the document and its contents should be searched in an optionally connected archive if the document does not exist in the DocumentService or is expired.
- searchInArchive - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentRequestDTO
-
Defines whether the document and its contents should be searched in an optionally connected archive if the document does not exist in the DocumentService or is expired.
- sendMail(SendMailParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Sends an email, supports multiple attachments, cc, bcc, etc...
- SendMailAttachmentParmDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains an attachment for an email.
- SendMailAttachmentParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SendMailAttachmentParmDTO
- SendMailParmDTO - Class in de.aeb.xnsg.foundation.bf
-
Parameter necessary for sending a mail, describes receivers replytos ccs bccs subject content contenttype (e.g.
- SendMailParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SendMailParmDTO
- SendMailResultDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result of the sendMail method.
- SendMailResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SendMailResultDTO
- sendTelemetryReport(ExternalTMReportRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IExternalTelemetryBF
- sendUserName - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
User account name who printed the document.
- sentAt - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Time when printing the document has been requested (sent to printer queue).
- sequenceNumber - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.PublishedDataFeedPartDTO
-
Consecutive number of the data feed part
- serverUrl - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
This is the server URL used by the server at runtime.
- serviceName - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
This is the service name, if the server is running as service or if not contains an empty String "".
- sessionid - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeDTO
-
The session id of the application facade which may be used as a parameter to read results from the application facade.
- setClientFeatures(SetClientFeaturesRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IInternalProvisioningBF
-
Update the client features for a given client.
- SetClientFeaturesRequestDTO - Class in de.aeb.xnsg.foundation.bf
- SetClientFeaturesRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SetClientFeaturesRequestDTO
- SetClientFeaturesResponseDTO - Class in de.aeb.xnsg.foundation.bf
- SetClientFeaturesResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SetClientFeaturesResponseDTO
- setEvent(SetSyncEventRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncInternalBF
- SetSyncEventRequestDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
Request DTO for setting an event.
- SetSyncEventRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SetSyncEventRequestDTO
- SetSyncEventResponseDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
Response DTO for setting an event.
- SetSyncEventResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SetSyncEventResponseDTO
- shellExecute - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeDTO
-
parameters when the application is to be invoked via shellExecute
- SimpleFileDTO - Class in de.aeb.xnsg.foundation.bf
-
Meta-data for a transfer file.
- SimpleFileDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SimpleFileDTO
- SimpleFileDTO(File) - Constructor for class de.aeb.xnsg.foundation.bf.SimpleFileDTO
- SimpleFileDTO(String) - Constructor for class de.aeb.xnsg.foundation.bf.SimpleFileDTO
- size - Variable in class de.aeb.xnsg.foundation.bf.paging.PageResponseDTO
-
The number of returned elements (as filtered by the provided
PageRequestDTO
). - size - Variable in class de.aeb.xnsg.foundation.bf.SimpleFileDTO
-
Size of a file
- size - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
Size of a file
- skipFirst - Variable in class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO
-
If set, defines the number of documents that will be skipped before collecting results.
- skipFirst - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO
-
If set, defines the number of document reference objects that will be skipped before collecting results.
- solutions - Variable in class de.aeb.xnsg.foundation.bf.ProductInfoDTO
-
This contains a list of names of all solutions, which are deployed to the server.
- StagedDocumentEditorParmsDTO - Class in de.aeb.xnsg.docservice.af
-
Parameter for application facade method
IDocumentServiceAF.openStagedDocumentEditor(de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO, StagedDocumentEditorParmsDTO)
- StagedDocumentEditorParmsDTO() - Constructor for class de.aeb.xnsg.docservice.af.StagedDocumentEditorParmsDTO
- stagedDocumentOptions - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
Options to define that the created document has to be stored in the engine for a certain amount of time.
- stagedDocumentOptions - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentRequestDTO
-
Options to define that the uploaded document has to be stored in the engine for a certain amount of time.
- StagedDocumentOptionsDTO - Class in de.aeb.xnsg.docservice.bf
-
Optional parameters to define, that the created document should be stored in the engine for a certain time.
- StagedDocumentOptionsDTO() - Constructor for class de.aeb.xnsg.docservice.bf.StagedDocumentOptionsDTO
- StagedDocumentSearchParmsDTO - Class in de.aeb.xnsg.docservice.af
-
Parameter for application facade method
IDocumentServiceAF.openStagedDocumentSearch(de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO, StagedDocumentSearchParmsDTO)
- StagedDocumentSearchParmsDTO() - Constructor for class de.aeb.xnsg.docservice.af.StagedDocumentSearchParmsDTO
- startScriptExecution(StartScriptExecutionParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Start the script execution
- StartScriptExecutionParmDTO - Class in de.aeb.xnsg.foundation.bf
-
parameters for start script execution
- StartScriptExecutionParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.StartScriptExecutionParmDTO
- StartScriptExecutionResultDTO - Class in de.aeb.xnsg.foundation.bf
-
result of start script execution
- StartScriptExecutionResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.StartScriptExecutionResultDTO
- startTableUpdate(StartTableUpdateParmDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Starts the table update, if necessary
- StartTableUpdateParmDTO - Class in de.aeb.xnsg.foundation.bf
-
parameter necessary for the table update
- StartTableUpdateParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.StartTableUpdateParmDTO
- StartTableUpdateResultDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result information of the start table update bf
- StartTableUpdateResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.StartTableUpdateResultDTO
- state - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine (the
processingInfos
can contain traces). TEMPLATE_MISSING - the document template is unknown to the server, retry when the template is available. TEMPLATE_VERSION_MISMATCH - the document template of the document type does not have the desired external tag. PROCESSING_PROBLEMS - there were some problems during the processing, seeprocessingInfos
for more information. REFERENCE_OBJECT_NOT_FOUND - the reference object has not been found. - state - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine (the
processingInfos
can contain traces) TEMPLATE_MISSING - the document template is unknown to the server, retry when the template is available TEMPLATE_TEMPLATE_VERSION_MISMATCH - the document template does not have the desired external tag PROCESSING_PROBLEMS - there were some problems during the processing, seeprocessingInfos
for more information DOCUMENT_NOT_FOUND - the referenced document to update has not been found DOCUMENT_LOCKED - the document to be updated is locked by a user or other process and cannot be updated. DOCUMENT_EXPIRED - the document to be updated has expired. - state - Variable in class de.aeb.xnsg.docservice.bf.DeleteDocumentInstanceResponseDTO
-
The result state of the deletion: SUCCESS - document has been deleted REFERENCE_OBJECT_NOT_FOUND - the given reference object has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.DeleteDocumentResponseDTO
-
The result state of the deletion: SUCCESS - document has been deleted. DOCUMENT_NOT_FOUND - the document to be deleted has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.DeletePrintRequestResponseDTO
-
The result of the delete print request operation.
- state - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeResponseDTO
-
The result state of the request: SUCCESS - document type has been created or updated NOT_FOUND = the document type to be updated has not been found. LOCKED - the document type to be updated is locked by a user or other process.
- state - Variable in class de.aeb.xnsg.docservice.bf.doctype.DeleteDocTypeResponseDTO
-
The result state of the deletion: SUCCESS - document type has been deleted NOT_FOUND - the document type to be deleted has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.doctype.GetDocTypeResponseDTO
-
The result state of the request: SUCCESS - the request was successful NOT_FOUND - the requested document type has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstanceResponseDTO
-
The result state of fetching the document: SUCCESS - the request was successful. REFERENCE_OBJECT_NOT_FOUND - the given reference object has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentInstancesResponseDTO
-
The result state of fetching the document: SUCCESS - the request was successful REFERENCE_OBJECT_NOT_FOUND - the given reference object has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.GetDocumentResponseDTO
-
The result state of fetching the document: SUCCESS - the request was successful. DOCUMENT_NOT_FOUND - the document to be fetched has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
State of the print request (may be null if not processed yet).
- state - Variable in class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentResponseDTO
-
The result state of the template processing: SUCCESS - everything is fine (the
processingInfos
can contain traces). TEMPLATE_MISSING - the document template is unknown to the server, retry when the template is available. TEMPLATE_VERSION_MISMATCH - the document template does not have the desired external tag. PROCESSING_PROBLEMS - there were some problems during the processing, seeprocessingInfos
for more information. - state - Variable in class de.aeb.xnsg.docservice.bf.PrepareDocumentInstanceResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine (the
processingInfos
can contain traces). TEMPLATE_MISSING - the document template is unknown to the server, retry when the template is available. TEMPLATE_VERSION_MISMATCH - the document template of the document type does not have the desired external tag. REFERENCE_OBJECT_NOT_FOUND - the reference object has not been found. - state - Variable in class de.aeb.xnsg.docservice.bf.PrepareDocumentResponseDTO
-
The result state of the document processing: SUCCESS - The staged document and the jobs to create the document contents were created successfully. TEMPLATE_MISSING - the document template is unknown to the server, retry when the template is available. TEMPLATE_TEMPLATE_VERSION_MISMATCH - the document template does not have the desired external tag. DOCUMENT_NOT_FOUND - the referenced document to update has not been found. DOCUMENT_LOCKED - the document to be updated is locked by a user or other process and cannot be updated. DOCUMENT_EXPIRED - the document to be updated has expired.
- state - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceResponseDTO
-
The result state of the document processing: SUCCESS - A print request for the referenced document has been created successfully. DOCUMENT_NOT_FOUND - The referenced document to be printed has not been found. DOCUMENT_LOCKED - the document to be printed is locked by a user or other process. DOCUMENT_EXPIRED - The referenced document to be printed has expired. LOCKED - an associated object (e.g.
- state - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine. REFERENCE_OBJECT_NOT_FOUND - the given reference object has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine. DOCUMENT_NOT_FOUND - the referenced document to update has not been found. DOCUMENT_LOCKED - the document to be updated is locked by a user or other process and cannot be updated. DOCUMENT_EXPIRED - the document to be updated has expired.
- state - Variable in class de.aeb.xnsg.docservice.bf.refobject.DeleteDocumentReferenceObjectResponseDTO
-
The result state of the deletion: SUCCESS - document reference object has been deleted NOT_FOUND - the document reference object to be deleted has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectResponseDTO
-
The result state of the request: SUCCESS - the request was successful NOT_FOUND - the requested reference object has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.refobject.PutDocumentReferenceObjectResponseDTO
-
The result state of the request: SUCCESS - document reference object has been created or updated. NOT_FOUND - the document reference object type has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.reftype.DeleteDocumentReferenceObjectTypeResponseDTO
-
The result state of the deletion: SUCCESS - document reference object type has been deleted. NOT_FOUND - the document reference object type to be deleted has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.reftype.GetDocumentReferenceObjectTypeResponseDTO
-
The result state of the request: SUCCESS - the request was successful NOT_FOUND - the requested reference object type has not been found.
- state - Variable in class de.aeb.xnsg.docservice.bf.reftype.PutDocumentReferenceObjectTypeResponseDTO
-
The result state of the request: SUCCESS - document reference object type has been created or updated LOCKED - the document reference object type to be updated is locked by a user or other process.
- state - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine. DOCUMENT_INSTANCE_CREATION_ERROR - the requested document instance could not be created. DOCUMENT_LOCKED - the document to be updated is locked by a user or other process and cannot be updated.
- state - Variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestResponseDTO
-
The result of the update print request operation.
- state - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine (the
processingInfos
can contain traces) TEMPLATE_MISSING - the document template is unknown to the server (if content was empty), retry with the template data PROCESSING_PROBLEMS - there were some problems during the processing, seeprocessingInfos
for more information length of the state: 20 - state - Variable in class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateResponseDTO
-
The result state of the document processing: SUCCESS - everything is fine (the
processingInfos
can contain traces) TEMPLATE_MISSING - the document template is unknown to the server (if content was empty), retry with the template data PROCESSING_PROBLEMS - there were some problems during the processing, seeprocessingInfos
for more information length of the state: 20 - state - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateFormResponseDTO
-
The state of the business facade call: SUCCESS - everything is fine TEMPLATE_MISSING - template PDF is unknown to the server (if content was empty) length of the state: 20
- state - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplatePagesResponseDTO
-
The state of the business facade call: SUCCESS - every thing is fine TEMPLATE_MISSING - template PDF is unknown to the server (if content was empty) length of the state: 20
- state - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationResponseDTO
-
The state of the business facade call: SUCCESS - everything is fine TEMPLATE_MISSING - template PDF is unknown to the server (if content was empty) VALIDATION_PROBLEMS - the validation found some problems, see
validationProblems
orvalidationProblemInfos
for more information length of the state: 20 - state - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFResponseDTO
-
The state of the business facade call: SUCCESS - everything is fine TEMPLATE_MISSING - template PDF is unknown to the server (if content was empty) length of the state: 20
- state - Variable in class de.aeb.xnsg.documentcore.bf.ValidateDocumentTemplateResponseDTO
-
The result state of the validation: SUCCESS - everything is fine TEMPLATE_MISSING - template PDF is unknown to the server (if content was empty), retry with the template data VALIDATION_PROBLEMS - the validation found some problems, see
validationInfos
for more information length of the state: 20 - state - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
state of the item described by this result - possible values are defined within the category
- state - Variable in class de.aeb.xnsg.foundation.bf.TableUpdateStateResultDTO
-
Whats the state of the table update? Is it still running, or was it successful?
- STATE_DELETE_PRINT_REQUEST_FAILED - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
An error occurred during the delete print request operation.
- STATE_DOCUMENT_CONTENT_CREATION_ERROR - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the creation of the document content(s) failed
- STATE_DOCUMENT_CONTENT_MISSING - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if a requested document content has not been found
- STATE_DOCUMENT_CONTENT_PENDING - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the asynchronous creation of requested content has not yet been completed yet.
- STATE_DOCUMENT_EXPIRED - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the requested document has been expired (e.g.
- STATE_DOCUMENT_INSTANCE_CREATION_ERROR - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the the creation of the document instance failed.
- STATE_DOCUMENT_LOCKED - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the document is locked by a user or other process and cannot be processed.
- STATE_DOCUMENT_NOT_FOUND - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if a requested document has not been found (document does not exist or is not visible to the user context)
- STATE_MULTIPLE_DOCUMENT_CONTENTS_FOUND - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if multiple document contents have been found when requesting a document content.
- STATE_OBJECT_LOCKED - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the requested object is locked by a user or other process and cannot be processed.
- STATE_OBJECT_NOT_FOUND - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if a requested object has not been found (object does not exist or is not visible to the user context).
- STATE_PRINTER_NOT_FOUND - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the resolved printer in the context is unavailable at the time of the print request.
- STATE_PROCESSING_PROBLEMS - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the document processing encountered problems
- STATE_PROCESSING_PROBLEMS - Static variable in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
The response state if the document processing encountered problems
- STATE_REFERENCE_OBJECT_NOT_FOUND - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if a requested document reference object has not been found (reference object does not exist or is not visible to the user context)
- STATE_SUCCESS - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if everything is fine
- STATE_SUCCESS - Static variable in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
The response state if everything is fine
- STATE_TEMPLATE_MISSING - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the template was not found among the existing templates
- STATE_TEMPLATE_MISSING - Static variable in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
The response state if the template was not found in the template cache directory
- STATE_TEMPLATE_VERSION_MISMATCH - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
The response state if the template was not tagged with the desired external tag.
- STATE_UPDATE_PRINT_REQUEST_FAILED - Static variable in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
An error occurred during the update print request operation.
- STATE_VALIDATION_PROBLEMS - Static variable in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
The response state if the validation encountered problems
- stateInfo - Variable in class de.aeb.xnsg.foundation.bf.RuntimeStateResultDTO
-
Additional information describing the server state - e.g.
- stateMessage - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
State message of the print request.
- stopOnError - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
Indicates a print job as sequential relevant.
- stopOnError - Variable in class de.aeb.xnsg.docservice.bf.PrintMonitoringOptionsDTO
-
If
true
printing will stop when error occurs. - storageId - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
The identifier of the storage object returned from the storage system.
- storageRetentionDaysLimit - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
In general, archived documents are kept for 11 years.
- storageRetentionDaysLimit - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
In general, archived documents are kept for 11 years.
- stringArrayEntries - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTelemetryReportDTO
-
all strings that should be reported
- stringEntries - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTelemetryReportDTO
-
all string arrays that should be reported
- stylevariant - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
Deprecated.
- subject - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
subject of the mail
- subrecords - Variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataRecordDTO
-
Subrecords of the record.
- subscribePartnerSystem(SubscribePartnerSystemRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncBF
-
Subscribe a partner system to be able to receive events for the specified business object type.
The subscription is uniquely identified by theclientSystemId
andbusinessObjectType
(both mandatory fields) - SubscribePartnerSystemRequestDTO - Class in de.aeb.xnsg.foundation.bf.sync
- SubscribePartnerSystemRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SubscribePartnerSystemRequestDTO
- SubscribePartnerSystemResponseDTO - Class in de.aeb.xnsg.foundation.bf.sync
- SubscribePartnerSystemResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SubscribePartnerSystemResponseDTO
- success - Variable in class de.aeb.xnsg.foundation.bf.ChangeAdminPasswordResultDTO
-
false, if old password was wrong
- success - Variable in class de.aeb.xnsg.foundation.bf.SendMailResultDTO
-
true
on success - supportedFormats - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessorInfoDTO
-
List of supported formats accepted in
DocumentProcessingOptionsDTO.format
. - supportedParseCommands - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessorInfoDTO
-
List of supported commands accepted in
ParseDocumentTemplateRequestDTO.query
- supportedProcessingParameters - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessorInfoDTO
-
List of supported parameters accepted in
DocumentProcessingOptionsDTO.parameters
. - supportedRemoteAdministrationOperations - Variable in class de.aeb.xnsg.foundation.bf.RuntimeStateResultDTO
-
Returns the supported operations as string array.
Each entry has the formBFName.methodName
where BFName is the simple class name of the interface class without leading 'I', and methodName is the method name.
This is derived from service name and operation name in corresponding WSDL. - syncDocumentInstance(SyncDocumentInstanceRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceExtBF
-
Like
IDocumentServiceBF.putDocumentInstanceTrusted(PutDocumentInstanceRequestDTO)
but with some additional features for embedded document synchronization from partner applications. - SyncDocumentInstanceRequestDTO - Class in de.aeb.xnsg.docservice.bf
-
Parameters for synchronizing a single external document.
- SyncDocumentInstanceRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
- SyncDocumentInstanceResponseDTO - Class in de.aeb.xnsg.docservice.bf
-
Contains the state of the synchronization and accompanying information about the document instance.
- SyncDocumentInstanceResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceResponseDTO
- SyncEventDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
DTO to hold data of one synchronized event.
- SyncEventDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
- SyncEventsRequestDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
Request DTO for synchronizing events.
- SyncEventsRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
- SyncEventsResponseDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
Response DTO for synchronizing events.
- SyncEventsResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SyncEventsResponseDTO
- synchronizeEvents(SyncEventsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncBF
-
Poll the next events for the client system.
This method requires the client system to persist the synchronisation state itself and passing a proper value forSyncEventsRequestDTO.syncId
.
SeeISyncBF.getNotAcknowledgedEvents(SyncEventsRequestDTO)
for a version of the method, where the synchronisation state is kept within the Engine. - syncId - Variable in class de.aeb.xnsg.foundation.bf.datatransfer.sync.AcknowledgePublishedDataTransferPackagesRequestDTO
-
Synchronization ID for acknowledging.
- syncId - Variable in class de.aeb.xnsg.foundation.bf.datatransfer.sync.GetPublishedDataTransferPackageResponseDTO
-
Synchronization ID for for acknowledging.
- syncId - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.AcknowledgePublishedDataFeedPartsRequestDTO
-
Synchronization ID for acknowledging.
- syncId - Variable in class de.aeb.xnsg.foundation.bf.extraction.feed.sync.GetPublishedDataFeedPartsResponseDTO
-
Synchronization ID for for acknowledging.
- syncId - Variable in class de.aeb.xnsg.foundation.bf.sync.AcknowledgeEventsRequestDTO
-
Synchronization ID for acknowledge.
- syncId - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventDTO
-
Monotonously increasing event identifier.
- syncId - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
-
Synchronization ID for delta-transmission.
- syncId - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsResponseDTO
-
Synchronization ID for delta-transmission.
- syncPartnerSystem - Variable in class de.aeb.xnsg.foundation.bf.sync.SubscribePartnerSystemResponseDTO
-
Registered partner system subscription.
- syncPartnerSystem - Variable in class de.aeb.xnsg.foundation.bf.sync.UnsubscribePartnerSystemResponseDTO
-
Previously registered partner system subscription (if any).
- SyncPartnerSystemDTO - Class in de.aeb.xnsg.foundation.bf.sync
-
Identification and other data of a single partner system subscription.
- SyncPartnerSystemDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.SyncPartnerSystemDTO
- syncPartnerSystems - Variable in class de.aeb.xnsg.foundation.bf.sync.GetPartnerSystemSubscriptionsResponseDTO
-
All or filtered registered partner system subscriptions.
- systemRole - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- systemSearch(SystemSearchParameterDTO[], String) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Searches the engine with the given parameters; Unknown parameters are ignored, valid values of the parameters must be obtained from other documentation.
- SystemSearchParameterDTO - Class in de.aeb.xnsg.foundation.bf
-
DTO used as argument to systemSearch function
- SystemSearchParameterDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SystemSearchParameterDTO
- SystemSearchResultDTO - Class in de.aeb.xnsg.foundation.bf
-
DTO contained in the result array of systemSearch function
- SystemSearchResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
T
- TableUpdateStateParmDTO - Class in de.aeb.xnsg.foundation.bf
-
the parameter necessary to ask the server for the current state of the table update
- TableUpdateStateParmDTO() - Constructor for class de.aeb.xnsg.foundation.bf.TableUpdateStateParmDTO
- TableUpdateStateResultDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result information of the get table update state bf
- TableUpdateStateResultDTO() - Constructor for class de.aeb.xnsg.foundation.bf.TableUpdateStateResultDTO
- tags - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
Additional tags that help to further describe the document (e.g.
- tags - Variable in class de.aeb.xnsg.docservice.bf.DocumentInfoDTO
-
Additional tags that help to further describe the document (e.g.
- tags - Variable in class de.aeb.xnsg.docservice.bf.PutDocumentInstanceRequestDTO
-
Additional tags that help to further describe the document (e.g.
- tags - Variable in class de.aeb.xnsg.docservice.bf.StagedDocumentOptionsDTO
-
Additional tags that help to further describe the document (e.g.
- tags - Variable in class de.aeb.xnsg.docservice.bf.SyncDocumentInstanceRequestDTO
-
Additional tags that help to further describe the document (e.g.
- template - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
The template to be used.
- template - Variable in class de.aeb.xnsg.docservice.bf.doctype.CreateDocTypeRequestDTO
-
Definition of the template to be created.
- template - Variable in class de.aeb.xnsg.docservice.bf.doctype.PutDocTypeRequestDTO
-
Definition of the template to be created or replaced with new contents.
- template - Variable in class de.aeb.xnsg.docservice.bf.doctype.ReplaceDocTypeRequestDTO
-
Definition of the template to be replaced and the new contents.
- template - Variable in class de.aeb.xnsg.docservice.bf.ParseDocumentTemplateContentRequestDTO
-
Reference to the template to be used.
- template - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentRequestDTO
-
The template to be used.
- template - Variable in class de.aeb.xnsg.documentcore.bf.ParseDocumentTemplateRequestDTO
-
The template to be used.
- template - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateFormRequestDTO
-
All necessary information for the template
- template - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplatePagesRequestDTO
-
All necessary information for the template
- template - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationRequestDTO
-
All necessary information for the template
- template - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFRequestDTO
-
The template to be used.
- template - Variable in class de.aeb.xnsg.documentcore.bf.ValidateDocumentTemplateRequestDTO
-
Template information
- templateFileData - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeTemplateDTO
-
Content of the template file.
- templateFileData - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateInputRequestDTO
-
Content of the template file.
- templateInfo - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
-
Additional info on document template.
- templateName - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeRequestDTO
-
The name of the template to use.
- templateName - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
-
The name of the document template.
- text - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateDocumentationTextDTO
-
Complete (multiline) template documentation.
- text - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateLocalizedTextDTO
- text - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaFieldDocumentationDTO
- text - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
explanation of this search result;
- text - Variable in class de.aeb.xnsg.foundation.bf.TextInLanguageDTO
-
The translated text.
- TextInLanguageDTO - Class in de.aeb.xnsg.foundation.bf
-
A translated text in one of the specified languages.
- TextInLanguageDTO() - Constructor for class de.aeb.xnsg.foundation.bf.TextInLanguageDTO
- TextInLanguageDTO(String, String) - Constructor for class de.aeb.xnsg.foundation.bf.TextInLanguageDTO
- texts - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateLocalizedTextsDTO
- TextTranslationDTO - Class in de.aeb.xnsg.foundation.bf
-
Abstract superclass of DTOs to hold data text translation data.
- TextTranslationDTO() - Constructor for class de.aeb.xnsg.foundation.bf.TextTranslationDTO
- TextTranslationRestDTO - Class in de.aeb.xnsg.foundation.bf.rest
- TextTranslationRestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.rest.TextTranslationRestDTO
- timeout - Variable in class de.aeb.xnsg.documentcore.bf.JobProcessingOptionsDTO
-
The timeout (in milliseconds) specifies how long it shall be waited for an answer.
- timeout - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
The timeout (in milliseconds) specifies how long it shall be waited for an answer.
- timeoutSubmit - Variable in class de.aeb.xnsg.documentcore.bf.JobProcessingOptionsDTO
-
The timeout (in milliseconds) specifies how long it shall be waited for the task to be accepted for execution.
- timeoutSubmit - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
The timeout (in milliseconds) specifies how long it shall be waited for the task to be accepted for execution.
- timezone - Variable in class de.aeb.xnsg.foundation.bf.DateAndZoneDTO
-
Time zone of the time stamp.
- title - Variable in class de.aeb.xnsg.docservice.bf.DocumentStorageOptionsDTO
-
User defined document title
- to - Variable in class de.aeb.xnsg.foundation.bf.AbsoluteIntervalFilterDTO
-
End date of the interval in the format 'yyyy-MM-dd[ HH:mm:ss[z]]' (the time and zone is optional).
- to - Variable in class de.aeb.xnsg.foundation.bf.RelativeIntervalFilterDTO
-
Defines the 'to' interval.
- topOffsetmm - Variable in class de.aeb.xnsg.documentcore.bf.PDFPageOffsetDTO
-
The adjustment from the top in mm
- toString() - Method in class de.aeb.xnsg.documentcore.bf.DocumentProcessingInfoDTO
- toString() - Method in class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
- toString() - Method in class de.aeb.xnsg.documentcore.bf.DocumentValidationInfoDTO
- toString() - Method in class de.aeb.xnsg.foundation.bf.ResponseMessageDTO
- toString() - Method in class de.aeb.xnsg.foundation.bf.TextInLanguageDTO
- totalCount - Variable in class de.aeb.xnsg.docservice.bf.QueryDocumentsResponseDTO
-
The total count of documents.
- totalCount - Variable in class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsResponseDTO
-
The total count of document reference objects.
- totalCount - Variable in class de.aeb.xnsg.foundation.bf.paging.PageResponseDTO
-
Calculated total number of available elements (if requested).
- totalCount - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsResponseDTO
-
The total count of available events.
- trace - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFResponseDTO
-
The trace as array of lines
- traceLanguageISOCode - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
-
The language ISO code of the language which should be used to produce the trace length of the ISO Code: 2
- TransferFileParameterDTO - Class in de.aeb.xnsg.foundation.bf
-
A generic parameter for use-case specific information, e.g.
- TransferFileParameterDTO() - Constructor for class de.aeb.xnsg.foundation.bf.TransferFileParameterDTO
- TransferFileRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains information on how to chose a file transfer for further processing.
- TransferFileRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.TransferFileRequestDTO
- TransferFileResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result for a transfer file request.
- TransferFileResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.TransferFileResponseDTO
- translateDataRequired - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
If set to
true
the values of document data (xmlData/jsonData) will be translated. - translateDataRequired - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
If set to
true
the values of document data (xmlData/jsonData) will be translated. - translations - Variable in class de.aeb.xnsg.docservice.bf.doctype.AbstractDocTypeRequestDTO
-
Translations of the type for different languages.
- translations - Variable in class de.aeb.xnsg.docservice.bf.doctype.DocTypeDTO
-
Translations of the type for different languages.
- translations - Variable in class de.aeb.xnsg.docservice.bf.reftype.DocumentReferenceObjectTypeDTO
-
Translations of the type for different languages.
- translations - Variable in class de.aeb.xnsg.docservice.bf.reftype.PutDocumentReferenceObjectTypeRequestDTO
-
Translations of the type for different languages.
- type - Variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Data type of the field.
- type - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
type of result, e.g.
- TYPE_BASE64BINARY - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for type 'base64Binary'
- TYPE_BOOLEAN - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for type 'boolean'
- TYPE_DATETIME - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for type 'dateTime'
- TYPE_DECIMAL - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for type 'decimal'
- TYPE_INT - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for type 'int'
- TYPE_LONG - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for type 'long'
- TYPE_STRING - Static variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Constant for type 'string'
- types - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateSchemaDTO
U
- unit - Variable in class de.aeb.xnsg.foundation.bf.IntervalFromNowFilterDTO
-
Defines the unit for the interval from 'now'.
- unsubscribePartnerSystem(UnsubscribePartnerSystemRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncBF
-
Unsubscribe a partner system from being able to receive events for the specified business object type.
The subscription is uniquely identified by theclientSystemId
andbusinessObjectType
(both mandatory fields) - UnsubscribePartnerSystemRequestDTO - Class in de.aeb.xnsg.foundation.bf.sync
- UnsubscribePartnerSystemRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.UnsubscribePartnerSystemRequestDTO
- UnsubscribePartnerSystemResponseDTO - Class in de.aeb.xnsg.foundation.bf.sync
- UnsubscribePartnerSystemResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.sync.UnsubscribePartnerSystemResponseDTO
- updateComment - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMReportRequestDTO
-
Comment that is stored with the telemetry report filing (optional).
- updatePrintRequest(UpdatePrintRequestRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Updates print request state by requested operation.
- UpdatePrintRequestRequestDTO - Class in de.aeb.xnsg.docservice.bf
- UpdatePrintRequestRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
- UpdatePrintRequestResponseDTO - Class in de.aeb.xnsg.docservice.bf
- UpdatePrintRequestResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.UpdatePrintRequestResponseDTO
- uploadFile - Variable in class de.aeb.xnsg.foundation.bf.UploadFileRequestDTO
-
A transmitted file
- uploadFile(UploadFileRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Receives a file for processing on the server.
- UploadFileMultiPartRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains information on how a transmitted file should be processed, e.g.
- UploadFileMultiPartRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
- UploadFileRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains information on how a transmitted file should be processed, e.g.
- UploadFileRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.UploadFileRequestDTO
- UploadFileResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
Contains the result for a upload file request.
- UploadFileResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.UploadFileResponseDTO
- UploadSettingsRequestDTO - Class in de.aeb.xnsg.foundation.bf
-
retrieves the server settings for uploading files via SFT interface
- UploadSettingsRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.UploadSettingsRequestDTO
- UploadSettingsResponseDTO - Class in de.aeb.xnsg.foundation.bf
-
retrieves the server settings for uploading files via SFT interface
- UploadSettingsResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.UploadSettingsResponseDTO
- urlCloseToken - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeDTO
-
url token to check on the remote system (for example SAP) if the browser was closed.
- user - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
The user of the new session.
It is not required, that this user is a valid user name of the client. - userLocale - Variable in class de.aeb.xnsg.documentcore.bf.JobProcessingOptionsDTO
-
The language locale which should be used to produce the processing information
- userLocale - Variable in class de.aeb.xnsg.documentcore.bf.ParseProcessingOptionsDTO
-
The language locale which should be used to produce the processing information
- userLocale - Variable in class de.aeb.xnsg.documentcore.bf.ValidateDocumentTemplateRequestDTO
-
The language locale which should be used to formulate the validation problems TODO currently, the language ISO code is required/used here (e.g.
- userName - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateResponseDTO
-
Name of the user who initiated the print request
- userName - Variable in class de.aeb.xnsg.foundation.bf.AbstractRequestDTO
-
User who initiated the request from the client system.
- userName - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientUserDTO
- utcStopAtYYYYMMDDHHMMSS - Variable in class de.aeb.xnsg.foundation.bf.AnnounceStopParmDTO
-
the server will stop at this date/time
- uuid - Variable in class de.aeb.xnsg.foundation.bf.ScriptExecutionStateParmDTO
-
uuid assigned to the BF call
- uuid - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionResultDTO
-
uuid assigned to the BF call
V
- validate(ValidateDocumentTemplateRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Checks the document template for possible format or syntactic problems, which would make problems during the document processing.
- ValidateDocumentTemplateRequestDTO - Class in de.aeb.xnsg.documentcore.bf
-
The parameters for the document template validation
- ValidateDocumentTemplateRequestDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ValidateDocumentTemplateRequestDTO
- ValidateDocumentTemplateResponseDTO - Class in de.aeb.xnsg.documentcore.bf
-
Information on format or syntactic problems in a document template.
- ValidateDocumentTemplateResponseDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.ValidateDocumentTemplateResponseDTO
- validatePDFXFATemplate(PDFTemplateValidationRequestDTO) - Method in interface de.aeb.xnsg.documentcore.bf.IDocumentCoreBF
-
Deprecated.use
IDocumentCoreBF.validate(ValidateDocumentTemplateRequestDTO)
with the "PDFXFA" processor (seePDFXFADocumentTemplateDTO.PROCESSOR
) - validatePrinterName - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
-
Checks whether the resolved printer in the context is known at the current time.
No print request is created if this is not the case. - VALIDATION_FAILED - Static variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateResponseDTO
-
Error code that indicates input validation failed.
- validationInfos - Variable in class de.aeb.xnsg.documentcore.bf.ValidateDocumentTemplateResponseDTO
-
The validation problems as array of structured information (problem description, element path, correction hint)
- validationProblemInfos - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationResponseDTO
-
The conversion problems as array of structured information (problem description, element path, LCD hint)
- validationProblems - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationResponseDTO
-
The conversion problems as array of lines (legacy interface)
- validationProblemsLanguageISOCode - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationRequestDTO
-
The language ISO code of the language which should be used for the validation problems length of the ISO Code: 2
- value - Variable in class de.aeb.xnsg.documentcore.bf.DocumentProcessingParameterDTO
-
Parameter value (optional; the parameter name can also be used as a marker).
- value - Variable in class de.aeb.xnsg.foundation.bf.genericdata.GenericDataFieldDTO
-
Value of the field.
- value - Variable in class de.aeb.xnsg.foundation.bf.MonitoringDataProviderDTO
-
Value of the entry - this is a string representation.
- value - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDateEntryDTO
-
data for the entry to report
- value - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRDoubleEntryDTO
-
data for the entry to report
- value - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRIntegerEntryDTO
-
data for the entry to report
- value - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRLongEntryDTO
-
data for the entry to report
- value - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringArrayEntryDTO
-
data for the entry to report
- value - Variable in class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMRStringEntryDTO
-
data for the entry to report
- value - Variable in class de.aeb.xnsg.foundation.bf.TransferFileParameterDTO
-
Value of the parameter
- VALUE_DATA_BINDING_NSG - Static variable in class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
-
Value for the data binding syntax
DOCXDocumentTemplateDTO.PARAM_DATA_BINDING
. - VALUE_DATA_BINDING_NSGDEF - Static variable in class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
-
Value for the data binding syntax
DOCXDocumentTemplateDTO.PARAM_DATA_BINDING
. - VALUE_DATA_BINDING_NSGDEF - Static variable in class de.aeb.xnsg.documentcore.bf.XLSXDocumentTemplateDTO
-
Value for the data binding syntax
XLSXDocumentTemplateDTO.PARAM_DATA_BINDING
. - VALUE_DATA_BINDING_XNSG - Static variable in class de.aeb.xnsg.documentcore.bf.DOCXDocumentTemplateDTO
-
Value for the data binding syntax
DOCXDocumentTemplateDTO.PARAM_DATA_BINDING
. - VALUE_DATA_BINDING_XNSG - Static variable in class de.aeb.xnsg.documentcore.bf.XLSXDocumentTemplateDTO
-
Value for the data binding syntax
XLSXDocumentTemplateDTO.PARAM_DATA_BINDING
. - valueOf(String) - Static method in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class de.aeb.xnsg.docservice.bf.AbstractQueryDocumentsRequestDTO.OrderByField
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class de.aeb.xnsg.docservice.bf.refobject.GetDocumentReferenceObjectsRequestDTO.OrderByField
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version - Variable in class de.aeb.xnsg.foundation.bf.VersionInfoDTO
-
The version string of the solution/product.
- VersionInfoDTO - Class in de.aeb.xnsg.foundation.bf
-
This class holds version information about a solution or product in a server.
- VersionInfoDTO() - Constructor for class de.aeb.xnsg.foundation.bf.VersionInfoDTO
W
- warning - Variable in class de.aeb.xnsg.documentcore.bf.DocumentValidationInfoDTO
-
Textual description of the validation problem
- warning - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateValidationProblemInfoDTO
-
Textual description of the validation problem
- withClient(String) - Method in class de.aeb.xnsg.foundation.bf.remoteadministration.role.ClientRolesDTO
-
Fluent setter for
ClientRolesDTO.client
. - withClientIdentCodes(String[]) - Method in class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesRequestDTO
- withResultLanguageIsoCodes(String[]) - Method in class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesRequestDTO
- withRoleInfos(RoleInfoDTO[]) - Method in class de.aeb.xnsg.foundation.bf.remoteadministration.role.ClientRolesDTO
-
Fluent setter for
ClientRolesDTO.roleInfos
. - withScope(String) - Method in class de.aeb.xnsg.foundation.bf.remoteadministration.role.GetRolesRequestDTO
- withTemplate - Variable in class de.aeb.xnsg.docservice.bf.doctype.DeleteDocTypeRequestDTO
-
Also deletes the template if available and if it is managed externally.
- workDir - Variable in class de.aeb.xnsg.foundation.af.AFExecuteProcessParmsDTO
-
the current directory to be set for the process created as given in executable may be null
- workplace(ApplicationFacadeParmsDTO) - Method in interface de.aeb.xnsg.foundation.af.IFoundationAF
-
Creates an application facade to be able to display the workplace.
The difference of this method compared to the the method "IFoundationBF.getWorkplaceURL()" is the fact, that no logon mask will be displayed before entering the workplace
The RFC name of this function is "/AEB/XNSG_IF_WPL" - WorkstationDTO - Class in de.aeb.xnsg.docservice.bf
- WorkstationDTO() - Constructor for class de.aeb.xnsg.docservice.bf.WorkstationDTO
- workstationId - Variable in class de.aeb.xnsg.docservice.af.PrintRequestQueueACSettingsDTO
-
The id of the workstation for which the print requests have to be shown.
- workstationId - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
The unique identifier of the workstation (must be unique within the same client) for which the document has to be created.
- workstationId - Variable in class de.aeb.xnsg.docservice.bf.DeletePrintRequestRequestDTO
-
The unique identifier of the workstation (must be unique within the same client) for which the print request was created.
- workstationId - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestsRequestDTO
-
The unique identifier of the workstation (must be unique within the same client) for which the print request was created.
- workstationId - Variable in class de.aeb.xnsg.docservice.bf.GetPrintRequestStateRequestDTO
-
The unique identifier of the workstation (must be unique within the same client) for which the print request was created.
- workstationId - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
-
The unique identifier of the workstation (must be unique within the same client) for which the document has to be printed.
- workstationId - Variable in class de.aeb.xnsg.docservice.bf.UpdatePrintRequestRequestDTO
-
The unique identifier of the workstation (must be unique within the same client) for which the print request was created.
- workstationId - Variable in class de.aeb.xnsg.docservice.bf.WorkstationDTO
-
Unique identifier of this workstation (must be unique within the same client).
- workstationId - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
The unique workstation identifier of the new session.
The identifier of the workstation must be configured and unique within the same client. - workstationSessionId - Variable in class de.aeb.xnsg.docservice.bf.PrintDocumentInstanceRequestDTO
-
For printing on local workstations (not via Cloud Printing)
In contrast to thePrintDocumentInstanceRequestDTO.workstationId
which defines the output context owner (to determine output printing settings) thePrintDocumentInstanceRequestDTO.workstationSessionId
defines a concrete session agent bound to the local workstation e.g. - workstationSessionId - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
-
The unique workstation agent session identifier of the new session.
It defines a concrete and already established session agent bound to the local workstation e.g.
X
- xfaContent - Variable in class de.aeb.xnsg.documentcore.bf.PDFTemplateFormResponseDTO
-
The XFA form structure data (as XML bytes)
- XLSXDocumentTemplateDTO - Class in de.aeb.xnsg.documentcore.bf
-
An empty implementation of DocumentTemplateDTO, with predefined constants for the XLSX processor (MS Excel).
- XLSXDocumentTemplateDTO() - Constructor for class de.aeb.xnsg.documentcore.bf.XLSXDocumentTemplateDTO
- xmlData - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentInstanceRequestDTO
-
The raw XML data to fill in the template with.
- xmlData - Variable in class de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO
-
The raw XML data to fill in the template with.
- xmlData - Variable in class de.aeb.xnsg.docservice.bf.template.DocumentTemplateExampleFileDTO
-
XML content of the example file.
- xmlData - Variable in class de.aeb.xnsg.documentcore.bf.GenerateDocumentRequestDTO
-
The raw XML data to fill in the template with.
- xmlData - Variable in class de.aeb.xnsg.documentcore.bf.ProcessPDFRequestDTO
-
The raw XML data to fill in the template with.
- xsd - Variable in class de.aeb.xnsg.docservice.bf.schema.SchemaToXsdResponseDTO
-
Schema parsed as XSD.
- xsd - Variable in class de.aeb.xnsg.docservice.bf.schema.XsdToSchemaRequestDTO
-
The XSD schema to be parsed as structured schema.
- xsdToSchema(XsdToSchemaRequestDTO) - Method in interface de.aeb.xnsg.docservice.bf.IDocumentServiceBF
-
Parses the given XSD schema file and returns it as a structured
DocumentTemplateSchemaDTO
. - XsdToSchemaRequestDTO - Class in de.aeb.xnsg.docservice.bf.schema
- XsdToSchemaRequestDTO() - Constructor for class de.aeb.xnsg.docservice.bf.schema.XsdToSchemaRequestDTO
- XsdToSchemaResponseDTO - Class in de.aeb.xnsg.docservice.bf.schema
- XsdToSchemaResponseDTO() - Constructor for class de.aeb.xnsg.docservice.bf.schema.XsdToSchemaResponseDTO
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
IDocumentServiceBF.queryDocumentsById(QueryDocumentsByIdRequestDTO)
instead.