com.firedrum.webservice.service
Interface MemberService

All Known Implementing Classes:

MemberServiceImpl

public interface MemberService

Interface that defines the Firedrum Member web service.

Author:

rnmixon

Method Summary

Member	addMember(java.lang.String clientUsername, java.lang.String clientPassword, Member member) Add a new Member object for the given Client.
CategoryArray	getCategoryList(java.lang.String clientUsername, java.lang.String clientPassword) Return a list of Category objects for a client.
CustomFieldDefArray	getCustomFieldDefList(java.lang.String clientUsername, java.lang.String clientPassword) Return a list of Custom Field Types for a given the client.
Member	getMemberById(java.lang.String clientUsername, java.lang.String clientPassword, long memberId) Return a Member, given the member's internal id.
MemberArray	getMemberListByEmail(java.lang.String clientUsername, java.lang.String clientPassword, java.lang.String memberEmail) Return a list of Member objects for the given Client, filtered by email address.
Member	updateMember(java.lang.String clientUsername, java.lang.String clientPassword, Member member, boolean replaceCategories, boolean replaceCustomFieldData) Update an existing Member object for the given Client.

Method Detail

getCategoryList

CategoryArray getCategoryList(java.lang.String clientUsername,
                              java.lang.String clientPassword)
                              throws InvalidClientFault,
                                     CategoryNotFoundFault

Return a list of Category objects for a client.

Parameters:

clientUsername, - the username/userid used by the client to access the Firedrum system.

clientPassword, - the password for the clientUsername.

Returns:

CategoryArray object - containing a list of Category objects for the Firedrum Client.

Throws:

InvalidClientFault

CategoryNotFoundFault

getCustomFieldDefList

CustomFieldDefArray getCustomFieldDefList(java.lang.String clientUsername,
                                          java.lang.String clientPassword)
                                          throws InvalidClientFault

Return a list of Custom Field Types for a given the client.

Parameters:

clientUsername, - the username/userid used by the client to access the Firedrum system.

clientPassword, - the password for the clientUsername.

Returns:

CustomFieldDefArray object - containing a list of Custom Field Definition objects for the Firedrum Client.

Throws:

InvalidClientFault

getMemberById

Member getMemberById(java.lang.String clientUsername,
                     java.lang.String clientPassword,
                     long memberId)
                     throws InvalidClientFault

Return a Member, given the member's internal id.

This method is typically only used for diagnostics.

Parameters:

clientUsername, - the username/userid used by the client to access the Firedrum system.

clientPassword, - the password for the clientUsername.

memberId, - the internal (Firedrum) identifier for a Member.

Returns:

Member object - a single Member object belonging to the Firedrum Client and identified by memberId.

Throws:

InvalidClientFault

getMemberListByEmail

MemberArray getMemberListByEmail(java.lang.String clientUsername,
                                 java.lang.String clientPassword,
                                 java.lang.String memberEmail)
                                 throws InvalidClientFault

Return a list of Member objects for the given Client, filtered by email address.

The returned list will only contain Member with the same email address specified on input parameter memberEmail.

Parameters:

clientUsername, - the username/userid used by the client to access the Firedrum system.

clientPassword, - the password for the clientUsername.

memberEmail, - an email address to be used in selecting/filtering Members for the Firedrum Client.

Returns:

MemberArray object - containing a list of Member objects for the Firedrum Client.

Throws:

InvalidClientFault

addMember

Member addMember(java.lang.String clientUsername,
                 java.lang.String clientPassword,
                 Member member)
                 throws InvalidClientFault,
                        MemberExistsFault,
                        InvalidEmailAddressFault,
                        CategoryNotFoundFault,
                        CustomFieldTypeNotFoundFault,
                        MemberAddUnknownFault

Add a new Member object for the given Client.

Parameters:

clientUsername, - the username/userid used by the client to access the Firedrum system.

clientPassword, - the password for the clientUsername.

member, - a Member object to be added to the Firedrum system, associated with the Firedrum Client.

Returns:

Member object - if successful, the added Member object is returned with its internal id field populated and other system-maintained fields populated. If unsuccessful, a fault/exception is returned.

Throws:

InvalidClientFault

MemberExistsFault

InvalidEmailAddressFault

CategoryNotFoundFault

CustomFieldTypeNotFoundFault

MemberAddUnknownFault

updateMember

Member updateMember(java.lang.String clientUsername,
                    java.lang.String clientPassword,
                    Member member,
                    boolean replaceCategories,
                    boolean replaceCustomFieldData)
                    throws InvalidClientFault,
                           MemberNotFoundFault,
                           InvalidEmailAddressFault,
                           CategoryNotFoundFault,
                           CustomFieldTypeNotFoundFault,
                           MemberUpdateUnknownFault

Update an existing Member object for the given Client.

Parameters:

clientUsername, - the username/userid used by the client to access the Firedrum system.

clientPassword, - the password for the clientUsername.

member, - a Member object to be updated in the Firedrum system, associated with the Firedrum Client.

replaceCategories, - if true then the MemberCategory objects specified in the MemberCategoryList for the Member will completely replace the existing MemberCategory objects for the Member. If false, any MemberCategory objects in the MemberCategoryList will augment the existing MemberCategory objects for the Member.

replaceCustomFieldData, - if true then the MemberCustomField objects specified in the MemberCustomFieldList for the Member will completely replace the existing MemberCustomField objects for the Member. If false, any MemberCustomField objects in the MemberCustomFieldList will augment the existing MemberCustomField objects for the Member.

Returns:

Member object - if successful, the updated Member object is returned, reflecting updates to any system-maintained fields updated. If unsuccessful, a fault/exception is returned.

Throws:

InvalidClientFault

MemberNotFoundFault

InvalidEmailAddressFault

CategoryNotFoundFault

CustomFieldTypeNotFoundFault

MemberUpdateUnknownFault