Package de.xima.fc.prompt.mgmt.service

Interface Summary

Interface	Description
IExecutePromptQueryParams	Describes the parameters needed to execute a prompt query, see IPromptTypeService.executeQuery(IPromptServiceType, IExecutePromptQueryParams, Object, Object). .
IExecutePromptQueryRetVal	Describes the return value of a prompt query execution, see executeQuery
IPromptConnectionExportAnalysisResult	Result of analyzing a prompt connection export.
IPromptConnectionExportAnalysisSpec	Specification for analyzing a prompt connection export file.
IPromptConnectionExportInfo	Model representing metadata about an exported prompt connection.
IPromptConnectionExportSpec	Specification for exporting a prompt connection, including the prompt connection identifier and an optional password for encryption.
IPromptExportDataAnalysisResult	Result of analyzing a prompt export file.
IPromptExportMetadataInfo	Model representing metadata of a prompt export.
IPromptLock
IPromptManagementService	Service with various operations for managing prompt connections and queries, mainly CRUD operations.
IPromptQueryExportAnalysisResult	Result of analyzing a prompt query export.
IPromptQueryExportAnalysisSpec	Specification for analyzing a prompt query export file.
IPromptQueryExportInfo	Model representing metadata about an exported prompt query.
IPromptQueryExportInfoFile	Represents a file attached to a prompt query.
IPromptQueryExportSpec	Specification for exporting a prompt query, including the prompt query identifier and an optional password for encryption.
IPromptQueryImportResult	Result of importing a prompt query.
IPromptQueryImportSpec	Specification for importing a prompt query.
IPromptReference	A reference to a prompt object, such as a prompt connection or prompt query.
IPromptReferenceLocator	Service interface for finding references to prompt objects, such as connections and queries.
IPromptServiceHandlerEntry<ConnectionConfig,QueryConfig>
IPromptServiceHandlerRegistry	Low-level registry for prompt service handlers.
IPromptServicePluginId	The ID of a plugin that provides a prompt service, used by IPromptServiceHandlerRegistry.
IPromptServiceType<ConnectionConfig,QueryConfig>	A reference to a specific type of prompt service.
IPromptServiceTypeInfo
IPromptTypeService	Service with various operations on a given type of of prompt services.
ITestPromptConnectionParams	Describes the parameters for a test connection call to a prompt query, see IPromptTypeService.testConnection(IPromptServiceType, ITestPromptConnectionParams, Object)
ITestPromptConnectionRetVal	Describes the return value of a test connection call to a prompt query, see IPromptTypeService.testConnection(IPromptServiceType, ITestPromptConnectionParams, Object).

Class Summary

Class	Description
Locked<Lock,Item>	Represents an item that is locked by a specific lock.
PromptConnectionData	Represents a prompt connection, i.e. the configuration needed to establish a connection to a prompt service.
PromptConnectionData.Builder	Builder for prompt connection data instances.
PromptObjectIdentifier	The identifier of a prompt object, i.e. a prompt connection or a prompt query.
PromptQueryData
PromptQueryData.Builder
PromptScope	The scope to which a prompt object can be assigned, consisting of the kind of scope and its ID within that kind.

Enum Summary

Enum	Description
PromptExportType	The types of prompt export files.
PromptScopeKind	Enumeration with the possible scoped a prompt object can be assigned to.
PromptScopeResolutionMode	Defines how to resolve prompt scopes.

Exception Summary

Exception	Description
FcPromptAuthorizationException	A special type of FcPromptException that is thrown by services when the user lacks permission to perform a certain action.
FcPromptException	Base exception for all exception raised by the prompt API.
FcPromptManagementException	A special type of FcPromptException that is thrown by the IPromptManagementService when creating, updating, or deleting prompt objects fails.
FcPromptTypeException	A special type of FcPromptException that is thrown by the IPromptTypeService when it encounters an error.
FcPromptTypeExecutionException	A special type of FcPromptTypeException that is thrown by the IPromptTypeService upon execution of a prompt query.