A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
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
- 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
- acknowledgeEvents(AcknowledgeEventsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.ISyncBF
-
Acknowledge events got with
ISyncBF.getNotAcknowledgedEvents(SyncEventsRequestDTO)
.
Since XNSG 4.0, Nov. - 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
- 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
-
Request parameter for
IDataTransferBF#acknowledgePublishedDataTransferPackages(AcknowledgeGetPublishedDataTransferPackageRequestDTO)
. - AcknowledgePublishedDataTransferPackagesRequestDTO() - Constructor for class de.aeb.xnsg.foundation.bf.datatransfer.sync.AcknowledgePublishedDataTransferPackagesRequestDTO
- AcknowledgePublishedDataTransferPackagesResponseDTO - Class in de.aeb.xnsg.foundation.bf.datatransfer.sync
-
Response (result) for
IDataTransferBF#acknowledgePublishedDataTransferPackages(AcknowledgeGetPublishedDataTransferPackageRequestDTO)
. - AcknowledgePublishedDataTransferPackagesResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.datatransfer.sync.AcknowledgePublishedDataTransferPackagesResponseDTO
- 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.
- 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.
- 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
- 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
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.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
- 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.
- 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.
- 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.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
- contentType - Variable in class de.aeb.xnsg.foundation.bf.SendMailParmDTO
-
content-type of the mail
- convertToUploadFileRequestDTO() - Method in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
- 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
- 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
- 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.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.genericdata - package de.aeb.xnsg.foundation.bf.genericdata
- 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.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.CreateClientRequestDTO
-
The debtor number (Kundennummer) of a client.
- debtorNumber - Variable in class de.aeb.xnsg.foundation.bf.GenerateClientIdentCodeRequestDTO
- 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.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.
- 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
- 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
- duplicateClient(DuplicateClientRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Deprecated.
- 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
- 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.
- 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.
- 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
- ExternalTMStatusResponseDTO() - Constructor for class de.aeb.xnsg.foundation.bf.telemetry.ExternalTMStatusResponseDTO
F
- 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
- 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
- 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.
G
- 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
- 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
- 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
- getDownloadableFilesRefs(DLFilesRefsRequestDTO) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Returns the number of files available for download.
- getDuplicateClientProgress(String) - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Deprecated.
- getFileChecksum(File) - Static method in class de.aeb.xnsg.foundation.bf.FileDTO
-
Get the MD5 Hash from a file.
- 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.
Since XNSG 4.0, Nov. - getNumberOfClients() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
- 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)
Since XNSG 4.0, Nov. - 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
- getProductInfo() - Method in interface de.aeb.xnsg.foundation.bf.IFoundationBF
-
Return information about the server that is answering this request.
- 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
- 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.
- 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
- 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.
- 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.
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
- IDataTransferBF - Interface in de.aeb.xnsg.foundation.bf
-
Business facade for fetching published data transfer packages.
- 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.RoleInfoDTO
- IExternalTelemetryBF - Interface in de.aeb.xnsg.foundation.bf
-
Business facade for sending telemetry data from a third party system.
- IFoundationBF - Interface in de.aeb.xnsg.foundation.bf
-
Business facade for the XNSGFoundation
- IInternalProvisioningBF - Interface in de.aeb.xnsg.foundation.bf
-
Internal business facade for provisioning clients from a template.
- 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.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
- 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.
- IRemoteAdminBF - Interface in de.aeb.xnsg.foundation.bf
-
Remote Administration tools use this methods.
- 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
- 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.sync.SyncEventsResponseDTO
-
True, if the synchronization is complete and currently no further events are available.
- 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
- isPreparedForStop - Variable in class de.aeb.xnsg.foundation.bf.RuntimeInfoDTO
-
True, if an announcement for a job is active.
- 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.
- 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.
K
- 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
L
- 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.
- 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.
- licenseRole - Variable in class de.aeb.xnsg.foundation.bf.RoleInfoDTO
- 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
- maxFileSize - Variable in class de.aeb.xnsg.foundation.bf.UploadSettingsResponseDTO
-
maximum size of uploadable files
- maxRows - Variable in class de.aeb.xnsg.foundation.bf.StartScriptExecutionParmDTO
-
max.
- 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
- MonitoringDataProviderDTO - Class in de.aeb.xnsg.foundation.bf
-
Data Transfer Object for monitoring provider
- MonitoringDataProviderDTO() - Constructor for class de.aeb.xnsg.foundation.bf.MonitoringDataProviderDTO
N
- 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
- notificationEmailAddress - Variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateRequestDTO
-
Primary email address to send important notifications to, e.g.
O
- oldPassword - Variable in class de.aeb.xnsg.foundation.bf.ChangeAdminPasswordParmDTO
-
the old admin password
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.
- 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.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;
- password - Variable in class de.aeb.xnsg.foundation.bf.DuplicateClientUserDTO
- percentage - Variable in class de.aeb.xnsg.foundation.bf.TableUpdateStateResultDTO
-
How far has the table update went
- 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.
- 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)
. - 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.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.
- 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
. - 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
- 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.
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. - 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
- relevance - Variable in class de.aeb.xnsg.foundation.bf.SystemSearchResultDTO
-
relevance of the result; an indication (in percent, ranging from 0 ..
- 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.
- 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
- returnTotalCount - Variable in class de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
-
If
true
, the total number of events is returned in fieldSyncEventsResponseDTO.totalCount
. - 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
- 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
- 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
- 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
- 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
- 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 "".
- 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
- 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.SimpleFileDTO
-
Size of a file
- size - Variable in class de.aeb.xnsg.foundation.bf.UploadFileMultiPartRequestDTO
-
Size of a file
- 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.
- 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.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?
- stateInfo - Variable in class de.aeb.xnsg.foundation.bf.RuntimeStateResultDTO
-
Additional information describing the server state - e.g.
- 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
- 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)
Since XNSG 4.0, Nov. - 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 - 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. - 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, were the syncronisation 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.sync.AcknowledgeEventsRequestDTO
-
Synchronization ID for acknowledge.
- 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
- 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
- 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
- timezone - Variable in class de.aeb.xnsg.foundation.bf.DateAndZoneDTO
-
Time zone of the time stamp.
- 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.
- 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.foundation.bf.sync.SyncEventsResponseDTO
-
The total count of available events.
- 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
- 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'
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)
Since XNSG 4.0, Nov. - 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).
- 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
- 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
- VALIDATION_FAILED - Static variable in class de.aeb.xnsg.foundation.bf.provisioning.CreateClientFromTemplateResponseDTO
-
Error code that indicates input validation failed.
- 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
- 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
- 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
All Classes All Packages