Package dev.getelements.elements.sdk.service.metadata

Interface MetadataService

All Known Implementing Classes:
AnonMetadataService, SuperUserMetadataService, UserMetadataService
public interface MetadataService

  • Method Details

    • getMetadataObject

      Metadata getMetadataObject(String metadataId)
      Gets a metadata with unique metadata id.
      Parameters:
      metadataId - the Metadata id
      Returns:
      the metadata id

    • getMetadataObjects

      Pagination<Metadata> getMetadataObjects(int offset, int count)
      Gets a list of metadata objects.
      Parameters:
      offset - the offset
      count - the count
      Returns:
      the PaginatedEntry of metadata objects

    • getMetadataObjects

      Pagination<Metadata> getMetadataObjects(int offset, int count, String search)
      Gets a list of metadata objects.
      Parameters:
      offset - the offset
      count - the count
      search - the search query
      Returns:
      the PaginatedEntry of metadata objects

    • createMetadata

      Metadata createMetadata(CreateMetadataRequest createMetadataRequest)
      Creates a new metadata. The service may override or reject the request based on the current metadata access level.
      Parameters:
      createMetadataRequest - the metadata to create
      Returns:
      the Metadata, as it was created by the database

    • updateMetadata

      Metadata updateMetadata(String metadataId, UpdateMetadataRequest updateMetadataRequest)
      Updates a metadata, preserving the metadata's password.
      Parameters:
      metadataId - the metadata ID to update
      updateMetadataRequest - the metadata to update
      Returns:
      the Metadata, as it was updated

    • softDeleteMetadata

      void softDeleteMetadata(String metadataId)
      Soft deletes a metadata from the system by wiping its fields clean but retaining the db id to prevent broken refs.
      Parameters:
      metadataId - the metadataId