com.secutix.plugin.v1_0

Interface ContactService

All Known Implementing Classes:

ContactServiceMockImpl

public interface ContactService

Method Summary

Modifier and Type	Method and Description
CulturalContactCreationResult	createCulturalContact(List<CulturalContactData> contactDataList)
ContactDeleteResult	deleteAccount(String contactNumber, boolean deleteStrict)
WebMethodResult2	deleteStructureMember(String contactNumber, String structureContactNumber) This method remove a contact member of a structure.
FastContactSearchResult	fastContactSearch(String contactNumberOrName, ContactRoleEnum contactRole, List<ContactTypeEnum> contactTypeList, Long maxResults)
ContactAddressesResult	formatContactAddresses(String contactNumber, List<ContactAddressData> addresses) Same as save contact address except it does not persist data.
ContactAdvantageResult	getAdvantages(String contactNumber, AdvantageTypeEnum advantageType)
AvailableAdministrativeNumbersResult	getAvailableAdministrativeNumbers() This method return all known administrative numbers.
AvailableAuthorizationsResult	getAvailableAuthorizations() This method returns the list of all available authorizations.
ExternalContactCriterionResult	getAvailableContactCriteria() This method returns the list of available contact criteria.
AvailableContactIndicatorResult	getAvailableContactIndicators() This method return all known administrative numbers.
ContactDataResult	getContactData(String contactNumber, List<ContactDetailsEnum> details)
ContactsDataResult	getContactsData(List<String> contactNumber, List<ContactDetailsEnum> details) This method returns the data entered at the creation or modification of a contact, except for the password.
StructureAdministrativeNumbersResult	getStructureAdministrativeNumbers(String structureContactNumber, List<String> adminNumIdCodes)
StructureTypesResult	getStructureTypes()
StructureMemberContactListResult	listStructureMembersByCriteria(String structureContactNumber, String memberContactNumber, List<ContactRoleEnum> roles, String login, String state, String firstname, String lastname, Long startPosition, Long maxResults) This method lists all the contact matching the give search criterion
ContactDataResult	saveIndividualContactData(String contactNumber, IndividualContactData individualContactData, List<ContactAddressData> addresses, boolean fullAddresses, List<AuthorizationData> authorizations, Boolean fullAuthorizations, List<ExternalContactCriterionData> externalContactCriterionData, boolean fullContactCriteria, List<ContactConnection> contactConnections, boolean fullContactConnections, String campaignTrackerId, IndividualPhotoData individualPhotoData, String contactOrigin) This method allows to create or update a contact of type individual.
StructureAdministrativeNumbersResult	saveStructureAdministrativeNumbers(String contactNumber, List<ExternalAdministrativeNumberData> administrativeNumbers) This method saves the list of administrative numbers for the given structure.
ContactDataResult	saveStructureContactData(String contactNumber, StructureContactData structureContactData, List<ContactAddressData> addresses, boolean fullAddresses, List<AuthorizationData> authorizations, Boolean fullAuthorizations, List<ExternalContactCriterionData> externalContactCriterionData, boolean fullContactCriteria, List<ExternalAdministrativeNumberData> administrativeNumbers) This method allows to modify or create a contact of the type structure.
StructureMemberContactResult	saveStructureMember(StructureMemberContactData structureMemberContactData, Long pointOfSalesId, String campaignTracker) This method allows to modify or create a contact member of a structure.
ContactSearchResult	searchContactByCriteria(String contactReference, List<ContactRoleEnum> contactRoles, List<ContactConnection> contactConnections, List<ContactDetailsEnum> contactDetails, String phone, String structureContactNumber, ContactTextSearch contactTextSearch, ContactTypeEnum contactType, boolean includeWithoutConnection, Long startPosition, Long maxResults) Allow to search for contacts passing a choice of filters : contact reference, roles, connections, email, phone, etc.
ContactAuthorizationResult	unsubscribeContact(String hashIdentifier)

Method Detail

getContactData

ContactDataResult getContactData(String contactNumber,
                                 List<ContactDetailsEnum> details)

getStructureAdministrativeNumbers

StructureAdministrativeNumbersResult getStructureAdministrativeNumbers(String structureContactNumber,
                                                                       List<String> adminNumIdCodes)

getStructureTypes

StructureTypesResult getStructureTypes()

getAvailableContactCriteria

ExternalContactCriterionResult getAvailableContactCriteria()

This method returns the list of available contact criteria. This list depends on the organization and changes infrequently, so it is requested that the result of this method should be cached in the caller side for at least 30 minutes.

Returns:

DTO contains a list of contact criteria that belongs to the given organization.

getContactsData

ContactsDataResult getContactsData(List<String> contactNumber,
                                   List<ContactDetailsEnum> details)

This method returns the data entered at the creation or modification of a contact, except for the password. The data also includes a particular nickname for the given list of contact.

Parameters:

contactNumber - Mandatory, the number used to identify the contact

Returns:

DTO contains information about the contact.

The following error codes can be returned:

• error.contact.wrongContactNumber: the given contact does not exist;

saveIndividualContactData

ContactDataResult saveIndividualContactData(String contactNumber,
                                            IndividualContactData individualContactData,
                                            List<ContactAddressData> addresses,
                                            boolean fullAddresses,
                                            List<AuthorizationData> authorizations,
                                            Boolean fullAuthorizations,
                                            List<ExternalContactCriterionData> externalContactCriterionData,
                                            boolean fullContactCriteria,
                                            List<ContactConnection> contactConnections,
                                            boolean fullContactConnections,
                                            String campaignTrackerId,
                                            IndividualPhotoData individualPhotoData,
                                            String contactOrigin)

This method allows to create or update a contact of type individual.

To create a "standard" individual, pass role=PUBLIC.

To update only specific information, pass the contact number and the list of informations to be udated (addresses, criteria...)

Updating a list of addresses (resp. criteria, authorizations, contact connections)

if fullAddresses = true, the list of provided addresses will replace the current list of addresses of the contact.

if fullAddresses = false, any address with an existing addressId will be updated, any address without an id will be added

Ids of the added items can be retrieved in the return values of the function.

Same behavior to update criteria, authorizations, connections.

Concerning postal normalization, see general documentation of the service.

When creating an account, an email is sent to the contact to confirm inscription.

About postal normalization

If no postal normalization is activated, any new address will be saved with normalizationRating=UNKNOWN, and normalizationState=TO_BE_NORMALIZED and nothing else will occurr.

Else, many cases may happen.

• Address is saved (contactAddressId != null) and normalizationState=NORMALIZED. That means the normalization service has been called, did recognise the address and did save it, fixing only minor typos if needed.
• Address has normalizationState=NOT_NORMALIZED : the system did not recognise it and the front-end must ask the client to fix it. After that, the subsequent save can be done with state=TO_BE_NORMALIZED or state NOT_TO_BE_NORMALIZED if we want to force the save.
• Address returns with state NOT_TO_BE_NORMALIZED. Nothing more can be done.

In any case, if the address persisted is different from the address entered, the entered address is returned with contactAddressId==null (this one has not been saved) in order to allow the front-end to display the comparison between both addresses.

Parameters:

contactNumber - Optional : the contact number. If empty, a new contact is created.

individualContactData - DTO contains information about the contact to be saved

addresses -

fullAddresses -

authorizations - Optional, the list of authorizations

fullAuthorizations -

externalContactCriterionData -

fullContactCriteria -

campaignTrackerId - the tracker id of the campaign associated with this account creation (null if none)

contactConnections - connections to add to the created/updated contact

fullContactConnections - if true, the provided contact connections is the entire list of connections for this contact, o.w. they connections will be updated with the provided list

individualPhotoData - contains the photo of the individual. If passed as null, nothing is changed. If individual contains empty filename, photo is removed. Else photo is updated.

contactOrigin - Specify the origin of contact

Returns:

DTO contains information about the contact.

The following error codes can be returned:

• error.contact.wrongContactNumber: the given contact does not exist;
• error.contact.invalidEmail: the given email is not in valid email format;
• error.contact.missingMandatoryLogin: the login is not provided when the institution needs it to be mandatory;
• error.contact.loginAlreadyUsed: the given login is already in use;
• error.contact.wrongAuthorizationId: a given authorization (for modification) does not exist;
• error.contact.wrongCriterionIdCode: a given criterion (for modification) does not exist;
• error.contact.missingCriterionValue: a given criterion value (for modification) does not exist;
• error.contact.wrongContactAddressId: a given address (for modification) does not exist;
• error.contact.onlyOneMainAddressAllowed: more than one address was specified as the main address;
• error.contact.wrongCommunicationMeanId: the given communication mean does not exist;
• error.contact.[TYPE].tooMuchMain: this communication type has more than one communication was specified as the main;
• error.contact.wrongContactAddressId: a given address (for modification) does not exist;
• error.contact.invalidEmail: the email address is invalid;
• error.contact.wrongPhonePrefix: The give international or national prefix is wrongly formatted;
• error.contact.wrongContactAddressOrWrongPhonePrefix: a given address (for modification) does not exist or the international / national prefix is wrongly formatted

getAvailableAuthorizations

AvailableAuthorizationsResult getAvailableAuthorizations()

This method returns the list of all available authorizations.

Returns:

list of DTO which describe the available authorizations.

getAvailableAdministrativeNumbers

AvailableAdministrativeNumbersResult getAvailableAdministrativeNumbers()

This method return all known administrative numbers.

Returns:

DTO contains a list of administrative numbers.

getAvailableContactIndicators

AvailableContactIndicatorResult getAvailableContactIndicators()

This method return all known administrative numbers.

Returns:

DTO contains a list of administrative numbers.

saveStructureContactData

ContactDataResult saveStructureContactData(String contactNumber,
                                           StructureContactData structureContactData,
                                           List<ContactAddressData> addresses,
                                           boolean fullAddresses,
                                           List<AuthorizationData> authorizations,
                                           Boolean fullAuthorizations,
                                           List<ExternalContactCriterionData> externalContactCriterionData,
                                           boolean fullContactCriteria,
                                           List<ExternalAdministrativeNumberData> administrativeNumbers)

This method allows to modify or create a contact of the type structure. Its behavior is similar to the one of saveIndividualContactData.

Parameters:

contactNumber - TODO

structureContactData - DTO contains information about the contact to be saved

Returns:

DTO contains information about the contact.

The following error codes can be returned:

• error.contact.wrongContactNumber: the given contact does not exist;
• error.contact.loginAlreadyUsed: the given login is already in use;

saveStructureAdministrativeNumbers

StructureAdministrativeNumbersResult saveStructureAdministrativeNumbers(String contactNumber,
                                                                        List<ExternalAdministrativeNumberData> administrativeNumbers)

This method saves the list of administrative numbers for the given structure. If the contact already has the administrative numbers, they will be updated if provided in the new list or removed if not included in the new list.

Parameters:

contactNumber - Mandatory, the number to identify the contact

administrativeNumbers - Mandatory, the list of administrative numbers

Returns:

DTO contains a list of administrative numbers for the given contact.

The following error codes can be returned:

• error.contact.wrongContactNumber: the given contact does not exist;
• error.contact.wrongAdminNumIdCode: the given administrative number does not exists;

saveStructureMember

StructureMemberContactResult saveStructureMember(StructureMemberContactData structureMemberContactData,
                                                 Long pointOfSalesId,
                                                 String campaignTracker)

This method allows to modify or create a contact member of a structure. The status of the newly created contact is PENDING ; the account will be validated and activated by a backoffice operator. Its state will change to VALID if accepted and REJECTED otherwise

Parameters:

pointOfSalesId - Optional.

campaignTracker - tracker for tracing the campaign that lead to the contact creation

Returns:

DTO contains information about the contact.

The following error codes can be returned:

• error.contact.wrongContactNumber: the given contact does not exist;
• error.contact.invalidEmail: the email address is invalid;
• error.contact.missingMandatoryLogin: the login is not provided when the institution needs
• error.contact.loginAlreadyUsed: the given login is already in use;

deleteStructureMember

WebMethodResult2 deleteStructureMember(String contactNumber,
                                       String structureContactNumber)

This method remove a contact member of a structure.

Parameters:

contactNumber - Mandatory, the number to identify the contact

structureContactNumber -

listStructureMembersByCriteria

StructureMemberContactListResult listStructureMembersByCriteria(String structureContactNumber,
                                                                String memberContactNumber,
                                                                List<ContactRoleEnum> roles,
                                                                String login,
                                                                String state,
                                                                String firstname,
                                                                String lastname,
                                                                Long startPosition,
                                                                Long maxResults)

This method lists all the contact matching the give search criterion

Parameters:

structureContactNumber - Mandatory, the number to identify the structure contact

structureContactNumber - Optional, the number to identify the member contact

roles - Optional, allows to filter the contacts by the role

login - Optional

state - Optional

firstname - Optional, filter the contact whom first name starts with the give value

lastname - Optional, filter the contact whom last name starts with the give value

startPosition - Mandatory, for pagination purpose, return the contacts from the given index

maxResults - Mandatory, for pagination purpose, return the contacts until the given index

Returns:

DTO contains a list of found contacts.

searchContactByCriteria

ContactSearchResult searchContactByCriteria(String contactReference,
                                            List<ContactRoleEnum> contactRoles,
                                            List<ContactConnection> contactConnections,
                                            List<ContactDetailsEnum> contactDetails,
                                            String phone,
                                            String structureContactNumber,
                                            ContactTextSearch contactTextSearch,
                                            ContactTypeEnum contactType,
                                            boolean includeWithoutConnection,
                                            Long startPosition,
                                            Long maxResults)

Allow to search for contacts passing a choice of filters : contact reference, roles, connections, email, phone, etc.

Parameters:

contactReference -

contactRoles -

contactConnections -

contactDetails -

phone -

structureContactNumber -

contactTextSearch -

contactType -

includeWithoutConnection -

startPosition -

maxResults -

Returns:

fastContactSearch

FastContactSearchResult fastContactSearch(String contactNumberOrName,
                                          ContactRoleEnum contactRole,
                                          List<ContactTypeEnum> contactTypeList,
                                          Long maxResults)

createCulturalContact

CulturalContactCreationResult createCulturalContact(List<CulturalContactData> contactDataList)

deleteAccount

ContactDeleteResult deleteAccount(String contactNumber,
                                  boolean deleteStrict)

unsubscribeContact

ContactAuthorizationResult unsubscribeContact(String hashIdentifier)

formatContactAddresses

ContactAddressesResult formatContactAddresses(String contactNumber,
                                              List<ContactAddressData> addresses)

Same as save contact address except it does not persist data. ContactAddressResult contains passed address augmented with its formatted version

Parameters:

contactNumber -

addresses -

Returns:

getAdvantages

ContactAdvantageResult getAdvantages(String contactNumber,
                                     AdvantageTypeEnum advantageType)