com.spectel.bcapi
Interface CallBrandingTableEntry

public interface CallBrandingTableEntry

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

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.

Field Summary

static java.lang.String	CALL_FLOW_FUNCTION_DNIS_DIRECT Predefined return values from String getCallFlowFuntion()
static java.lang.String	CALL_FLOW_FUNCTION_ENTER_QUEUE Predefined return values from String getCallFlowFuntion()
static java.lang.String	CALL_FLOW_FUNCTION_FLEX_FLOW Predefined return values from String getCallFlowFuntion()
static java.lang.String	CALL_FLOW_FUNCTION_HANGUP Predefined return values from String getCallFlowFuntion()
static java.lang.String	CALL_FLOW_FUNCTION_SCAN_FLOW Predefined return values from String getCallFlowFuntion()

Method Summary

int	getAnnunciatorNumberForGreeting()
int	getCallBrandingReference() The Branding table line number.
java.lang.String	getCallFlowFunctionCode()
java.lang.String	getDnisMatchingExpression() The DNIS matching string is defined in the administration and maintenance guide.
java.lang.String	getLineCompanyName()
java.lang.String	getLineName()
int	getPromptSet()
int	getReservationGroup()
java.lang.String	getReservationGroupName()
boolean	isUsingConferencePromptSetWhenInConference() There are two kinds of messages played to people in a conference.

Field Detail

CALL_FLOW_FUNCTION_SCAN_FLOW

static final java.lang.String CALL_FLOW_FUNCTION_SCAN_FLOW

Predefined return values from String getCallFlowFuntion()

Since:

1.6

See Also:

Constant Field Values

CALL_FLOW_FUNCTION_FLEX_FLOW

static final java.lang.String CALL_FLOW_FUNCTION_FLEX_FLOW

Predefined return values from String getCallFlowFuntion()

Since:

1.6

See Also:

Constant Field Values

CALL_FLOW_FUNCTION_HANGUP

static final java.lang.String CALL_FLOW_FUNCTION_HANGUP

Predefined return values from String getCallFlowFuntion()

Since:

1.6

See Also:

Constant Field Values

CALL_FLOW_FUNCTION_ENTER_QUEUE

static final java.lang.String CALL_FLOW_FUNCTION_ENTER_QUEUE

Predefined return values from String getCallFlowFuntion()

Since:

1.6

See Also:

Constant Field Values

CALL_FLOW_FUNCTION_DNIS_DIRECT

static final java.lang.String CALL_FLOW_FUNCTION_DNIS_DIRECT

Predefined return values from String getCallFlowFuntion()

Since:

1.6

See Also:

Constant Field Values

Method Detail

getCallBrandingReference

int getCallBrandingReference()

The Branding table line number.

Returns:

The reference in the call branding table for this entry. Lower number are higher in the list.

Since:

1.6

getDnisMatchingExpression

java.lang.String getDnisMatchingExpression()

The DNIS matching string is defined in the administration and maintenance guide. This method returns the raw string used in the branding table for matching. It may contain question marks or other matching characters instead of digits.

The matching string is order dependent, so entry zero is tested first, followed by enty one, and so on, until there are no more entries to match incoming DNIS values with.

The bridge is usually configured to have a wild card, catch-all, statement as the last entry in the table to help force non-matching, incoming DNIS to a particular default behavior.

Returns:

The DNIS Matching String

Since:

1.6

getCallFlowFunctionCode

java.lang.String getCallFlowFunctionCode()

Returns:

A String representing the Call Flow Function for this entry in the Branding table

Since:

1.6

See Also:

CALL_FLOW_FUNCTION_FLEX_FLOW, CALL_FLOW_FUNCTION_HANGUP, CALL_FLOW_FUNCTION_ENTER_QUEUE, CALL_FLOW_FUNCTION_DNIS_DIRECT

getLineName

java.lang.String getLineName()

Returns:

The line name automatically attached to incoming line when caller matches this DNIS entry

Since:

1.6

getLineCompanyName

java.lang.String getLineCompanyName()

Returns:

The Line-company_name automatically attached to incoming line when caller matches this DNIS entry

Since:

1.6

getAnnunciatorNumberForGreeting

int getAnnunciatorNumberForGreeting()

Returns:

The Annunciator number of the greeting played to the line.

Since:

1.6

getPromptSet

int getPromptSet()

Returns:

The Prompt Set configured for the conference entry greeting.

Since:

1.6

getReservationGroup

int getReservationGroup()

Returns:

The reservation group number for lines matching with this Branding table entry.

Since:

1.6

getReservationGroupName

java.lang.String getReservationGroupName()

Returns:

The text name configured on the bridge for the reservation group of this entry

Since:

1.6

isUsingConferencePromptSetWhenInConference

boolean isUsingConferencePromptSetWhenInConference()

There are two kinds of messages played to people in a conference.

Conference messages are played to everyone in the room at the same time, and these messages are always played in a prommpt set that is set on the conference.

Line messages are played when something specific happens to the line. Example: self-mute, or menus.

This setting determines if the line will be set to the conference prompt set after navigating through the conference entry call flow, with the prompt set defined in this Branding table entry, or if the line will continue to receive messages in the language of the conference entry greeting.

Returns:

true when the Conference prompt set is used for thie line after conference entry, false when the the prompt set for the line remains set by the incoming matching DNIS entry. in the call branding table.

Since:

1.6