Package com.aquima.interactions.communication

Interface IRestMessageDefinition

All Known Subinterfaces:
IRestRequestMessageDefinition
All Known Implementing Classes:
RestMessageDefinition, RestRequestMessageDefinition
public interface IRestMessageDefinition
This interface defines the rest message.
Since:
9.0
Author:
A.Pragt

  • Method Details

    • getEntityName

      String getEntityName()
      This method returns the entity connecting to the message.
      Returns:
      The entity, may not be null.

    • getHeaders

      IRestHeaderDefinition[] getHeaders()
      This method returns the headers of the message.
      Returns:
      The headers of the message, may not be null.

    • getBodyElement

      IElementReference getBodyElement()
      This method returns reference to the body element. If may return null if the message does not contain a body, or if the service uses domain schemas.
      Returns:
      The full qualifiedname of the element of the body, may be null.

    • getBodySchema

      IDomainSchemaDefinition getBodySchema()
      This method returns the domain schema in case of a domain schema service. If may return null if the message does not contain a body, or if the service does not domain schemas.
      Returns:
      The domain schema in case of a domain schema service, may be null.

    • getBodyAttributeName

      String getBodyAttributeName()
      This method returns the content attribute of the message.
      Returns:
      The body attribute, may be null.

    • getValidations

      IFieldValidationDefinition[] getValidations()
      This method returns the validations of the attribute.
      Returns:
      The validations of the attribute, may not be null.