com.pointloyalty.loyalty.wsmod
Interface WsServiceDao

public interface WsServiceDao

Web services API for the PointLoyalty Manager bonuses calculation system.
For start:

• You should register in the PointLoyalty Manager bonus calculation system. See www.pointloyalty.com.
• You should have loyalty programs created (creating permanent data).
• After that you can add/delete transaction and member data for bonus calculation.

See PointLoyalty Web Services WSDL file.

Method Summary

WsBonusFullData[]	addAction(WsLogin login, java.lang.String userDataId, WsAction action) Sends one user action to PointLoyalty Manager system and calculate bonus points.
WsBonusFullData[]	addActions(WsLogin login, java.lang.String userDataId, WsAction[] actions) Sends a batch of user transactions to PointLoyalty Manager system for bonus calculation.
void	addBonusAdjustment(WsLogin login, java.lang.String userDataId, WsBonusAdjustment adj) Sends bonus adjustment information to PointLoyalty Manager system.
void	addBonusAdjustments(WsLogin login, java.lang.String userDataId, WsBonusAdjustment[] adjs) Sends a batch of bonus adjustments information to PointLoyalty Manager system.
void	addMember(WsLogin login, WsMember member) Creates loyalty program member.
void	addMemberAccount(WsLogin login, WsMemberAccount memberAccount) Creates member account for PointLoyalty Member Console.
void	addMemberAccounts(WsLogin login, WsMemberAccount[] memberAccounts) Creates members' accounts for PointLoyalty Member Console.
void	addMembers(WsLogin login, WsMember[] members) Creates multiple loyalty program members.
void	deleteActions(WsLogin login, java.lang.String userDataId) Deletes member actions registered in the system.
void	deleteAllActions(WsLogin login, java.util.Date from, java.util.Date to) Deletes all actions, registered in the system with all calculated bonuses for these actions.
void	deleteAllBonusAdjustments(WsLogin login, java.util.Date from, java.util.Date to) Deletes all bonus adjustments, registered in the system.
void	deleteAllBonuses(WsLogin login, java.util.Date actionDateFrom, java.util.Date actionDateTo) Deletes all bonuses, calculated in the system.
void	deleteAllMemberAccounts(WsLogin login) Deletes all members accounts, registered in the system.
void	deleteAllMembers(WsLogin login) Deletes all members, registered in the system.
void	deleteBonus(WsLogin login, java.lang.String bonusInternalId) Deletes bonus calculated in the system.
void	deleteBonusAdjustments(WsLogin login, java.lang.String userDataId) Deletes bonuses adjustments registered in the system.
void	deleteBonuses(WsLogin login, java.lang.String[] bonusInternalIds) Deletes bonuses calculated in the system.
void	deleteMember(WsLogin login, java.lang.String memberId) Deletes loyalty program member registered in the system.
void	deleteMemberAccount(WsLogin login, java.lang.String personalId) Deletes member account for PointLoyalty Member Console.
void	deleteMemberAccounts(WsLogin login, java.lang.String[] personalIds) Deletes members accounts for PointLoyalty Member Console.
void	deleteMembers(WsLogin login, java.lang.String[] memberIds) Deletes loyalty program members registered in the system.
WsProgramOwnerData[]	getActiveOffers(WsLogin login) Gets all currently active offers.
WsBonusAdjustment[]	getBonusAdjustments(WsLogin login, java.lang.String memberId, java.util.Date from, java.util.Date to) Gets all bonus adjustments registered for the customer within time interval.
WsBonusFullData[]	getBonuses(WsLogin login, java.lang.String memberId, java.util.Date from, java.util.Date to) Gets all bonuses earned by the customer within time interval.
WsMemberActivity[]	getMemberActivity(WsLogin login, java.lang.String memberId, java.util.Date from, java.util.Date to) Gets the history of customer(member) activity.
boolean	isCreatedAttributesTemplate(WsLogin login, java.lang.String action, java.lang.String[] attrs) Check if there is action template with attributes defined in the system.
boolean	isCreatedMembersTemplate(WsLogin login, java.lang.String[] attrs) Check if there are members' templates defined in the system.
boolean	isValidClientAccount(WsLogin login) Check if there is valid program owner's account in PointLoyalty Manager for this login.
boolean	isValidMemberAccount(WsLogin login) Check if there is valid member's account in Member Console for this login.

Method Detail

addActions

WsBonusFullData[] addActions(WsLogin login,
                             java.lang.String userDataId,
                             WsAction[] actions)
                             throws WsLoyaltyException

Sends a batch of user transactions to PointLoyalty Manager system for bonus calculation.
Pay attention that one action can cause calculating bonuses in multiple loyalty offers.

Parameters:

login - Account in PointLoyalty Manager system.

userDataId - Unique actions batch identifier. It can be used to identify actions to delete. Optional.

actions - Actions for processing.

Returns:

Calculated bonuses. Returns null if no bonuses are calculated for transmitted actions.

Throws:

WsLoyaltyException - If any errors occur.

addAction

WsBonusFullData[] addAction(WsLogin login,
                            java.lang.String userDataId,
                            WsAction action)
                            throws WsLoyaltyException

Sends one user action to PointLoyalty Manager system and calculate bonus points.
Pay attention that one action can cause calculating bonuses in multiple loyalty offers.

Parameters:

login - Account in PointLoyalty Manager system.

userDataId - Unique action identifier. It can be used to identify actions to delete. Optional.

action - Action for processing.

Returns:

Calculated bonuses. Returns null if no bonuses are calculated for transmitted action.

Throws:

WsLoyaltyException - If any errors occur.

addBonusAdjustment

void addBonusAdjustment(WsLogin login,
                        java.lang.String userDataId,
                        WsBonusAdjustment adj)
                        throws WsLoyaltyException

Sends bonus adjustment information to PointLoyalty Manager system.

Parameters:

login - Account in PointLoyalty Manager system.

userDataId - Unique adjustments identifier. It can be used to identify adjustments to delete. Optional.

adj - Bonus adjustment.

Throws:

WsLoyaltyException - If any errors occur.

addBonusAdjustments

void addBonusAdjustments(WsLogin login,
                         java.lang.String userDataId,
                         WsBonusAdjustment[] adjs)
                         throws WsLoyaltyException

Sends a batch of bonus adjustments information to PointLoyalty Manager system. Note, that all adjustments must be relevant to the same program and offer.

Parameters:

login - Account in PointLoyalty Manager system.

userDataId - Unique adjustments batch identifier. It can be used to identify adjustments to delete. Optional.

adjs - Bonuses adjustments.

Throws:

WsLoyaltyException - If any errors occur.

deleteActions

void deleteActions(WsLogin login,
                   java.lang.String userDataId)
                   throws WsLoyaltyException

Deletes member actions registered in the system.

Parameters:

login - Account in PointLoyalty Manager system.

userDataId - Unique actions batch identifier. Actions with this identifier should be already registered in the system.

Throws:

WsLoyaltyException - If any errors occur.

deleteBonusAdjustments

void deleteBonusAdjustments(WsLogin login,
                            java.lang.String userDataId)
                            throws WsLoyaltyException

Deletes bonuses adjustments registered in the system.

Parameters:

login - Account in PointLoyalty Manager system.

userDataId - Unique adjustments batch identifier. Adjustments with this identifier should be already registered in the system.

Throws:

WsLoyaltyException - If any errors occur.

addMembers

void addMembers(WsLogin login,
                WsMember[] members)
                throws WsLoyaltyException

Creates multiple loyalty program members.

Parameters:

login - Account in PointLoyalty Manager system.

members - Loyalty members data.

Throws:

WsLoyaltyException - If any errors occur.

addMember

void addMember(WsLogin login,
               WsMember member)
               throws WsLoyaltyException

Creates loyalty program member.

Parameters:

login - Account in PointLoyalty Manager system.

member - Loyalty member data.

Throws:

WsLoyaltyException - If any errors occur.

deleteMembers

void deleteMembers(WsLogin login,
                   java.lang.String[] memberIds)
                   throws WsLoyaltyException

Deletes loyalty program members registered in the system.

Parameters:

login - Account in PointLoyalty Manager system.

memberIds - Loyalty program members identifiers.

Throws:

WsLoyaltyException - If any errors occur.

deleteMember

void deleteMember(WsLogin login,
                  java.lang.String memberId)
                  throws WsLoyaltyException

Deletes loyalty program member registered in the system.

Parameters:

login - Account in PointLoyalty Manager system.

memberId - Loyalty program member identifier.

Throws:

WsLoyaltyException - If any errors occur.

deleteBonuses

void deleteBonuses(WsLogin login,
                   java.lang.String[] bonusInternalIds)
                   throws WsLoyaltyException

Deletes bonuses calculated in the system.

Parameters:

login - Account in PointLoyalty Manager system.

bonusInternalIds - PointLoyalty Manager internal bonuses identifiers.

Throws:

WsLoyaltyException - If any errors occur.

deleteBonus

void deleteBonus(WsLogin login,
                 java.lang.String bonusInternalId)
                 throws WsLoyaltyException

Deletes bonus calculated in the system.

Parameters:

login - Account in PointLoyalty Manager system.

bonusInternalId - PointLoyalty Manager internal bonus identifier.

Throws:

WsLoyaltyException - If any errors occur.

getActiveOffers

WsProgramOwnerData[] getActiveOffers(WsLogin login)
                                     throws WsLoyaltyException

Gets all currently active offers.

Parameters:

login - Account in PointLoyalty Manager system.

Returns:

Loyalty offers.

Throws:

WsLoyaltyException - If any errors occur.

getMemberActivity

WsMemberActivity[] getMemberActivity(WsLogin login,
                                     java.lang.String memberId,
                                     java.util.Date from,
                                     java.util.Date to)
                                     throws WsLoyaltyException

Gets the history of customer(member) activity. The history will include all registered customer actions and bonus adjustments made by the program owner.
Using from and to parameters you can set the time interval for the request. Note that it is possible to pass only one of these dates.

Parameters:

login - Account in PointLoyalty Manager system.

memberId - Customer(member) identifier.

from - Interval begin date (can be null).

to - Interval end date (can be null).

Returns:

All member actions registered within the interval.

Throws:

WsLoyaltyException - If any errors occur.

getBonuses

WsBonusFullData[] getBonuses(WsLogin login,
                             java.lang.String memberId,
                             java.util.Date from,
                             java.util.Date to)
                             throws WsLoyaltyException

Gets all bonuses earned by the customer within time interval.
Using from and to parameters you can set the time interval for the request. Note that it is possible to pass only one of these dates.

Parameters:

login - Account in PointLoyalty Manager system.

memberId - Customer(member) identifier.

from - Interval begin date (can be null).

to - Interval end date (can be null).

Returns:

All bonuses earned by the customer within the interval.

Throws:

WsLoyaltyException - If any errors occur.

getBonusAdjustments

WsBonusAdjustment[] getBonusAdjustments(WsLogin login,
                                        java.lang.String memberId,
                                        java.util.Date from,
                                        java.util.Date to)
                                        throws WsLoyaltyException

Gets all bonus adjustments registered for the customer within time interval.
Using from and to parameters you can set the time interval for the request. Note that it is possible to pass only one of these dates.

Parameters:

login - Account in PointLoyalty Manager system.

memberId - Customer(member) identifier.

from - Interval begin date (can be null).

to - Interval end date (can be null).

Returns:

All adjustments relevant to the customer within the time interval.

Throws:

WsLoyaltyException - If any errors occur.

deleteAllBonuses

void deleteAllBonuses(WsLogin login,
                      java.util.Date actionDateFrom,
                      java.util.Date actionDateTo)
                      throws WsLoyaltyException

Deletes all bonuses, calculated in the system. By specifying the interval one can restrict the scope of deleting. Note that interval dates are action dates and not the bonus calculation dates.
It is possible to specify only one of these dates.

Parameters:

login - Account in PointLoyalty Manager system.

actionDateFrom - Interval begin date (can be null).

actionDateTo - Interval end date (can be null).

Throws:

WsLoyaltyException - If any errors occur.

deleteAllMembers

void deleteAllMembers(WsLogin login)
                      throws WsLoyaltyException

Deletes all members, registered in the system.

Parameters:

login - Account in PointLoyalty Manager system.

Throws:

WsLoyaltyException - If any errors occur.

deleteAllActions

void deleteAllActions(WsLogin login,
                      java.util.Date from,
                      java.util.Date to)
                      throws WsLoyaltyException

Deletes all actions, registered in the system with all calculated bonuses for these actions.
Using from and to parameters you can set the time interval for the request. Note that it is possible to pass only one of these dates.

Parameters:

login - Account in PointLoyalty Manager system.

from - Interval begin date (can be null).

to - Interval end date (can be null).

Throws:

WsLoyaltyException - If any errors occur.

deleteAllBonusAdjustments

void deleteAllBonusAdjustments(WsLogin login,
                               java.util.Date from,
                               java.util.Date to)
                               throws WsLoyaltyException

Deletes all bonus adjustments, registered in the system.
Using from and to parameters you can set the time interval for the request. Note that it is possible to pass only one of these dates.

Parameters:

login - Account in PointLoyalty Manager system.

from - Interval begin date (can be null).

to - Interval end date (can be null).

Throws:

WsLoyaltyException - If any errors occur.

addMemberAccount

void addMemberAccount(WsLogin login,
                      WsMemberAccount memberAccount)
                      throws WsLoyaltyException

Creates member account for PointLoyalty Member Console.

Parameters:

login - Account in PointLoyalty Manager system.

memberAccount - Member account data.

Throws:

WsLoyaltyException - If any errors occur.

addMemberAccounts

void addMemberAccounts(WsLogin login,
                       WsMemberAccount[] memberAccounts)
                       throws WsLoyaltyException

Creates members' accounts for PointLoyalty Member Console.

Parameters:

login - Account in PointLoyalty Manager system.

memberAccounts - Members' accounts data.

Throws:

WsLoyaltyException - If any errors occur.

deleteMemberAccount

void deleteMemberAccount(WsLogin login,
                         java.lang.String personalId)
                         throws WsLoyaltyException

Deletes member account for PointLoyalty Member Console.

Parameters:

login - Account in PointLoyalty Manager system.

personalId - Loyalty program member account identifier.

Throws:

WsLoyaltyException - If any errors occur.

deleteMemberAccounts

void deleteMemberAccounts(WsLogin login,
                          java.lang.String[] personalIds)
                          throws WsLoyaltyException

Deletes members accounts for PointLoyalty Member Console.

Parameters:

login - Account in PointLoyalty Manager system.

personalIds - Loyalty program member account identifiers.

Throws:

WsLoyaltyException - If any errors occur.

deleteAllMemberAccounts

void deleteAllMemberAccounts(WsLogin login)
                             throws WsLoyaltyException

Deletes all members accounts, registered in the system.

Parameters:

login - Account in PointLoyalty Manager system.

Throws:

WsLoyaltyException - If any errors occur.

isValidClientAccount

boolean isValidClientAccount(WsLogin login)
                             throws WsLoyaltyException

Check if there is valid program owner's account in PointLoyalty Manager for this login.

Parameters:

login - Account in PointLoyalty Manager system.

Returns:

true if account is valid.

Throws:

WsLoyaltyException - If any errors occur.

isValidMemberAccount

boolean isValidMemberAccount(WsLogin login)
                             throws WsLoyaltyException

Check if there is valid member's account in Member Console for this login.

Parameters:

login - Account in Member Console.

Returns:

true if account is valid.

Throws:

WsLoyaltyException - If any errors occur.

isCreatedMembersTemplate

boolean isCreatedMembersTemplate(WsLogin login,
                                 java.lang.String[] attrs)
                                 throws WsLoyaltyException

Check if there are members' templates defined in the system.

Parameters:

login - Account in PointLoyalty Manager system.

attrs - Member attributes names.

Returns:

true if all of them are defined.

Throws:

WsLoyaltyException - If any errors occur.

isCreatedAttributesTemplate

boolean isCreatedAttributesTemplate(WsLogin login,
                                    java.lang.String action,
                                    java.lang.String[] attrs)
                                    throws WsLoyaltyException

Check if there is action template with attributes defined in the system.

Parameters:

login - Account in PointLoyalty Manager system.

action - Action name.

attrs - Action attributes' names.

Returns:

true if action with all attributes is defined.

Throws:

WsLoyaltyException - If any errors occur.