ReasonData (Oracle Communications Converged Application Server 5.1 Java API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Communications Converged Application Server Java API Reference
5.1
E36938-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.oracle.sft.api.context
Interface ReasonData

public interface ReasonData

Reason information.

See Also:: Reason

Method Summary
`boolean`	`fromMessageHeader()` Is this reason data sent in a header or not.
`String`	`getProtocol()` The protocol of the reason.
`int`	`getReasonCode()` Return the reason code, when the protocol is not SIP.
`String`	`getReasonText()` Description o the reason.
`Reason`	`getReasonType()` Provide type of the reason.

Method Detail

getReasonType

Reason getReasonType()

Provide type of the reason.

Returns:: Reason information
See Also:: Reason

getReasonCode

int getReasonCode()

Return the reason code, when the protocol is not SIP.

Returns:: The reason code.

getReasonText

String getReasonText()

Description o the reason. This is potentially extracted from the underlying protocol message.

Returns:: Description of the reason.

getProtocol

String getProtocol()

The protocol of the reason. Usually this will be "SIP", unless the underlying message is coming from a non SIP system (eg: Q.850).

Returns:: name of the protocol.

fromMessageHeader

boolean fromMessageHeader()

Is this reason data sent in a header or not.

Returns:: True if the message contained this reason data as a header.