it.sintraconsulting.custom.scminer.ws
Class SMWebService

java.lang.Object
  extended by it.sintraconsulting.custom.scminer.ws.SMWebService

public class SMWebService
extends java.lang.Object

SendMiner Web Service Interface. Expose all methods necessary to interact with the SendMiner System.


Constructor Summary
SMWebService()
           
 
Method Summary
 boolean ContactDelete(java.lang.String username, java.lang.String password, java.lang.Long groupId, java.lang.Long contactId)
           Delete Contact Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupId : SendMiner Group numeric identificator contactId : SendMiner Contact numeric identificator.
 boolean ContactInsert(java.lang.String username, java.lang.String password, java.lang.Long groupId, Contatto contactObj)
           Insert New Contact Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupId : SendMiner Group numeric identificator contactObj : Contact Data Object to be inserted.
 ContattoDTO[] ContactQueryByGroupId(java.lang.String username, java.lang.String password, java.lang.Long groupId)
           Retrieve Contacts Service; retrieves all contacts joining the specified Group (by Group) Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupId : SendMiner Group numeric identificator contactId : SendMiner Contact numeric identificator.
 boolean ContactUpdate(java.lang.String username, java.lang.String password, java.lang.Long groupId, Contatto contactObj)
           Update Contact Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupId : SendMiner Group numeric identificator contactObj : Contact Data Object to be updated.
 boolean EmailSubscribe(java.lang.String username, java.lang.String password, java.lang.Long groupId, java.lang.String emailAddress)
           Suscribe Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupId : SendMiner Group numeric identificator emailAddress : Email Address to be subscribed.
 boolean EmailUnsubscribe(java.lang.String username, java.lang.String password, java.lang.Long groupId, java.lang.String emailAddress)
           Unsuscribe Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupId : SendMiner Group numeric identificator emailAddress : Email Address to be unsubscribed.
 boolean GroupDelete(java.lang.String username, java.lang.String password, java.lang.Long groupId)
           Delete Group Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupId : SendMiner Group numeric identificator
 boolean GroupInsert(java.lang.String username, java.lang.String password, Gruppo groupObj)
           Insert New Group Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupObj : Group Data Object to be inserted.
 GruppoDTO[] GroupQuery(java.lang.String username, java.lang.String password)
           Retrieve Groups Service; retrieves all groups of the user Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration
 boolean GroupUpdate(java.lang.String username, java.lang.String password, Gruppo groupObj)
           Update Group Service Parameters: username : Username choosen during SendMiner Registration password : Password choosen during SendMiner Registration groupObj : Group Data Object to be updated.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SMWebService

public SMWebService()
Method Detail

EmailSubscribe

public boolean EmailSubscribe(java.lang.String username,
                              java.lang.String password,
                              java.lang.Long groupId,
                              java.lang.String emailAddress)
                       throws javax.xml.ws.WebServiceException
 Suscribe Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupId : SendMiner Group numeric identificator
  • emailAddress : Email Address to be subscribed.

Returns:
true se nuova email, false se email gia esistente.
Throws:
javax.xml.ws.WebServiceException

EmailUnsubscribe

public boolean EmailUnsubscribe(java.lang.String username,
                                java.lang.String password,
                                java.lang.Long groupId,
                                java.lang.String emailAddress)
                         throws javax.xml.ws.WebServiceException
 Unsuscribe Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupId : SendMiner Group numeric identificator
  • emailAddress : Email Address to be unsubscribed.

Returns:
true se email esistente, false se email non esistente.
Throws:
javax.xml.ws.WebServiceException

ContactInsert

public boolean ContactInsert(java.lang.String username,
                             java.lang.String password,
                             java.lang.Long groupId,
                             Contatto contactObj)
 Insert New Contact Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupId : SendMiner Group numeric identificator
  • contactObj : Contact Data Object to be inserted.


ContactUpdate

public boolean ContactUpdate(java.lang.String username,
                             java.lang.String password,
                             java.lang.Long groupId,
                             Contatto contactObj)
 Update Contact Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupId : SendMiner Group numeric identificator
  • contactObj : Contact Data Object to be updated.


ContactDelete

public boolean ContactDelete(java.lang.String username,
                             java.lang.String password,
                             java.lang.Long groupId,
                             java.lang.Long contactId)
 Delete Contact Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupId : SendMiner Group numeric identificator
  • contactId : SendMiner Contact numeric identificator.


ContactQueryByGroupId

public ContattoDTO[] ContactQueryByGroupId(java.lang.String username,
                                           java.lang.String password,
                                           java.lang.Long groupId)
 Retrieve Contacts Service; retrieves all contacts joining the specified Group (by Group)
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupId : SendMiner Group numeric identificator
  • contactId : SendMiner Contact numeric identificator.


GroupInsert

public boolean GroupInsert(java.lang.String username,
                           java.lang.String password,
                           Gruppo groupObj)
 Insert New Group Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupObj : Group Data Object to be inserted.


GroupUpdate

public boolean GroupUpdate(java.lang.String username,
                           java.lang.String password,
                           Gruppo groupObj)
 Update Group Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupObj : Group Data Object to be updated.


GroupDelete

public boolean GroupDelete(java.lang.String username,
                           java.lang.String password,
                           java.lang.Long groupId)
 Delete Group Service
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration
  • groupId : SendMiner Group numeric identificator


GroupQuery

public GruppoDTO[] GroupQuery(java.lang.String username,
                              java.lang.String password)
 Retrieve Groups Service; retrieves all groups of the user
 Parameters:
 
  • username : Username choosen during SendMiner Registration
  • password : Password choosen during SendMiner Registration