net.java.sip.communicator.service.callhistory
Interface CallHistoryService

All Known Implementing Classes:

CallHistoryServiceImpl

public interface CallHistoryService

The Call History Service stores info about calls made from various protocols

Author:

Alexander Pelov, Damian Minkov

Method Summary

void	addSearchProgressListener(CallHistorySearchProgressListener listener) Adding progress listener for monitoring progress of search process
Collection<CallRecord>	findByEndDate(Date endDate) Returns all the calls made before the given date.
Collection<CallRecord>	findByEndDate(MetaContact contact, Date endDate) Returns all the calls made by all the contacts in the supplied contact before the given date.
CallHistoryQuery	findByPeer(String address, int recordCount) Find the calls made by the supplied peer address
Collection<CallRecord>	findByPeriod(Date startDate, Date endDate) Returns all the calls made between the given dates.
Collection<CallRecord>	findByPeriod(MetaContact contact, Date startDate, Date endDate) Returns all the calls made by all the contacts in the supplied contact between the given dates.
Collection<CallRecord>	findByStartDate(Date startDate) Returns all the calls made after the given date.
Collection<CallRecord>	findByStartDate(MetaContact contact, Date startDate) Returns all the calls made by all the contacts in the supplied contact after the given date.
Collection<CallRecord>	findLast(int count) Returns the supplied number of recent calls.
Collection<CallRecord>	findLast(MetaContact contact, int count) Returns the supplied number of recent calls made by all the contacts in the supplied contact.
void	removeSearchProgressListener(CallHistorySearchProgressListener listener) Removing progress listener

Method Detail

findByStartDate

Collection<CallRecord> findByStartDate(MetaContact contact,
                                       Date startDate)
                                       throws RuntimeException

Returns all the calls made by all the contacts in the supplied contact after the given date.

Parameters:

contact - MetaContact which contacts participate in the returned calls

startDate - Date the start date of the calls

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findByEndDate

Collection<CallRecord> findByEndDate(MetaContact contact,
                                     Date endDate)
                                     throws RuntimeException

Returns all the calls made by all the contacts in the supplied contact before the given date.

Parameters:

contact - MetaContact which contacts participate in the returned calls

endDate - Date the end date of the calls

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findByPeriod

Collection<CallRecord> findByPeriod(MetaContact contact,
                                    Date startDate,
                                    Date endDate)
                                    throws RuntimeException

Returns all the calls made by all the contacts in the supplied contact between the given dates.

Parameters:

contact - MetaContact which contacts participate in the returned calls

startDate - Date the start date of the calls

endDate - Date the end date of the calls

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findByStartDate

Collection<CallRecord> findByStartDate(Date startDate)
                                       throws RuntimeException

Returns all the calls made after the given date.

Parameters:

startDate - Date the start date of the calls

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findByEndDate

Collection<CallRecord> findByEndDate(Date endDate)
                                     throws RuntimeException

Returns all the calls made before the given date.

Parameters:

endDate - Date the end date of the calls

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findByPeriod

Collection<CallRecord> findByPeriod(Date startDate,
                                    Date endDate)
                                    throws RuntimeException

Returns all the calls made between the given dates.

Parameters:

startDate - Date the start date of the calls

endDate - Date the end date of the calls

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findLast

Collection<CallRecord> findLast(MetaContact contact,
                                int count)
                                throws RuntimeException

Returns the supplied number of recent calls made by all the contacts in the supplied contact.

Parameters:

contact - MetaContact which contacts participate in the returned calls

count - calls count

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findLast

Collection<CallRecord> findLast(int count)
                                throws RuntimeException

Returns the supplied number of recent calls.

Parameters:

count - calls count

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

findByPeer

CallHistoryQuery findByPeer(String address,
                            int recordCount)
                            throws RuntimeException

Find the calls made by the supplied peer address

Parameters:

address - String the address of the peer

recordCount - the number of records to return

Returns:

Collection of CallRecords with CallPeerRecord

Throws:

RuntimeException - if something goes wrong

addSearchProgressListener

void addSearchProgressListener(CallHistorySearchProgressListener listener)

Adding progress listener for monitoring progress of search process

Parameters:

listener - HistorySearchProgressListener

removeSearchProgressListener

void removeSearchProgressListener(CallHistorySearchProgressListener listener)

Removing progress listener

Parameters:

listener - HistorySearchProgressListener