com.spectel.bcapi
Interface CallBrandingTable

public interface CallBrandingTable

This interface is used to provide read-only, cached-access to the data in the call branding table on the bridge.

Each time Bridge.getCallBrandingTable() is called, BCAPI 1.6 will read the Call Branding Table, and various other pieces of information, to build a cached image of the table.

An application can repeatedly call CallBrandingTable.getReservationGroupFromDNIS(String argDNIS) to convert real dnis strings into the appropriate reservation group number without causing network traffic.
$nbsp
There is also an iterator which can return the read-only values in the Call Branding table
$nbsp
The iterator returned from CallBrandingTable will iterate through the entires in the call branding table and will return this interface to read and present that information if necessary for the developer or end user application.

The DNIS matching algorythm is order dependent. An index of zero indicates the first entry in the table and higher order indexes indicate subsequent entries. The matching algorythm on the bridge tests the first entry for a match followed by the second, and so on until a matching entry is found.

The DNIS matching string can contain wild cards defined in the administration and maintenance manual. It is not always useful to present the DNIS strings for specific reservation groups because the matching algorythm is order dependent.

Since:

1.6

Method Summary

int	getMatchingDigits() Gets the number of matching digits used to compare with the Dnis-matching expressions in the table.
int	getReservationGroupFromDNIS(java.lang.String argDNIS)
java.lang.String	getReservationGroupName(int argReservationGroup)
boolean	isMatchingShort() Is the bridge configured to match incoming DNIS entries that are shorter than the Dnis-matching-expressions in the table.
java.util.Iterator	iterator()

Method Detail

getMatchingDigits

int getMatchingDigits()

Gets the number of matching digits used to compare with the Dnis-matching expressions in the table.

Returns:

The number of matching digits used to compare with the Dnis-matching expressions in the table.

getReservationGroupFromDNIS

int getReservationGroupFromDNIS(java.lang.String argDNIS)
                                throws BridgeException

Parameters:

argDNIS - The full DNIS string entered by user or an application to be converted into a reservation group number for opening the correct rooms with reservation-group and conference-entry-code

Returns:

Reservation Group translated from the number entered

Throws:

BridgeException - if the conversion does not result in a valid match.

Since:

1.6

isMatchingShort

boolean isMatchingShort()

Is the bridge configured to match incoming DNIS entries that are shorter than the Dnis-matching-expressions in the table.

Returns:

true if the bridge configured to match incoming DNIS entries that are shorter than the Dnis-matching-expressions in the table.

Since:

1.6

iterator

java.util.Iterator iterator()

Returns:

a read only Iterator that iterates through a list of CallBrandingTableEntry.

Since:

1.6

See Also:

CallBrandingTableEntry

getReservationGroupName

java.lang.String getReservationGroupName(int argReservationGroup)
                                         throws BridgeException

Parameters:

argReservationGroup - The reservation group number

Returns:

The string name associated with the Reservation Group Number

Throws:

BridgeException - if the argReservationGroup does not map to a configured name.

Since:

1.6