Package dev.getelements.elements.sdk.service.schema

Interface MetadataSpecService

All Known Implementing Classes:
SuperUserMetadataSpecService
public interface MetadataSpecService
Manages instances of MetadataSpec. Created by keithhudnall on 9/22/21.

  • Method Details

    • getMetadataSpecs

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

    • getMetadataSpec

      MetadataSpec getMetadataSpec(String metadataSpecIdOrName)
      Fetches a specific MetadataSpec instance based on ID or name. If not found, an exception is raised.
      Parameters:
      metadataSpecIdOrName - the profile ID
      Returns:
      the MetadataSpec, never null

    • updateMetadataSpec

      MetadataSpec updateMetadataSpec(String metadataSpecId, UpdateMetadataSpecRequest metadataSpecRequest)
      Updates the supplied MetadataSpec.
      Parameters:
      metadataSpecId - the id of the metadata spec to update
      metadataSpecRequest - the token information to update
      Returns:
      the MetadataSpec as it was changed by the service.

    • createMetadataSpec

      MetadataSpec createMetadataSpec(CreateMetadataSpecRequest metadataSpecRequest)
      Creates a new token using a pre-created template.
      Parameters:
      metadataSpecRequest - the CreateMetadataSpecRequest with the information to create
      Returns:
      the MetadataSpec as it was created by the service.

    • deleteMetadataSpec

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

    • getJsonSchema

      JsonSchema getJsonSchema(String metadataSpecName)
      Gets the JSON Schema for the metadata spec name.
      Parameters:
      metadataSpecName - the name of the metadata spec
      Returns:
      the metadata spec schema

    • getEditorSchema

      EditorSchema getEditorSchema(String metadataSpecName)