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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addParam(java.lang.String paramName, java.lang.Object paramValue)
Add a custom parameter to the entity.java.lang.String
getId()
Get the id of the entity.java.lang.Object
getParam(java.lang.String paramName)
Get a custom param valuejava.util.Map<java.lang.String,java.lang.Object>
getParams()
Get entity config parameters (if any).void
setId(java.lang.String id)
Set the id of the entityvoid
setParams(java.util.Map<java.lang.String,java.lang.Object> params)
Set entity config parameters (if any).
-
-
-
Method Detail
-
getId
java.lang.String getId()
Get the id of the entity.- Returns:
- The identifier of the entity
-
setId
void setId(java.lang.String id)
Set the id of the entity- Parameters:
id
- Entity identifier.
-
getParams
java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String paramName, java.lang.Object paramValue)
Add a custom parameter to the entity.- Parameters:
paramName
- The parameter nameparamValue
- The parameter value
-
getParam
java.lang.Object getParam(java.lang.String paramName)
Get a custom param value- Parameters:
paramName
- name of parameter- Returns:
- value of parameter
-
-