Index (Storage_ClientIF.4.0 20240307 API)

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

A

AbstractStorageObjectDTO - Class in de.aeb.xnsg.storage.bf.dto: The superclass for every data transfer object used by the storage interface.
AbstractStorageObjectDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.AbstractStorageObjectDTO
AbstractStorageRequestDTO - Class in de.aeb.xnsg.storage.bf.dto.request: This is the superclass for all request DTOs.
AbstractStorageRequestDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO
AbstractStorageRequestDTO(String, String, String) - Constructor for class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO
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.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen
adapterIdentCode - Variable in class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO: The identifier of the adapter which is configured in the storage interface administration (eg.
adapters - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageGetAdaptersResponseDTO: A list of StorageAdapterDTO objects.
addKey(String, String) - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: add the name value pair as key field to the key field array, does nothing if there is already a key with this name
addKey(String, String, boolean) - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: add the name value pair as key field to the key field array
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
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
applicationFacadeParms - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetSearchApplicationRequestDTO: parameter dto for the af call (e.g.
applicationFacadeParms - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetViewDataApplicationRequestDTO: parameter dto for the af call (e.g.
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.storage.bf.dto.response.StorageStoreDataResponseDTO: This is the timestamp when the data is stored in the storage system.
arraysEquals(T[], T[]) - Method in class de.aeb.xnsg.storage.bf.dto.AbstractStorageObjectDTO: Do some standard ordering, so that arrays can be compared correctly.

B

BILLING - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA
businessArea - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: This is the name of the business area, to which the storage data belongs to (eg.
businessClientIdentCode - Variable in class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO: The client identification provided by the business application for identification purpose
businessClientIdentCode - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO

C

client - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO: The client of the new session.
clientIdentCode - Variable in class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO: The client identification provided by the business application for authentication purpose
clientIdentCode - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetAdaptersRequestDTO: The client identification provided by the business application.
clientIdentCode - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO
clone() - Method in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.AbstractStorageObjectDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureFieldDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.DescriptionTTDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetSearchApplicationRequestDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetAdaptersResponseDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO
clone() - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO
companyName - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: This is the name of the global company of this customer.
The difference between global company name and client name is for business service provider which have to separate the data for their customers.
compareTo(StorageAdapterDTO) - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageAdapterDTO
COMPLIANCE - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA
contents - Variable in class de.aeb.xnsg.foundation.af.AFShellExecuteParmsDTO: this is the contents that has to be written to the file
CUSTOMS - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA
CUSTOMS_INBOUND - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA
CUSTOMS_OUTBOUND - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA

D

data - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The raw data object.
dataLength - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The length of the data in number of bytes
dataObject - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO: The data/documents to store in the storage system information.
dataObject - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO: The retrieved data/documents from the storage system.
DataSetStructureDTO - Class in de.aeb.xnsg.storage.bf.dto: Describes the structure of a data record (serialized data object)
DataSetStructureDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO: Constructor
DataSetStructureFieldDTO - Class in de.aeb.xnsg.storage.bf.dto: Describes a field inside a record inside the structure of a data record (serialized data object)
DataSetStructureFieldDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.DataSetStructureFieldDTO
DataSetStructureRecordDTO - Class in de.aeb.xnsg.storage.bf.dto: Describes a record inside the structure of a data record (serialized data object)
DataSetStructureRecordDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO: Constructor
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.storage.bf - package de.aeb.xnsg.storage.bf: Contains the business facade interface for the storage API.
de.aeb.xnsg.storage.bf.dto - package de.aeb.xnsg.storage.bf.dto: Contains all Data Transfer Objects for the storage interface.
de.aeb.xnsg.storage.bf.dto.request - package de.aeb.xnsg.storage.bf.dto.request: Contains the data transfer objects for the request parameter of the business facade interface of the storage API.
de.aeb.xnsg.storage.bf.dto.response - package de.aeb.xnsg.storage.bf.dto.response: Contains the data transfer objects for the response parameter of the business facade interface of the storage API.
defaultExportLevel - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO: The default export level of the structure
deleteOldDocuments - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO: Deprecated.
since FP 08-2023: Reindexing will no longer be supported in future CSE versions.
description - Variable in class de.aeb.xnsg.storage.bf.dto.DescriptionTTDTO: The description for the object
description - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageAdapterDTO: A more detailed description of this adapter.
DescriptionTTDTO - Class in de.aeb.xnsg.storage.bf.dto: a description in a specific language
DescriptionTTDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.DescriptionTTDTO: Constructor
DESPATCH - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA
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
documentDate - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The creation date of the stored document.
documentName - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The name of the document (eg.
documents - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: A list of StorageDocumentDTO objects which represents the concrete data to store in the storage system.
documentType - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The type of the document (e.g.
documentVersion - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The version of the document (e.g.

E

encoding - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The encoding so that the data can be interpreted correctly.
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.AbstractStorageObjectDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureFieldDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.DescriptionTTDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetAdaptersRequestDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetDataRequestDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetSearchApplicationRequestDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetUrlRequestDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetViewDataApplicationRequestDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageAdapterDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetAdaptersResponseDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetUrlResponseDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.StorageKeyFieldDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO
equals(Object) - Method in class de.aeb.xnsg.storage.bf.dto.StorageRevisionInfoDTO
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

F

fields - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO: The fields of the record
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
fullindex - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The flag if this raw data object should be full indexed.
fulltextString - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: An optional text field which should be fulltext-indexed.
This depends on the concrete implementation of the used storage adapter.

G

GENERAL - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA
getAdapters(StorageGetAdaptersRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IStorageBF: Returns a list of all configured storage adapters.
getData(StorageGetDataRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IBasicStorage: Reads the data with the given unique ID from the storage system.
getData(StorageGetDataRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IStorageBF: Reads the data with the given unique ID from the storage system.
getDataWithMetaInfo(String, String, StorageKeyFieldDTO[], Integer) - Method in interface de.aeb.xnsg.storage.bf.IBasicStorage: Reads the data entry, with the given meta-keys/-values.
getDataWithMetaInfo(String, String, String, StorageKeyFieldDTO[], Integer) - Method in interface de.aeb.xnsg.storage.bf.IStorageBF: Reads the data entry, with the given meta-keys/-values.
getDocuments() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
getKey(String) - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: get the key with the name or null if it does not exist
getLanguageISOCodes() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
getObjectDate() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
getObjectIdentifier() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
getObjectType() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
getSearchApplication(StorageGetSearchApplicationRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IBasicStorage: Search for specific data in the storage system - will return an url for the search application
getSearchApplication(StorageGetSearchApplicationRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IStorageBF: Search for specific data in the storage system - will return an URL for the search application
getStorageSystemURL(StorageGetUrlRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IStorageBF: Deprecated.
getStructureMajorVersion() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
getStructureMinorVersion() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
getText() - Method in enum de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA
getTranslatedName(String) - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
getTranslation(String) - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
getTranslationFromParent(String) - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
getURL(StorageGetUrlRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IBasicStorage: Deprecated.
getViewDataApplication(StorageGetViewDataApplicationRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IBasicStorage: Shows the data with the given unique ID from the storage system - will return an URL for the view data application
getViewDataApplication(StorageGetViewDataApplicationRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IStorageBF: Shows the data with the given unique ID from the storage system - will return an URL for the view data application

H

hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.AbstractStorageObjectDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureFieldDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.DescriptionTTDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetAdaptersRequestDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetDataRequestDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetSearchApplicationRequestDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetUrlRequestDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageGetViewDataApplicationRequestDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageAdapterDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetAdaptersResponseDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageGetUrlResponseDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.StorageKeyFieldDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO
hashCode() - Method in class de.aeb.xnsg.storage.bf.dto.StorageRevisionInfoDTO
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 (Casabac-) web side to display the application facade,

I

IBasicStorage - Interface in de.aeb.xnsg.storage.bf: The interface for basic storage functionality.
identCode - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageAdapterDTO: The identifier of this storage adapter.
IFoundationAF - Interface in de.aeb.xnsg.foundation.af: Application facade for the XNSGFoundation
isACEmbedded - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO: true to display header and statusbar, false if ac should be embedded in another
isAdditionalToParent - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO: set if this is an record containing additional fields for the parent
isRevision - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO: Indicates of the result of this response is a revision.
IStorageBF - Interface in de.aeb.xnsg.storage.bf: This is the storage interface for all business applications, either NSG or XNSG applications.
IStorageBF.BUSINESS_AREA - Enum in de.aeb.xnsg.storage.bf
isVersioned - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO: Since FP 02/2022:
Only filled (i.e.

K

KEY_PROPERTY_DATAOBJECT_ARCHIVEDAT - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_BUSINESSAREA - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_COMPANYNAME - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_FULLTEXT - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_OBJECT_DESCRIPTION - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_OBJECT_TITLE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_OBJECTDATE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_OBJECTIDENTIFIER - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_OBJECTTYPE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_RETENTIONTIMESTAMP - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_REVISIONNOTE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_STORAGEID - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_STRUCTURE_MAJOR_VERSION - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_STRUCTURE_MINOR_VERSION - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_SYSTEMID - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_SYSTEMVERSION - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DATAOBJECT_TRANSACTIONID - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_DATE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_ENCODING - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_FULLINDEX - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_MIMETYPE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_NAME - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_SEQUENCE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_SIZE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_DOCUMENT_SUBTYPE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_REQUEST_BUSINESSCLIENTIDENTCODE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
KEY_PROPERTY_REQUEST_CLIENTIDENTCODE - Static variable in interface de.aeb.xnsg.storage.bf.IStorageBF
keys - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetSearchApplicationRequestDTO: A list of StorageKeyFieldDTO which are defined/set by the business application to specify the search.
keys - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: A list of StorageKeyFieldDTO which are defined/set by the business application.

L

language - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO: The two letter ISO code of the language of the new session.
languageISOCode - Variable in class de.aeb.xnsg.storage.bf.dto.DescriptionTTDTO: The language of this translation
latestRevision - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetDataRequestDTO: If set to true, the latest revision is returned from the history, to which the given storageId belongs.
latestRevision - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetViewDataApplicationRequestDTO: If set to true, the latest revision is returned from the history, to which the given storageId belongs.

M

majorVersion - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO: The major version of the structure
maxRevisionLimit - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
mimeType - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The standard MIME type of the data.
minorVersion - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO: The major version of the structure

N

name - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO: The name of the structure
name - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureFieldDTO: The name of the record
name - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO: The name of the record
name - Variable in class de.aeb.xnsg.storage.bf.dto.DescriptionTTDTO: The description for the object
name - Variable in class de.aeb.xnsg.storage.bf.dto.StorageKeyFieldDTO: The name of the key field.

O

objectDate - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: The timestamp if this object.
objectIdentifier - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: The identifier of this storage object.
objectType - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: The object type describes the storage object from the business application point of view (eg.
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

P

parameters - Variable in class de.aeb.xnsg.foundation.af.AFExecuteProcessParmsDTO: parameters to the executable.
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.
productname - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO: Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAIN_CASA_* -
productShortName - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO: Optional field, which may be set if productShortName differs from standard product name
provideResult() - Method in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO

R

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.
removeKey(String) - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: removes the key with the name
RESULT_OK - Static variable in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO
RESULT_STRUCTURE_UNKNOWN - Static variable in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO
resultCode - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO: the result code for the request: RESULT_OK - everything is fine RESULT_STRUCTURE_UNKNOWN - the structure with name & version could not be found
retentionTimestamp - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: The concrete timestamp to which this document must be at least stored in the storage system.
revisionInfo - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: The id of the former StorageObject, if this should be a new revision.
revisionNote - Variable in class de.aeb.xnsg.storage.bf.dto.StorageRevisionInfoDTO: A note for further describing the new revision (eg.

S

searchApplication - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetSearchApplicationRequestDTO: The search application which should be used.
This is either an identifier of the datatype (as registered with ContentStorageACExtensionPoints.getInstance().registerDataTypeToSearchAcMapping()) or the external name of the search application class.
sequence - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The sequence number of this raw data object.
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.
setDocumentsArray(List<StorageDocumentDTO>) - Method in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: sets the documents to the array like they are sorted in the list
shellExecute - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeDTO: parameters when the application is to be invoked via shellExecute
StorageAdapterDTO - Class in de.aeb.xnsg.storage.bf.dto.response: A storage adapter is a concrete configured connection to a storage system.
StorageAdapterDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageAdapterDTO: Creates a new StorageAdapterDTO.
StorageAdapterDTO(String, String) - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageAdapterDTO
StorageDocumentDTO - Class in de.aeb.xnsg.storage.bf.dto: Represents the concrete data (eg.
StorageDocumentDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: Constructs a new raw data object.
StorageGetAdaptersRequestDTO - Class in de.aeb.xnsg.storage.bf.dto.request: The data transfer object for the IStorageBF.getAdapters(StorageGetAdaptersRequestDTO)
StorageGetAdaptersRequestDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetAdaptersRequestDTO
StorageGetAdaptersRequestDTO(String) - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetAdaptersRequestDTO
StorageGetAdaptersResponseDTO - Class in de.aeb.xnsg.storage.bf.dto.response: The data transfer object which is returned by a call to IStorageBF.getAdapters(de.aeb.xnsg.storage.bf.dto.request.StorageGetAdaptersRequestDTO)
StorageGetAdaptersResponseDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageGetAdaptersResponseDTO
StorageGetAdaptersResponseDTO(StorageAdapterDTO[]) - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageGetAdaptersResponseDTO
StorageGetDataRequestDTO - Class in de.aeb.xnsg.storage.bf.dto.request: The data transfer object for the IStorageBF.getData(StorageGetDataRequestDTO)
StorageGetDataRequestDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetDataRequestDTO
StorageGetDataRequestDTO(String, String, String, String, boolean) - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetDataRequestDTO
StorageGetDataResponseDTO - Class in de.aeb.xnsg.storage.bf.dto.response: The data transfer object which is returned by a call to IStorageBF.getData(de.aeb.xnsg.storage.bf.dto.request.StorageGetDataRequestDTO).
StorageGetDataResponseDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO
StorageGetDataResponseDTO(String, StorageObjectDTO, String, String) - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO
StorageGetSearchApplicationRequestDTO - Class in de.aeb.xnsg.storage.bf.dto.request: The data transfer object for the IStorageBF.getSearchApplication(StorageGetSearchApplicationRequestDTO)
StorageGetSearchApplicationRequestDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetSearchApplicationRequestDTO
StorageGetUrlRequestDTO - Class in de.aeb.xnsg.storage.bf.dto.request: The data transfer object for the IStorageBF.getStorageSystemURL(StorageGetUrlRequestDTO).
StorageGetUrlRequestDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetUrlRequestDTO
StorageGetUrlRequestDTO(String, String, String) - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetUrlRequestDTO
StorageGetUrlResponseDTO - Class in de.aeb.xnsg.storage.bf.dto.response: The data transfer object which is returned by a call to IStorageBF.getStorageSystemURL(de.aeb.xnsg.storage.bf.dto.request.StorageGetUrlRequestDTO)
StorageGetUrlResponseDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageGetUrlResponseDTO
StorageGetUrlResponseDTO(String) - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageGetUrlResponseDTO
StorageGetViewDataApplicationRequestDTO - Class in de.aeb.xnsg.storage.bf.dto.request: The data transfer object for the IStorageBF.getViewDataApplication(StorageGetViewDataApplicationRequestDTO)
StorageGetViewDataApplicationRequestDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageGetViewDataApplicationRequestDTO
storageId - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetDataRequestDTO: The identifier of the storage object, to which the keys should be added.
storageId - Variable in class de.aeb.xnsg.storage.bf.dto.request.StorageGetViewDataApplicationRequestDTO: The identifier of the storage object, to which the keys should be added.
storageId - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageGetDataResponseDTO: The storageId of the returned data object.
storageId - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO: The identifier of the storage object returned from the storage system.
storageId - Variable in class de.aeb.xnsg.storage.bf.dto.StorageRevisionInfoDTO: The id of the actual/last revision of this storage object.
StorageKeyFieldDTO - Class in de.aeb.xnsg.storage.bf.dto: Represents a business product specific key value for the StorageObjectDTO.
StorageKeyFieldDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.StorageKeyFieldDTO: Constructor a new key value for the storage object.
StorageKeyFieldDTO(String, String) - Constructor for class de.aeb.xnsg.storage.bf.dto.StorageKeyFieldDTO: Constructor a new key value for the storage object with the predefined values.
StorageObjectDTO - Class in de.aeb.xnsg.storage.bf.dto: Represents the storage object to/from the storage system with all StorageKeyFieldDTO and one to many StorageDocumentDTO objects.
StorageObjectDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: Constructs a new object for a storage transaction.
StorageRevisionInfoDTO - Class in de.aeb.xnsg.storage.bf.dto: Represents the optional revision information for a StorageObjectDTO.
StorageRevisionInfoDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.StorageRevisionInfoDTO: Constructs a new StorageRevisionInfoDTO.
StorageRevisionInfoDTO(String, String) - Constructor for class de.aeb.xnsg.storage.bf.dto.StorageRevisionInfoDTO: Constructs a new StorageRevisionInfoDTO with the preset storageId and revision note.
StorageStoreDataRequestDTO - Class in de.aeb.xnsg.storage.bf.dto.request: The data transfer object for the IStorageBF.storeData(StorageStoreDataRequestDTO).
StorageStoreDataRequestDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
StorageStoreDataRequestDTO(String, String, String, StorageObjectDTO) - Constructor for class de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO
StorageStoreDataResponseDTO - Class in de.aeb.xnsg.storage.bf.dto.response: The data transfer object which is returned by a call to IStorageBF.storeData(de.aeb.xnsg.storage.bf.dto.request.StorageStoreDataRequestDTO)
StorageStoreDataResponseDTO() - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO
StorageStoreDataResponseDTO(String, String) - Constructor for class de.aeb.xnsg.storage.bf.dto.response.StorageStoreDataResponseDTO
storeData(StorageStoreDataRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IBasicStorage: Writes data to the storage system.
storeData(StorageStoreDataRequestDTO) - Method in interface de.aeb.xnsg.storage.bf.IStorageBF: Writes data to the storage system.
structure - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: the object structure, if a serialized version of the object should be archived (only required, if the structure is unknown -> see StorageStoreDataResponseDTO->RESULT_STRUCTURE_UNKNOWN)
structureMajorVersion - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: the major version of the object structure, if a serialized version of the object should be archived
structureMinorVersion - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: the major version of the object structure, if a serialized version of the object should be archived
stylevariant - Variable in class de.aeb.xnsg.foundation.af.ApplicationFacadeParmsDTO: customized styleVariant (one of DeployXnsgProperties.ProductStyleVariant for application facade
subRecords - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO: The subordinated records
subType - Variable in class de.aeb.xnsg.storage.bf.dto.StorageDocumentDTO: The subtype can describe the type of data from business application view (eg.
systemId - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: The ID of the business application which want to store the data (eg.
systemVersion - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: The version of the business application which want to store the data (eg.

T

topRecord - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureDTO: The top record of the structure
toString() - Method in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO
toString() - Method in class de.aeb.xnsg.storage.bf.dto.StorageKeyFieldDTO
transactionId - Variable in class de.aeb.xnsg.storage.bf.dto.StorageObjectDTO: This id is used for transactional processing of a storage object.
translations - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureFieldDTO: The translations for the description of this field
translations - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO: The translations for the description of this record
translationsFromParent - Variable in class de.aeb.xnsg.storage.bf.dto.DataSetStructureRecordDTO: The translations for this record from its parent like Consignee for an Address from a Transaction

U

url - Variable in class de.aeb.xnsg.storage.bf.dto.response.StorageGetUrlResponseDTO: This is the URL where the storage system can be reached.
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.
userIdentCode - Variable in class de.aeb.xnsg.storage.bf.dto.request.AbstractStorageRequestDTO: The explicit user which initiated the request

V

value - Variable in class de.aeb.xnsg.storage.bf.dto.StorageKeyFieldDTO: The value for this key field.
valueOf(String) - Static method in enum de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA: Returns the enum constant of this type with the specified name.
values() - Static method in enum de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA: Returns an array containing the constants of this enum type, in the order they are declared.
VCP - de.aeb.xnsg.storage.bf.IStorageBF.BUSINESS_AREA

W

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 (Casabac-)workplace.
The difference of this method compared to the the method "IFoundationBF.getWorkplaceURL()" is the fact, that no logon mask will be dipsplayed before entering the workplace
The RFC name of this function is "/AEB/XNSG_IF_WPL"

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