Skip to main content
Ctrl+K
LinkAhead Documentation - Home LinkAhead Documentation - Home
  • Tutorials
  • How‑To
  • Explanation
  • Reference
    • About
    • Tags
    • Glossary
  • Tutorials
  • How‑To
  • Explanation
  • Reference
  • About
  • Tags
  • Glossary

Section Navigation

Reference

  • Concepts
    • Data Model Formal Specs
    • The LinkAhead Query Language
  • Deploy
    • Docker Compose
      • Mount Targets
      • Environment Variables
  • Server
    • The Message API
    • Entity Permissions
    • Role Permissions
    • API
      • org.caosdb.datetime
        • Date
        • DateTimeFactory2
        • DateTimeFactoryInterface
        • DateTimeInterface
        • DateTimeStringStrategy
        • FragmentDateTime
        • GregorianCalendarDateTimeStringStrategy
        • Interval
        • LeapSecondDateTimeStringStrategy
        • SemiCompleteDateTime
        • UTCDateTime
        • UTCTimeZoneShift
      • org.caosdb.server
        • CaosAuthenticator
        • CaosAuthorizer
        • CaosDBComponent
        • CaosDBException
        • CaosDBServer
        • CaosDBServerConnectorHelper
        • FileSystem
        • HttpToHttpsRedirector
        • ServerProperties
        • ServerPropertiesSerializer
      • org.caosdb.server.accessControl
        • ACMPermissions
        • ACMPermissions.RolePermission
        • ACMPermissions.UserPermission
        • AnonymousAuthenticationToken
        • AnonymousRealm
        • AuthenticationUtils
        • CaosDBAuthorizingRealm
        • CaosDBDefaultRealm
        • CaosDBRolePermissionResolver
        • Config
        • ConsumedInfoCleanupJob
        • CredentialsValidator
        • HashPasswordValidator
        • InternalUserSource
        • Mode
        • OneTimeAuthenticationToken
        • OneTimeTokenConsumedInfo
        • OneTimeTokenToFile
        • Pam
        • Pam.DefaultPamScriptCaller
        • PamScriptCaller
        • Principal
        • RealmUsernamePasswordToken
        • Role
        • SelfValidatingAuthenticationToken
        • SessionToken
        • SessionTokenRealm
        • SinglePermissionSubject
        • UserSource
        • UserSources
        • UserStatus
      • org.caosdb.server.caching
        • Cache
        • CacheHelper
        • JCSCacheHelper
      • org.caosdb.server.database
        • BackendTransaction
        • CacheableBackendTransaction
        • ChainTransaction
        • Database
        • DatabaseAccessManager
        • ReadAccessSemaphore
        • WriteAccessLock
      • org.caosdb.server.database.access
        • AbstractAccess
        • Access
        • AccessControlAccess
        • InfoAccess
        • InitAccess
        • TransactionAccess
      • org.caosdb.server.database.backend.implementation.MySQL
        • ConnectionException
        • DatabaseConnectionPool
        • DatabaseUtils
        • MySQLDeleteEntityProperties
        • MySQLDeletePassword
        • MySQLDeleteRole
        • MySQLDeleteSparseEntity
        • MySQLDeleteUser
        • MySQLGetAllNames
        • MySQLGetDependentEntities
        • MySQLGetFileRecordByPath
        • MySQLGetIDByName
        • MySQLGetInfo
        • MySQLGetUpdateableChecksums
        • MySQLHelper
        • MySQLInsertEntityDatatype
        • MySQLInsertEntityProperties
        • MySQLInsertLinCon
        • MySQLInsertParents
        • MySQLInsertRole
        • MySQLInsertSparseEntity
        • MySQLInsertTransactionHistory
        • MySQLIsSubType
        • MySQLListRoles
        • MySQLListUsers
        • MySQLLogUserVisit
        • MySQLRetrieveAll
        • MySQLRetrieveAllUncheckedFiles
        • MySQLRetrieveCurrentMaxId
        • MySQLRetrieveDatatypes
        • MySQLRetrieveEntityACL
        • MySQLRetrieveParents
        • MySQLRetrievePasswordValidator
        • MySQLRetrievePermissionRules
        • MySQLRetrieveProperties
        • MySQLRetrieveQueryTemplateDefinition
        • MySQLRetrieveRole
        • MySQLRetrieveSparseEntity
        • MySQLRetrieveUser
        • MySQLRetrieveVersionHistory
        • MySQLSetFileCheckedTimestampImpl
        • MySQLSetFileChecksum
        • MySQLSetPassword
        • MySQLSetPermissionRules
        • MySQLSetQueryTemplateDefinition
        • MySQLSyncStats
        • MySQLTransaction
        • MySQLUpdateSparseEntity
        • MySQLUpdateUser
        • MySQLUpdateUserRoles
        • ReplacedProperty
        • ReplacementStatus
      • org.caosdb.server.database.backend.implementation.UnixFileSystem
        • UnixFileSystemCheckHash
        • UnixFileSystemCheckSize
        • UnixFileSystemFileExists
        • UnixFileSystemFileWasModifiedAfter
        • UnixFileSystemGetFileIterator
        • UnixFileSystemGetFileIterator.FileNameIterator
        • UnixFileSystemHelper
        • UnixFileSystemTransaction
      • org.caosdb.server.database.backend.interfaces
        • BackendTransactionImpl
        • DeleteEntityPropertiesImpl
        • DeletePasswordImpl
        • DeleteRoleImpl
        • DeleteSparseEntityImpl
        • DeleteUserImpl
        • FileCheckHash
        • FileCheckSize
        • FileExists
        • FileWasModifiedAfter
        • GetAllNamesImpl
        • GetDependentEntitiesImpl
        • GetFileIteratorImpl
        • GetFileRecordByPathImpl
        • GetIDByNameImpl
        • GetInfoImpl
        • GetUpdateableChecksumsImpl
        • InsertEntityDatatypeImpl
        • InsertEntityPropertiesImpl
        • InsertLinConImpl
        • InsertParentsImpl
        • InsertRoleImpl
        • InsertSparseEntityImpl
        • InsertTransactionHistoryImpl
        • IsSubTypeImpl
        • ListRolesImpl
        • ListUsersImpl
        • LogUserVisitImpl
        • RetrieveAllImpl
        • RetrieveAllUncheckedFilesImpl
        • RetrieveCurrentMaxIdImpl
        • RetrieveDatatypesImpl
        • RetrieveEntityACLImpl
        • RetrieveParentsImpl
        • RetrievePasswordValidatorImpl
        • RetrievePermissionRulesImpl
        • RetrievePropertiesImpl
        • RetrieveQueryTemplateDefinitionImpl
        • RetrieveRoleImpl
        • RetrieveSparseEntityImpl
        • RetrieveUserImpl
        • RetrieveVersionHistoryImpl
        • SetFileCheckedTimestampImpl
        • SetFileChecksumImpl
        • SetPasswordImpl
        • SetPermissionRulesImpl
        • SetQueryTemplateDefinitionImpl
        • SyncStatsImpl
        • UpdateSparseEntityImpl
        • UpdateUserImpl
        • UpdateUserRolesImpl
      • org.caosdb.server.database.backend.transaction
        • DeleteEntityProperties
        • DeleteEntityTransaction
        • DeleteFile
        • DeletePassword
        • DeleteRole
        • DeleteSparseEntity
        • DeleteUser
        • FileConsistencyCheck
        • GetAllNames
        • GetDependentEntities
        • GetFileIterator
        • GetFileRecordByPath
        • GetIDByName
        • GetInfo
        • GetUpdateableChecksums
        • InsertEntityDatatype
        • InsertEntityProperties
        • InsertEntityTransaction
        • InsertFile
        • InsertLinCon
        • InsertParents
        • InsertRole
        • InsertSparseEntity
        • InsertTransactionHistory
        • IsSubType
        • ListRoles
        • ListUsers
        • LogUserVisit
        • RetrieveAll
        • RetrieveAllUncheckedFiles
        • RetrieveCurrentMaxId
        • RetrieveDatatypes
        • RetrieveEntityACLTransaction
        • RetrieveFullEntityTransaction
        • RetrieveParents
        • RetrievePasswordValidator
        • RetrievePermissionRules
        • RetrieveProperties
        • RetrieveQueryTemplateDefinition
        • RetrieveRole
        • RetrieveSparseEntity
        • RetrieveUser
        • RetrieveVersionHistory
        • RetrieveVersionInfo
        • SetFileCheckedTimestamp
        • SetFileChecksum
        • SetPassword
        • SetPermissionRules
        • SetQueryTemplateDefinition
        • SyncStats
        • UpdateEntityTransaction
        • UpdateSparseEntity
        • UpdateUser
        • UpdateUserRoles
        • VersionTransaction
      • org.caosdb.server.database.exceptions
        • EntityDoesNotExistException
        • EntityWasNotUniqueException
        • IntegrityException
        • RolledBackException
        • TransactionException
      • org.caosdb.server.database.misc
        • Counter
        • DBHelper
        • JdomConverter
        • Measurement
        • RollBackHandler
        • RootBenchmark
        • SubBenchmark
        • Timer
        • TransactionBenchmark
      • org.caosdb.server.database.proto
        • FlatProperty
        • LinCon
        • ProtoGroup
        • ProtoInfo
        • ProtoProperty
        • ProtoUser
        • SparseEntity
        • VersionHistoryItem
        • VerySparseEntity
      • org.caosdb.server.datatype
        • AbstractCollectionDatatype
        • AbstractDatatype
        • AbstractDatatype.Table
        • AbstractEnumValue
        • BooleanDatatype
        • BooleanValue
        • CaosEnum
        • CollectionDatatypeFactory
        • CollectionValue
        • DatatypeDefinition
        • DateTimeDatatype
        • DoubleDatatype
        • EnumElement
        • FileDatatype
        • GenericValue
        • IndexedSingleValue
        • IntegerDatatype
        • ListDatatype
        • ListDatatypeFactory
        • ReferenceDatatype
        • ReferenceDatatype2
        • ReferenceValue
        • SingleValue
        • TextDatatype
        • Value
      • org.caosdb.server.entity
        • Affiliation
        • ClientMessage
        • DeleteEntity
        • Entity
        • EntityID
        • EntityIdRegistry
        • EntityIdRegistryStrategy
        • EntityInterface
        • FileProperties
        • InsertEntity
        • LegacyIds
        • MagicTypes
        • Message
        • Message.MessageType
        • NoSuchRoleException
        • RetrieveEntity
        • Role
        • StatementStatus
        • StatementStatusInterface
        • StringIds
        • TransactionEntity
        • UpdateEntity
        • Version
        • WritableEntity
        • WriteEntity
      • org.caosdb.server.entity.container
        • Container
        • EntityByIdContainer
        • ParentContainer
        • PropertyContainer
        • RetrieveContainer
        • TransactionContainer
        • WritableContainer
      • org.caosdb.server.entity.wrapper
        • EntityWrapper
        • Parent
        • Property
      • org.caosdb.server.entity.xml
        • DomainToElementStrategy
        • EntityToElementStrategy
        • FileToElementStrategy
        • IdAndServerMessagesOnlyStrategy
        • ParentToElementStrategy
        • PropertyToElementStrategy
        • SerializeFieldStrategy
        • ToElementStrategy
        • ToElementable
        • VersionXMLSerializer
      • org.caosdb.server.grpc
        • AccessControlManagementServiceImpl
        • AuthInterceptor
        • AuthInterceptor.NoOpListener
        • CallResolver
        • CaosDBToGrpcConverters
        • CookieSetter
        • DownloadBuffer
        • EntityTransactionServiceImpl
        • FileDownload
        • FileDownloadRegistration
        • FileTransmission
        • FileTransmissionServiceImpl
        • FileTransmissionServiceImpl.FileUploadStreamObserver
        • FileUpload
        • FileUploadRegistration
        • GRPCServer
        • GeneralInfoServiceImpl
        • GrpcToCaosDBConverters
        • LoggingInterceptor
        • UploadBuffer
      • org.caosdb.server.jobs
        • ContainerJob
        • EntityJob
        • FilesJob
        • FlagJob
        • Job
        • JobAnnotation
        • JobConfig
        • JobTarget
        • LazyEntityResolver
        • Schedule
        • ScheduledJob
        • TransactionStage
      • org.caosdb.server.jobs.core
        • AccessControl
        • AccessControl.TransactionPermission
        • Atomic
        • CheckDatatypePresent
        • CheckDependenciesBeforeDeletion
        • CheckDescPresent
        • CheckEntityACLRoles
        • CheckFileStorageConsistency
        • CheckFileStorageConsistency.TestCase
        • CheckNamePresent
        • CheckNoAdditionalPropertiesPresent
        • CheckNoOverridesPresent
        • CheckParOblPropPresent
        • CheckParPresent
        • CheckParValid
        • CheckPropPresent
        • CheckPropValid
        • CheckQueryTemplate
        • CheckRefidIsaParRefid
        • CheckRefidPresent
        • CheckRefidValid
        • CheckStateTransition
        • CheckStateTransition.StateModelPermission
        • CheckTargetPathValid
        • CheckUnitPresent
        • CheckValueParsable
        • DebugCalls
        • EntityStateJob
        • EntityStateJob.State
        • EntityStateJob.StateModel
        • EntityStateJob.Transition
        • EntityStateJob.TransitionPermission
        • ExecuteQuery
        • GenerateEntityId
        • History
        • InheritInitialState
        • Inheritance
        • Inheritance.INHERITANCE_MODE
        • InitEntityStateJobs
        • InsertFilesInDir
        • JobFailureSeverity
        • LoadContainerFlagJobs
        • MakeStateMessage
        • MakeStateProperty
        • MatchFileProp
        • NoCache
        • Paging
        • ParseUnit
        • PickUp
        • ProcessNameProperties
        • RemoveDuplicates
        • ResolveNames
        • RetrieveACL
        • RetrieveAllJob
        • RetrieveOwner
        • RetriveAllNames
        • SetImpToFix
        • SetImpToRecByDefault
        • Strict
        • TestMail
        • UniqueName
        • UpdateUnitConverters
      • org.caosdb.server.logging
        • RequestErrorLogMessage
      • org.caosdb.server.logging.log4j
        • CustomConfigurationFactory
      • org.caosdb.server.permissions
        • AbstractEntityACLFactory
        • CaosPermission
        • EntityACI
        • EntityACL
        • EntityACLFactory
        • EntityPermission
        • Permission
        • PermissionRule
        • ResponsibleAgent
        • Role
      • org.caosdb.server.query
        • Backreference
        • CQLParsingErrorListener
        • CQLParsingErrorListener.ParsingError
        • Conjunction
        • Disjunction
        • EntityFilterContainer
        • EntityFilterInterface
        • IDFilter
        • Negation
        • Negation.NegationFactory
        • POV
        • Query
        • Query.IdVersionAclTriplet
        • Query.ParsingException
        • Query.Pattern
        • Query.QueryException
        • Query.Role
        • Query.Selection
        • Query.Type
        • QueryInterface
        • ResultSetIterator
        • RoleFilter
        • StoredAt
        • SubProperty
        • TransactionFilter
        • TransactionFilter.Transactor
        • Utils
        • VersionFilter
      • org.caosdb.server.resource
        • AbstractCaosDBServerResource
        • AbstractCaosDBServerResource.XMLParser
        • AbstractCaosDBServerResource.xmlNotWellFormedException
        • AuthenticationResource
        • DefaultResource
        • EntityOwnerResource
        • EntityPermissionsResource
        • FileSystemResource
        • InfoResource
        • JdomRepresentation
        • LogoutResource
        • PermissionRulesResource
        • ReReadableRepresentation
        • ReReadableRepresentation.ReReadableByteChannel
        • ReReadableRepresentation.ReReadableInputStream
        • ReReadableRepresentation.ReReadableReader
        • RolesResource
        • ScriptingResource
        • ServerPropertiesResource
        • SharedFileResource
        • ThumbnailsResource
        • UserResource
        • UserRolesResource
        • Webinterface
        • WebinterfaceBuildNumber
      • org.caosdb.server.resource.transaction
        • EntityNamesResource
        • EntityResource
        • RetrieveEntityResource
      • org.caosdb.server.scripting
        • CallerSerializer
        • ScriptingPermissions
        • ScriptingUtils
        • ServerSideScriptingCaller
        • TimeoutException
        • TimeoutProcess
      • org.caosdb.server.transaction
        • AccessControlTransaction
        • ChecksumUpdater
        • DeleteRoleTransaction
        • DeleteUserTransaction
        • EntityTransactionInterface
        • FileStorageConsistencyCheck
        • InsertRoleTransaction
        • InsertUserTransaction
        • ListRolesTransaction
        • ListUsersTransaction
        • LogUserVisitTransaction
        • NoOpCache
        • Retrieve
        • Retrieve.Paging
        • RetrieveACL
        • RetrievePasswordValidatorTransaction
        • RetrievePermissionRulesTransaction
        • RetrieveRoleTransaction
        • RetrieveSparseEntityByPath
        • RetrieveUserRolesTransaction
        • RetrieveUserTransaction
        • Transaction
        • TransactionInterface
        • UpdateACL
        • UpdatePermissionRulesTransaction
        • UpdateRoleTransaction
        • UpdateUserRolesTransaction
        • UpdateUserTransaction
        • WriteTransaction
        • WriteTransactionInterface
      • org.caosdb.server.utils
        • AbstractObservable
        • ConfigurationException
        • CronJob
        • EntityStatus
        • FileUtils
        • FlagInfo
        • HashAlgorithm
        • HashException
        • HashNotReadyException
        • HashTimeoutException
        • Hasher
        • Info
        • Initialization
        • NullPrintStream
        • Observable
        • Observer
        • Releasable
        • SHA512
        • Serializer
        • ServerMessages
        • ServerStat
        • TransactionLogMessage
        • UncloseableOutputStream
        • UndoHandler
        • Undoable
        • UseCacheResource
        • UseCacheResourceDelegate
        • Utils
        • WebinterfaceUtils
      • org.caosdb.server.utils.mail
        • Mail
        • MailFormatter
        • MailHandler
        • Mailable
        • SendMailHandler
        • SimpleMailFormatter
        • ToFileHandler
      • org.caosdb.unit
        • CaosDBSystemOfUnits
        • Converter
        • LinearConverter
        • Unit
        • UnknownUnit
        • WrappedConverter
        • WrappedLinearConverter
        • WrappedUnit
  • Backend
    • API
  • WebUI
    • API
      • Module: ext_bookmarks
      • Module: ext_bottom_line
      • Module: ext_editmode_wysiwyg_text
      • Module: ext_export_to_xlsx
      • Module: ext_file_download
      • Module: ext_import_from_xlsx
      • Module: ext_jupyterdrag
      • Module: reference_list_summary
        • Module: resolve_references
      • Module: ext_sss_markdown
      • Module: ext_table_preview
      • Module: ext_trigger_crawler_form
      • Module: version_history
      • Module: caosdb_table_export
      • Module: form_elements
      • Module: caosdb_default_person_reference
      • Module: webcaosdb
      • Module: navbar
      • Module: caosdb_utils
      • Module: connection
      • Module: transformation
      • Module: transaction
      • Module: paging
      • Module: hintMessages
        • Class: _CaosDBModules
        • Class: _CaosDBModules
        • Class: _CaosDBModules
  • Python Client
    • Configuration
    • API
      • linkahead.common package
        • linkahead.common.administration module
        • linkahead.common.datatype module
        • linkahead.common.models module
        • linkahead.common.state module
        • linkahead.common.timezone module
        • linkahead.common.utils module
        • linkahead.common.versioning module
      • linkahead.connection package
        • linkahead.connection.authentication package
        • linkahead.connection.connection module
        • linkahead.connection.encode module
        • linkahead.connection.interface module
        • linkahead.connection.mockup module
        • linkahead.connection.utils module
      • linkahead.utils package
        • linkahead.utils.caosdb_admin module
        • linkahead.utils.checkFileSystemConsistency module
        • linkahead.utils.create_revision module
        • linkahead.utils.email module
        • linkahead.utils.escape module
        • linkahead.utils.get_entity module
        • linkahead.utils.git_utils module
        • linkahead.utils.linkahead_admin module
        • linkahead.utils.plantuml module
        • linkahead.utils.register_tests module
        • linkahead.utils.reset_override module
        • linkahead.utils.server_side_scripting module
      • linkahead.apiutils module
      • linkahead.cached module
      • linkahead.configuration module
      • linkahead.exceptions module
      • linkahead.high_level_api module
      • linkahead.queries module
      • linkahead.version module
      • linkahead.yamlapi module
    • Python Advanced Tools
      • API
        • caosadvancedtools.cfoods package
        • caosadvancedtools.models package
        • caosadvancedtools.scifolder package
        • caosadvancedtools.serverside package
        • caosadvancedtools.table_json_conversion package
        • caosadvancedtools.tools package
        • caosadvancedtools.cache module
        • caosadvancedtools.cfood module
        • caosadvancedtools.collect_datamodel module
        • caosadvancedtools.crawler module
        • caosadvancedtools.datainconsistency module
        • caosadvancedtools.datamodel_problems module
        • caosadvancedtools.example_cfood module
        • caosadvancedtools.export_related module
        • caosadvancedtools.guard module
        • caosadvancedtools.import_from_xml module
        • caosadvancedtools.json_schema_exporter module
        • caosadvancedtools.loadFiles module
        • caosadvancedtools.pandoc_header_tools module
        • caosadvancedtools.read_md_header module
        • caosadvancedtools.structure_mapping module
        • caosadvancedtools.suppressKnown module
        • caosadvancedtools.table_converter module
        • caosadvancedtools.table_export module
        • caosadvancedtools.table_importer module
        • caosadvancedtools.utils module
        • caosadvancedtools.version module
        • caosadvancedtools.webui_formatter module
  • Crawler
    • CFood Specification
    • API
      • caoscrawler.converters package
        • caoscrawler.converters.converters module
        • caoscrawler.converters.hdf5_converter module
        • caoscrawler.converters.rocrate module
        • caoscrawler.converters.spss module
        • caoscrawler.converters.transformer_converters module
        • caoscrawler.converters.xml_converter module
        • caoscrawler.converters.zipfile_converter module
      • caoscrawler.macros package
        • caoscrawler.macros.macro_yaml_object module
      • caoscrawler.scripts package
        • caoscrawler.scripts.generators module
      • caoscrawler.structure_elements package
        • caoscrawler.structure_elements.rocrate_structure_elements module
        • caoscrawler.structure_elements.structure_elements module
      • caoscrawler.transformers package
        • caoscrawler.transformers.cast_and_parse_transformers module
        • caoscrawler.transformers.string_transformers module
        • caoscrawler.transformers.substitution_transformers module
      • caoscrawler.authorize module
      • caoscrawler.config module
      • caoscrawler.crawl module
      • caoscrawler.debug_tree module
      • caoscrawler.exceptions module
      • caoscrawler.identifiable module
      • caoscrawler.identifiable_adapters module
      • caoscrawler.logging module
      • caoscrawler.scanner module
      • caoscrawler.stores module
      • caoscrawler.sync_graph module
      • caoscrawler.sync_node module
      • caoscrawler.transformer_functions module
      • caoscrawler.utils module
      • caoscrawler.validator module
      • caoscrawler.version module
  • Proto
    • Scalar Value Types
  • Reference
  • LinkAhead Server
  • CaosDB Server
  • org.caosdb.server.database.backend.interfaces
  • RetrieveSparseEntityImpl

RetrieveSparseEntityImpl#

public interface RetrieveSparseEntityImpl extends BackendTransactionImpl#

Methods#

execute#

public SparseEntity execute(EntityID id, String version)#

previous

RetrieveRoleImpl

next

RetrieveUserImpl
On this page
  • Methods
    • execute
Show Source

© Copyright 2021-2026, IndiScale GmbH.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.18.0.