Package dev.getelements.elements.sdk.dao

Interface MetadataDao

All Known Implementing Classes:
MongoMetadataDao
public interface MetadataDao
This is the MetadataDao which is used to create, update, and retrieve metadata objects in the database.

  • Method Details

    • getAllMetadatasBySpec

      List<Metadata> getAllMetadatasBySpec(String metadataSpecNameOrId)
      Lists all Metadata instances with the specified pagination constraints.
      Parameters:
      metadataSpecNameOrId - the metadata spec name or id
      Returns:
      a Pagination of Metadata instances

    • getMetadatas

      Pagination<Metadata> getMetadatas(int offset, int count, User.Level accessLevel)
      Lists all Metadata instances with the specified pagination constraints.
      Parameters:
      offset -
      count -
      Returns:
      a Pagination of Metadata instances

    • searchMetadatas

      Pagination<Metadata> searchMetadatas(int offset, int count, String search, User.Level accessLevel)
      Lists all Metadata instances, specifying a search query.
      Parameters:
      offset -
      count -
      search -
      Returns:
      a Pagination of Metadata instances

    • findMetadata

      Optional<Metadata> findMetadata(String metadataId, User.Level accessLevel)
      Finds an active metadata object by the object id.
      Parameters:
      metadataId - the metadata object ID
      Returns:
      an Optional possibly containing the Metadata

    • getMetadata

      default Metadata getMetadata(String metadataId, User.Level accessLevel)
      Fetches a specific Metadata instance based on ID. If not found, an exception is raised.
      Parameters:
      metadataId - the template ID
      Returns:
      the Metadata, never null

    • findMetadataByName

      Optional<Metadata> findMetadataByName(String metadataName, User.Level accessLevel)
      Finds an active metadata object by the object id.
      Parameters:
      metadataName - the metadata object ID
      Returns:
      an Optional possibly containing the Metadata

    • getMetadataByName

      default Metadata getMetadataByName(String metadataName, User.Level accessLevel)
      Fetches a specific Metadata instance based on ID. If not found, an exception is raised.
      Parameters:
      metadataName - the template ID
      Returns:
      the Metadata, never null

    • createMetadata

      Metadata createMetadata(Metadata metadata)
      Creates a new metadata object.
      Parameters:
      metadata - the metadata object to create
      Returns:
      the metadata object as it was written to the database

    • updateMetadata

      Metadata updateMetadata(Metadata metadata)
      Creates a new metadata object.
      Parameters:
      metadata - the metadata object to create
      Returns:
      the metadata object as it was written to the database

    • softDeleteMetadata

      void softDeleteMetadata(String metadataId)
      Deletes the Metadata with the supplied metadata ID.
      Parameters:
      metadataId - the metadata ID.