ibi.broker.api.ws
Class AddressBookManagerClientSF

java.lang.Object
  ibi.broker.api.ws.AddressBookManagerClientSF

All Implemented Interfaces:

AddressBookManager

public class AddressBookManagerClientSF
extends java.lang.Object
implements AddressBookManager

Constructor Summary

AddressBookManagerClientSF(java.lang.String base, java.lang.String userName, java.lang.String password)

Method Summary

void	addAddressBook(AddrBook addrBook) Creates an Address Book in the ReportCaster Repository.
void	addDestinationElement(java.lang.String bookName, DestinationElement destinationElement) Adds a DestinationElement to the Address Book specified by bookName.
void	deleteAddressBook(java.lang.String bookName) Deletes the Address Book specified by bookName.
void	deleteDestinationElement(java.lang.String bookName, DestinationElement destinationElement) Deletes a DestinationElement from the Address Book specified by bookName.
AddrBook	getAddressBook(java.lang.String bookName) Returns an AddrBook object specified by bookName.
AddrBook[]	getAddressBookPrivateList(java.lang.String method)
AddrBook[]	getAddressBookPrivateListByCaller(java.lang.String method) Returns an Array of PRIVATE AddrBook objects for both the given distribution method and the caller who has authenticated.
AddrBook[]	getAddressBookPrivateListByOwner(java.lang.String owner, java.lang.String method) Returns an Array of PRIVATE AddrBook objects for a given distribution method and the specified owner of the AddrBooks.
AddrBook	getAddressBookProperty(java.lang.String bookName) Returns an AddrBook object specified by bookName.
AddrBook[]	getAddressBookPublicList(java.lang.String method) Returns an Array of PUBLIC AddrBook objects for a given distribution method.
AddrBook[]	getAddressBookPublicListByCaller(java.lang.String method) Returns an Array of PUBLIC AddrBook objects for a given distribution method and the caller who has authenticated.
AddrBook[]	getAddressBookPublicListByOwner(java.lang.String owner, java.lang.String method) Returns an Array of PUBLIC AddrBook objects for a given distribution method and the specified owner of the Address Books.
java.lang.String[]	getOwnerList() Retrieves the Address Book owner list as a String Array from the ReportCaster Repository.
java.lang.String[]	getOwnerList(java.lang.String method, java.lang.String access)
void	updateAddressBook(AddrBook addrBook) Updates an Address Book's properties, deletes all existing distribution lists and inserts the new ones, which are represented by the DestinationElement Array stored in AddrBook.
void	updateAddressBookProperty(AddrBook addrBook) Address Book's properties in the ReportCaster Repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddressBookManagerClientSF

public AddressBookManagerClientSF(java.lang.String base,
                                  java.lang.String userName,
                                  java.lang.String password)
                           throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getAddressBookPublicList

public AddrBook[] getAddressBookPublicList(java.lang.String method)
                                    throws CasterException

Description copied from interface: AddressBookManager

Returns an Array of PUBLIC AddrBook objects for a given distribution method. The distribution method is one of three String constants: Distribution.EMAIL , Distribution.PRINT, or Distribution.FTP. For performance reasons, the AddrBook objects returned by this method do not contain the distribution list. If there are no PUBLIC Address Books for the specified distribution method, an empty Array will be returned. If the specified distribution method is NULL, all Address Books will be returned.

Specified by:

getAddressBookPublicList in interface AddressBookManager

Parameters:

method - The method of distribution as a String constant

Returns:

an Array of AddrBook objects.

Throws:

CasterException

getAddressBookPrivateList

public AddrBook[] getAddressBookPrivateList(java.lang.String method)
                                     throws CasterException

Specified by:

getAddressBookPrivateList in interface AddressBookManager

Throws:

CasterException

getAddressBookPublicListByCaller

public AddrBook[] getAddressBookPublicListByCaller(java.lang.String method)
                                            throws CasterException

Description copied from interface: AddressBookManager

Returns an Array of PUBLIC AddrBook objects for a given distribution method and the caller who has authenticated. The distribution method is one of three String constants: Distribution.EMAIL , Distribution.PRINT, or Distribution.FTP. If there are no PUBLIC Address Books for the specified distribution method, an empty Array will be returned. If the specified distribution method is NULL, all Address Books will be returned. For performance reasons, the AddrBook objects returned by this method do not contain the distribution list.

Specified by:

getAddressBookPublicListByCaller in interface AddressBookManager

Parameters:

method - The method of distribution as a String constant.

Returns:

an Array of AddrBook objects.

Throws:

CasterException

See Also:

for all the methods values.

getAddressBookPublicListByOwner

public AddrBook[] getAddressBookPublicListByOwner(java.lang.String owner,
                                                  java.lang.String method)
                                           throws CasterException

Description copied from interface: AddressBookManager

Returns an Array of PUBLIC AddrBook objects for a given distribution method and the specified owner of the Address Books. The distribution method is one of three String Distribution.EMAIL , Distribution.PRINT. If there are no PUBLIC Address Books for the specified distribution method, an empty Array will be returned. If the specified distribution method is NULL, all Address Books will be returned. For performance reasons, the AddrBook objects returned by this method do not contain the distribution list.

Specified by:

getAddressBookPublicListByOwner in interface AddressBookManager

Parameters:

owner - The owner of the Address Book as a String.

method - The method of distribution, as a String constant.

Returns:

an Array of AddrBook objects.

Throws:

CasterException

getAddressBookPrivateListByCaller

public AddrBook[] getAddressBookPrivateListByCaller(java.lang.String method)
                                             throws CasterException

Description copied from interface: AddressBookManager

Returns an Array of PRIVATE AddrBook objects for both the given distribution method and the caller who has authenticated. The distribution method is one of three String constants: Distribution.EMAIL , Distribution.PRINT, or Distribution.FTP. If there are no PUBLIC Address Books for the specified distribution method, an empty Array will be returned. If the specified distribution method is NULL, all Address Books will be returned. For performance reasons, the AddrBook objects returned by this method do not contain the distribution list.

Specified by:

getAddressBookPrivateListByCaller in interface AddressBookManager

Parameters:

method - The method of distribution, as a String constant. This method is available only to the administrator and the Address Book owner.

Returns:

an Array of AddrBook objects.

Throws:

CasterException

getAddressBookPrivateListByOwner

public AddrBook[] getAddressBookPrivateListByOwner(java.lang.String owner,
                                                   java.lang.String method)
                                            throws CasterException

Description copied from interface: AddressBookManager

Returns an Array of PRIVATE AddrBook objects for a given distribution method and the specified owner of the AddrBooks. The distribution method is one of three String Distribution.EMAIL , Distribution.PRINT. If there are no PUBLIC Address Books for the specified distribution method, an empty Array will be returned. If the specified distribution method is NULL all Address Books will be returned. If the caller is an administrator, any owner may be specified. If the caller is an End User, the user may specify his own userID. Otherwise, an exception is thrown. For performance reasons, the AddrBook objects returned by this method do not contain the distribution list. This method is available only to the administrator and the Address Book owner.

Specified by:

getAddressBookPrivateListByOwner in interface AddressBookManager

Parameters:

owner - The owner of the Address Book, as a String.

method - The method of distribution, as a String constant.

Returns:

an Array of AddrBook objects.

Throws:

CasterException

getAddressBookProperty

public AddrBook getAddressBookProperty(java.lang.String bookName)
                                throws CasterException

Description copied from interface: AddressBookManager

Returns an AddrBook object specified by bookName. For performance reasons, the AddrBook objects returned by this method do not contain the distribution list. This method is available only to the administrator and the Address Book owner.

Specified by:

getAddressBookProperty in interface AddressBookManager

Parameters:

bookName - The name of the Address Book stored in the database, as a String.

Returns:

AddrBook An AddrBook object associated with the bookname.

Throws:

CasterException

getAddressBook

public AddrBook getAddressBook(java.lang.String bookName)
                        throws CasterException

Description copied from interface: AddressBookManager

Returns an AddrBook object specified by bookName. The AddrBook objects returned by this method contain distribution list information in the form of a DestinationElement Array. This method is available only to the administrator and the Address Book owner.

Specified by:

getAddressBook in interface AddressBookManager

Parameters:

bookName - The name of the Address Book stored in the database, as a String.

Returns:

AddrBook

Throws:

CasterException

addAddressBook

public void addAddressBook(AddrBook addrBook)
                    throws CasterException

Description copied from interface: AddressBookManager

Creates an Address Book in the ReportCaster Repository. Parameter AddrBook may or may not contain a DestinationElement Array. All distribution lists represented by the DestinationElement Array will also be inserted into the repository. This method is available only to the administrator and the Address Book owner.

Specified by:

addAddressBook in interface AddressBookManager

Parameters:

addrBook - AddrBook object associated with the repository data that is to be added.

Throws:

CasterException

updateAddressBookProperty

public void updateAddressBookProperty(AddrBook addrBook)
                               throws CasterException

Description copied from interface: AddressBookManager

Address Book's properties in the ReportCaster Repository. It does not update the DestinationElement Array. This method is available only to the administrator and the Address Book owner.

Specified by:

updateAddressBookProperty in interface AddressBookManager

Parameters:

addrBook - AddrBook object containing the data that is to be updated in the repository.

Throws:

CasterException

updateAddressBook

public void updateAddressBook(AddrBook addrBook)
                       throws CasterException

Description copied from interface: AddressBookManager

Updates an Address Book's properties, deletes all existing distribution lists and inserts the new ones, which are represented by the DestinationElement Array stored in AddrBook. This method is available only to the administrator and the Address Book owner.

Specified by:

updateAddressBook in interface AddressBookManager

Parameters:

addrBook - object containing the data that is to be updated in the repository.

Throws:

CasterException

deleteAddressBook

public void deleteAddressBook(java.lang.String bookName)
                       throws CasterException

Description copied from interface: AddressBookManager

Deletes the Address Book specified by bookName. This method is available only to the administrator and the Address Book owner.

Specified by:

deleteAddressBook in interface AddressBookManager

Parameters:

bookName - The name of the Address Book stored in the database, as a String.

Throws:

CasterException

addDestinationElement

public void addDestinationElement(java.lang.String bookName,
                                  DestinationElement destinationElement)
                           throws CasterException

Description copied from interface: AddressBookManager

Adds a DestinationElement to the Address Book specified by bookName. This method is available only to the administrator and the Address Book owner.

Specified by:

addDestinationElement in interface AddressBookManager

Parameters:

bookName - The name of the Address Book stored in the database, as a String.

destinationElement - DestinationElement object containing the line in the Address Book that is to be added.

Throws:

CasterException

deleteDestinationElement

public void deleteDestinationElement(java.lang.String bookName,
                                     DestinationElement destinationElement)
                              throws CasterException

Description copied from interface: AddressBookManager

Deletes a DestinationElement from the Address Book specified by bookName. This method is available only to the administrator and the Address Book owner.

Specified by:

deleteDestinationElement in interface AddressBookManager

Parameters:

bookName - The name of the Address Book stored in the database, as a String.

destinationElement - DestinationElement object containing the line in the Address Book that is to be deleted.

Throws:

CasterException

getOwnerList

public java.lang.String[] getOwnerList()
                                throws CasterException

Description copied from interface: AddressBookManager

Retrieves the Address Book owner list as a String Array from the ReportCaster Repository. This method can only be called by an administrator.

Specified by:

getOwnerList in interface AddressBookManager

Returns:

a String Array of Address Book owners.

Throws:

CasterException

getOwnerList

public java.lang.String[] getOwnerList(java.lang.String method,
                                       java.lang.String access)
                                throws CasterException

Specified by:

getOwnerList in interface AddressBookManager

Throws:

CasterException