com.ecircleag.webservices

Interface EcMSoapBridge

All Superinterfaces:

Remote

All Known Implementing Classes:

EcMApi

public interface EcMSoapBridge
extends Remote

Method Summary

Modifier and Type	Method and Description
void	addSingleRelatedDataRecord(String session, String relatedDatasetId, String key, String[] colNames, String[] colValues)
boolean	addToBlacklist(String session, String groupId, String email)
void	changeGroupSettings(String session, String groupId, String description, String prefix, String textFooter, String textHeader, String htmlFooter, String htmlHeader)
String	cloneGroup(String session, String templateGroupId, String newGroupEmail, String newGroupName, boolean keepOwner)
String	copyAndSendDraftMessage(String session, String groupId, String messageId)
String	createMember(String session, String userId, String groupId, boolean invite, boolean sendMessage)
String	createOrUpdateGroup(String session, String groupXML)
String	createOrUpdateUserByEmail(String session, String userXml, boolean sendMessage)
String	createOrUpdateUserMemberByEmail(String session, String memberXml, String groupId, boolean sendMessage)
String	createUser(String session, String userXmlSpec)
boolean	deleteGroup(String session, String groupId)
boolean	deleteMember(String session, String memberId)
boolean	deleteMessage(String session, String messageId)
int	deleteRelatedDataRecords(String session, String relatedDatasetId, String key, String[] colNames, String[] colValues)
boolean	deleteUser(String session, String userId)
void	deleteUserByEmail(String session, String email)
String[]	findMembershipsByEmail(String session, String email)
String[]	findUserIdsByIdentifier(String session, String identifier)
String	getGroupId(String session, String email)
String	getGroupProperty(String session, String gid, String name)
String	getVersion()
boolean	isEmailBouncedSystemwide(String session, String email)
boolean	isEmailOnSystemBlacklist(String session, String email)
String	logon(String realm, String user, String passwd)
void	logout(String session)
GroupCore[]	lookupGroups(String session, GroupLookupParams lookupParams)
HourlyMessageStats[]	lookupHourlyMessageStats(String session, String messageid, Calendar periodStartDate, Calendar periodEndDate)
String	lookupMemberByEmail_v2_0(String session, String groupId, String email, boolean onlyActive)
String	lookupMemberByEmail(String session, String groupId, String email)
String	lookupMemberById_v2_0(String session, String memberid, boolean onlyActive)
String	lookupMemberById(String session, String memberid)
String	lookupMemberByIdentifier(String session, String groupId, String identifier, boolean onlyActive)
String	lookupMemberByMobileNumber(String session, String groupId, String mobile, boolean onlyActive)
String	lookupMemberByUserId_v2_0(String session, String groupid, String userId, boolean onlyActive)
String	lookupMemberByUserId(String session, String groupid, String userId)
MessageContent	lookupMessageById(String session, String messageId)
MessageInfo[]	lookupMessages(String session, MessageLookupParams lookupParams)
String	lookupUserByEmail(String session, String email)
String	lookupUserByFaxNumber(String session, String fax)
String	lookupUserById(String session, String userId)
String	lookupUserByIdentifier(String session, String identifier)
String	lookupUserByMobileNumber(String session, String mobile)
String	lookupUserIdByEmail(String session, String email)
String	registerUser(String session, String userXmlSpec, boolean sendMessage)
boolean	removeFromBlacklist(String session, String groupId, String email)
void	sendEmailToMe(String session, String subject, String message)
void	sendGroupMessageToUser(String session, String groupid, String messageId, String userId)
void	sendParametrizedSingleMessageToUser(String session, String singleMessageId, String userId, String[] names, String[] values)
void	sendPriorityParametrizedSingleMessageToUser(String session, String singleMessageId, String userId, String[] names, String[] values)
void	sendPrioritySingleMessageToUser(String session, String singleMessageId, String userId)
void	sendSingleMessageToUser(String session, String singleMessageId, String userId)
void	setAsynchronous(String session, boolean asynchronous)
void	setGroupProperty(String session, String gid, String name, String value)
void	setMessageFormat(String session, String groupId, String userId, String messageFormat)
boolean	subscribeMemberByEmail(String session, String email, String groupId, boolean sendMessage)
String	subscribeOrRegisterUserMemberByEmail(String session, String userXmlSpec, String groupId, boolean sendMessage)
boolean	unsubscribeMemberByEmail(String session, String email, String groupId, boolean sendMessage)
boolean	updateMember(String session, String memberXmlSpec)
void	updateRelatedDataRecord(String session, String relatedDatasetId, String key, String[] colNamesId, String[] colValuesId, String[] colNames, String[] colValues)
boolean	updateUser(String session, String userXmlSpec)
boolean	updateUserAttributesByEmail(String session, String email, String[] names, String[] values, boolean createUser)
boolean	updateUserByEmail(String session, String userXmlSpec)

Method Detail

getGroupId

String getGroupId(String session,
                  String email)
           throws RemoteException,
                  EcMException

Throws:

RemoteException

EcMException

logon

String logon(String realm,
             String user,
             String passwd)
      throws RemoteException,
             EcMException

Throws:

RemoteException

EcMException

logout

void logout(String session)
     throws RemoteException

Throws:

RemoteException

setAsynchronous

void setAsynchronous(String session,
                     boolean asynchronous)
              throws RemoteException,
                     EcMException

Throws:

RemoteException

EcMException

createUser

String createUser(String session,
                  String userXmlSpec)
           throws RemoteException,
                  EcMException

Throws:

RemoteException

EcMException

lookupUserByEmail

String lookupUserByEmail(String session,
                         String email)
                  throws RemoteException,
                         EcMException

Throws:

RemoteException

EcMException

lookupUserByMobileNumber

String lookupUserByMobileNumber(String session,
                                String mobile)
                         throws RemoteException,
                                EcMException

Throws:

RemoteException

EcMException

lookupUserByFaxNumber

String lookupUserByFaxNumber(String session,
                             String fax)
                      throws RemoteException,
                             EcMException

Throws:

RemoteException

EcMException

createOrUpdateUserByEmail

String createOrUpdateUserByEmail(String session,
                                 String userXml,
                                 boolean sendMessage)
                          throws RemoteException,
                                 EcMException

Throws:

RemoteException

EcMException

createOrUpdateUserMemberByEmail

String createOrUpdateUserMemberByEmail(String session,
                                       String memberXml,
                                       String groupId,
                                       boolean sendMessage)
                                throws RemoteException,
                                       EcMException

Throws:

RemoteException

EcMException

deleteUserByEmail

void deleteUserByEmail(String session,
                       String email)
                throws RemoteException,
                       EcMException

Throws:

RemoteException

EcMException

deleteUser

boolean deleteUser(String session,
                   String userId)
            throws RemoteException,
                   EcMException

Throws:

RemoteException

EcMException

lookupUserIdByEmail

String lookupUserIdByEmail(String session,
                           String email)
                    throws RemoteException,
                           EcMException

Throws:

RemoteException

EcMException

updateUserAttributesByEmail

boolean updateUserAttributesByEmail(String session,
                                    String email,
                                    String[] names,
                                    String[] values,
                                    boolean createUser)
                             throws RemoteException,
                                    EcMException

Throws:

RemoteException

EcMException

lookupUserByIdentifier

String lookupUserByIdentifier(String session,
                              String identifier)
                       throws RemoteException,
                              EcMException

Throws:

RemoteException

EcMException

lookupMemberByMobileNumber

String lookupMemberByMobileNumber(String session,
                                  String groupId,
                                  String mobile,
                                  boolean onlyActive)
                           throws RemoteException,
                                  EcMException

Throws:

RemoteException

EcMException

lookupMessageById

MessageContent lookupMessageById(String session,
                                 String messageId)
                          throws RemoteException,
                                 EcMException

Throws:

RemoteException

EcMException

lookupMessages

MessageInfo[] lookupMessages(String session,
                             MessageLookupParams lookupParams)
                      throws RemoteException,
                             EcMException

Throws:

RemoteException

EcMException

lookupGroups

GroupCore[] lookupGroups(String session,
                         GroupLookupParams lookupParams)
                  throws RemoteException,
                         EcMException

Throws:

RemoteException

EcMException

createMember

String createMember(String session,
                    String userId,
                    String groupId,
                    boolean invite,
                    boolean sendMessage)
             throws RemoteException,
                    EcMException

Throws:

RemoteException

EcMException

lookupUserById

String lookupUserById(String session,
                      String userId)
               throws RemoteException,
                      EcMException

Throws:

RemoteException

EcMException

lookupMemberByEmail

String lookupMemberByEmail(String session,
                           String groupId,
                           String email)
                    throws RemoteException,
                           EcMException

Throws:

RemoteException

EcMException

lookupMemberByEmail_v2_0

String lookupMemberByEmail_v2_0(String session,
                                String groupId,
                                String email,
                                boolean onlyActive)
                         throws RemoteException,
                                EcMException

Throws:

RemoteException

EcMException

lookupMemberById

String lookupMemberById(String session,
                        String memberid)
                 throws RemoteException,
                        EcMException

Throws:

RemoteException

EcMException

lookupMemberByUserId

String lookupMemberByUserId(String session,
                            String groupid,
                            String userId)
                     throws RemoteException,
                            EcMException

Throws:

RemoteException

EcMException

lookupMemberById_v2_0

String lookupMemberById_v2_0(String session,
                             String memberid,
                             boolean onlyActive)
                      throws RemoteException,
                             EcMException

Throws:

RemoteException

EcMException

lookupMemberByUserId_v2_0

String lookupMemberByUserId_v2_0(String session,
                                 String groupid,
                                 String userId,
                                 boolean onlyActive)
                          throws RemoteException,
                                 EcMException

Throws:

RemoteException

EcMException

lookupMemberByIdentifier

String lookupMemberByIdentifier(String session,
                                String groupId,
                                String identifier,
                                boolean onlyActive)
                         throws RemoteException,
                                EcMException

Throws:

RemoteException

EcMException

findUserIdsByIdentifier

String[] findUserIdsByIdentifier(String session,
                                 String identifier)
                          throws RemoteException,
                                 EcMException

Throws:

RemoteException

EcMException

findMembershipsByEmail

String[] findMembershipsByEmail(String session,
                                String email)
                         throws RemoteException,
                                EcMException

Throws:

RemoteException

EcMException

updateMember

boolean updateMember(String session,
                     String memberXmlSpec)
              throws RemoteException,
                     EcMException

Throws:

RemoteException

EcMException

updateUser

boolean updateUser(String session,
                   String userXmlSpec)
            throws RemoteException,
                   EcMException

Throws:

RemoteException

EcMException

updateUserByEmail

boolean updateUserByEmail(String session,
                          String userXmlSpec)
                   throws RemoteException,
                          EcMException

Throws:

RemoteException

EcMException

deleteMember

boolean deleteMember(String session,
                     String memberId)
              throws RemoteException,
                     EcMException

Throws:

RemoteException

EcMException

subscribeOrRegisterUserMemberByEmail

String subscribeOrRegisterUserMemberByEmail(String session,
                                            String userXmlSpec,
                                            String groupId,
                                            boolean sendMessage)
                                     throws RemoteException,
                                            EcMException

Throws:

RemoteException

EcMException

subscribeMemberByEmail

boolean subscribeMemberByEmail(String session,
                               String email,
                               String groupId,
                               boolean sendMessage)
                        throws RemoteException,
                               EcMException

Throws:

RemoteException

EcMException

registerUser

String registerUser(String session,
                    String userXmlSpec,
                    boolean sendMessage)
             throws RemoteException,
                    EcMException

Throws:

RemoteException

EcMException

unsubscribeMemberByEmail

boolean unsubscribeMemberByEmail(String session,
                                 String email,
                                 String groupId,
                                 boolean sendMessage)
                          throws RemoteException,
                                 EcMException

Throws:

RemoteException

EcMException

deleteMessage

boolean deleteMessage(String session,
                      String messageId)
               throws RemoteException,
                      EcMException

Throws:

RemoteException

EcMException

cloneGroup

String cloneGroup(String session,
                  String templateGroupId,
                  String newGroupEmail,
                  String newGroupName,
                  boolean keepOwner)
           throws RemoteException,
                  EcMException

Throws:

RemoteException

EcMException

changeGroupSettings

void changeGroupSettings(String session,
                         String groupId,
                         String description,
                         String prefix,
                         String textFooter,
                         String textHeader,
                         String htmlFooter,
                         String htmlHeader)
                  throws RemoteException,
                         EcMException

Throws:

RemoteException

EcMException

setGroupProperty

void setGroupProperty(String session,
                      String gid,
                      String name,
                      String value)
               throws RemoteException,
                      EcMException

Throws:

RemoteException

EcMException

getGroupProperty

String getGroupProperty(String session,
                        String gid,
                        String name)
                 throws RemoteException,
                        EcMException

Throws:

RemoteException

EcMException

setMessageFormat

void setMessageFormat(String session,
                      String groupId,
                      String userId,
                      String messageFormat)
               throws RemoteException,
                      EcMException

Throws:

RemoteException

EcMException

copyAndSendDraftMessage

String copyAndSendDraftMessage(String session,
                               String groupId,
                               String messageId)
                        throws RemoteException,
                               EcMException

Throws:

RemoteException

EcMException

sendSingleMessageToUser

void sendSingleMessageToUser(String session,
                             String singleMessageId,
                             String userId)
                      throws RemoteException,
                             EcMException

Throws:

RemoteException

EcMException

sendParametrizedSingleMessageToUser

void sendParametrizedSingleMessageToUser(String session,
                                         String singleMessageId,
                                         String userId,
                                         String[] names,
                                         String[] values)
                                  throws RemoteException,
                                         EcMException

Throws:

RemoteException

EcMException

sendPrioritySingleMessageToUser

void sendPrioritySingleMessageToUser(String session,
                                     String singleMessageId,
                                     String userId)
                              throws RemoteException,
                                     EcMException

Throws:

RemoteException

EcMException

sendPriorityParametrizedSingleMessageToUser

void sendPriorityParametrizedSingleMessageToUser(String session,
                                                 String singleMessageId,
                                                 String userId,
                                                 String[] names,
                                                 String[] values)
                                          throws RemoteException,
                                                 EcMException

Throws:

RemoteException

EcMException

sendGroupMessageToUser

void sendGroupMessageToUser(String session,
                            String groupid,
                            String messageId,
                            String userId)
                     throws RemoteException,
                            EcMException

Throws:

RemoteException

EcMException

deleteGroup

boolean deleteGroup(String session,
                    String groupId)
             throws RemoteException,
                    EcMException

Throws:

RemoteException

EcMException

sendEmailToMe

void sendEmailToMe(String session,
                   String subject,
                   String message)
            throws RemoteException,
                   EcMException

Throws:

RemoteException

EcMException

addToBlacklist

boolean addToBlacklist(String session,
                       String groupId,
                       String email)
                throws RemoteException,
                       EcMException

Throws:

RemoteException

EcMException

isEmailOnSystemBlacklist

boolean isEmailOnSystemBlacklist(String session,
                                 String email)
                          throws RemoteException,
                                 EcMException

Throws:

RemoteException

EcMException

isEmailBouncedSystemwide

boolean isEmailBouncedSystemwide(String session,
                                 String email)
                          throws RemoteException,
                                 EcMException

Throws:

RemoteException

EcMException

removeFromBlacklist

boolean removeFromBlacklist(String session,
                            String groupId,
                            String email)
                     throws RemoteException,
                            EcMException

Throws:

RemoteException

EcMException

createOrUpdateGroup

String createOrUpdateGroup(String session,
                           String groupXML)
                    throws RemoteException,
                           EcMException

Throws:

RemoteException

EcMException

lookupHourlyMessageStats

HourlyMessageStats[] lookupHourlyMessageStats(String session,
                                              String messageid,
                                              Calendar periodStartDate,
                                              Calendar periodEndDate)
                                       throws RemoteException,
                                              EcMException

Throws:

RemoteException

EcMException

addSingleRelatedDataRecord

void addSingleRelatedDataRecord(String session,
                                String relatedDatasetId,
                                String key,
                                String[] colNames,
                                String[] colValues)
                         throws RemoteException,
                                EcMException

Throws:

RemoteException

EcMException

updateRelatedDataRecord

void updateRelatedDataRecord(String session,
                             String relatedDatasetId,
                             String key,
                             String[] colNamesId,
                             String[] colValuesId,
                             String[] colNames,
                             String[] colValues)
                      throws RemoteException,
                             EcMException

Throws:

RemoteException

EcMException

deleteRelatedDataRecords

int deleteRelatedDataRecords(String session,
                             String relatedDatasetId,
                             String key,
                             String[] colNames,
                             String[] colValues)
                      throws RemoteException,
                             EcMException

Throws:

RemoteException

EcMException

getVersion

String getVersion()
           throws RemoteException

Throws:

RemoteException