Package com.day.cq.mcm.emailprovider.types

Interface BaseType

All Known Subinterfaces:
Account, ConnectionParams, Email, NamedType, SendClassification, Subscriber, SubscriptionList
public interface BaseType
This is the base type for all entities defined for email provider interface. It has setter and getter methods for an identifier (id) to identify the entities.

  • Method Details

    • getId

      String getId()
      Get the id of the entity.
      Returns:
      The identifier of the entity

    • setId

      void setId(String id)
      Set the id of the entity
      Parameters:
      id - Entity identifier.

    • getParams

      Map<String,Object> getParams()
      Get entity config parameters (if any). These have been added to take care of any email provder specific paramaters.
      Returns:
      a map containing custom properties.

    • setParams

      void setParams(Map<String,Object> params)
      Set entity config parameters (if any). These have been added to take care of any email provder specific paramaters.
      Parameters:
      params - A map containing custom parameters.

    • addParam

      void addParam(String paramName, Object paramValue)
      Add a custom parameter to the entity.
      Parameters:
      paramName - The parameter name
      paramValue - The parameter value

    • getParam

      Object getParam(String paramName)
      Get a custom param value
      Parameters:
      paramName - name of parameter
      Returns:
      value of parameter