Package com.aquima.interactions.communication

Interface ISchemaSetDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
SchemaSetDefinition
public interface ISchemaSetDefinition extends Serializable
This interface defines a schema definition.
Since:
9.0
Author:
a.pragt

  • Method Details

    • getName

      String getName()
      This method returns the name of the schemaset.
      Returns:
      The name of the schemaset, may not be null.

    • getSchemas

      String[] getSchemas()
      This method returns the names of the schemas that are available in this schema set.
      Returns:
      The names of the schemas, never null.

    • getSchema

      ISchemaDefinition getSchema(String name)
      This method returns the schema definition.
      Parameters:
      name - The name of the schema.
      Returns:
      The definition of the schema.
      Throws:
      UnknownSchemaException - when there is no schema with the given name

    • getElement

      IElementMappingDefinition getElement(QualifiedName elementName)
      This method returns the element definition of an element in this schemaset.
      Parameters:
      elementName - Full qualified name of the element, may not be null.
      Returns:
      The definition of the element.
      Throws:
      UnknownElementMappingException - when there is no element mapping for the given elementName

    • getType

      ITypeMappingDefinition getType(QualifiedName typeName)
      This method returns the type definition of an type in this schemaset.
      Parameters:
      typeName - Full qualified name of the type, may not be null.
      Returns:
      The definition of the type.
      Throws:
      UnknownTypeMappingException - when there is no type mapping for the given typeName