Package dev.getelements.elements.sdk.dao

Interface MetadataSpecDao

All Known Implementing Classes:
MongoMetadataSpecDao
public interface MetadataSpecDao
Created by garrettmcspadden on 11/23/21.

  • Method Details

    • getActiveMetadataSpecs

      Pagination<MetadataSpec> getActiveMetadataSpecs(int offset, int count)
      Lists all MetadataSpec instances, specifying a search query.
      Parameters:
      offset -
      count -
      Returns:
      a Pagination of MetadataSpec instances

    • findActiveMetadataSpec

      Optional<MetadataSpec> findActiveMetadataSpec(String metadataSpecId)
      Finds an active metadata spec by the spec id.
      Parameters:
      metadataSpecId - the metadata spec ID
      Returns:
      an Optional possibly containing the MetadataSpec

    • getActiveMetadataSpec

      default MetadataSpec getActiveMetadataSpec(String metadataSpecId)
      Fetches a specific MetadataSpec instance based on ID. If not found, an exception is raised.
      Parameters:
      metadataSpecId - the template ID
      Returns:
      the MetadataSpec, never null

    • findActiveMetadataSpecByName

      Optional<MetadataSpec> findActiveMetadataSpecByName(String metadataSpecName)
      Finds an active metadata spec by the spec id.
      Parameters:
      metadataSpecName - the metadata spec ID
      Returns:
      an Optional possibly containing the MetadataSpec

    • getActiveMetadataSpecByName

      default MetadataSpec getActiveMetadataSpecByName(String metadataSpecName)
      Fetches a specific MetadataSpec instance based on ID. If not found, an exception is raised.
      Parameters:
      metadataSpecName - the template ID
      Returns:
      the MetadataSpec, never null

    • createMetadataSpec

      MetadataSpec createMetadataSpec(MetadataSpec metadataSpec)
      Creates a new metadata spec.
      Parameters:
      metadataSpec -
      Returns:

    • updateActiveMetadataSpec

      MetadataSpec updateActiveMetadataSpec(MetadataSpec metadataSpec)
      Creates a new metadata spec.
      Parameters:
      metadataSpec -
      Returns:

    • deleteMetadataSpec

      void deleteMetadataSpec(String metadataSpecId)
      Deletes the MetadataSpec with the supplied metadataSpec ID.
      Parameters:
      metadataSpecId - the metadataSpec ID.