Package com.aquima.interactions.communication

Interface ISchemaDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
SchemaDefinition
public interface ISchemaDefinition 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 schema.
      Returns:
      The name of the schema, may not be null.

    • getTargetNamespace

      String getTargetNamespace()
      This method returns the namespace of the schema.
      Returns:
      The namespace of the schema, or null.

    • getElementFormDefault

      SchemaFormType getElementFormDefault()
      This method returns the elementformdefault of the schema.
      Returns:
      The elementFormDefault, may not be null.

    • getAttributeFormDefault

      SchemaFormType getAttributeFormDefault()
      This method returns the attributeformdefault of the shema.
      Returns:
      The attributeFormDefault, may not be null.

    • containsElement

      boolean containsElement(String name)
      This method indicates whether an element is defined in this schema.
      Parameters:
      name - The name of the element, may not be null.
      Returns:
      Indicator if present or not.

    • getElement

      IElementMappingDefinition getElement(String name)
      This method returns the definition of an element.
      Parameters:
      name - The name of the element, may not be null.
      Returns:
      The definition of the element.
      Throws:
      UnknownElementMappingException - when the element does not have a element mapping

    • getElements

      IElementMappingDefinition[] getElements()
      This method returns all defined elements of this schema.
      Returns:
      All defined elements, never null.

    • containsTypeMapping

      boolean containsTypeMapping(String name)
      This method indicates whether a type is defined in this schema.
      Parameters:
      name - The name of the type, may not be null.
      Returns:
      Indicator if present or not.

    • getType

      ITypeMappingDefinition getType(String name)
      This method returns the definition of a type.
      Parameters:
      name - The name of the type, may not be null.
      Returns:
      The definition of the type.
      Throws:
      UnknownTypeMappingException - when the type type mapping does not exist

    • getTypes

      ITypeMappingDefinition[] getTypes()
      This method returns all defined types of this schema.
      Returns:
      All defined types, never null.