DialogBuilder (OCSIP 3.1 RA Type)

```
public interface DialogBuilder
```
A builder interface for configuring and creating new SIP dialog activities.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`DialogBuilder.Unconfigured`	Represents an unconfigured builder, which requires more information about the dialog before it can be created.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`net.java.slee.resource.sip.DialogActivity`	`newDialog()`	Creates a new `DialogActivity` based on the parameters supplied to this builder.
`DialogBuilder`	`reuseCallID()`	If the dialog is being created by forwarding another dialog, then this instructs the builder to reuse the original dialog's Call-ID in the new dialog.
`DialogBuilder`	`withCallID(String callID)`	The new dialog will use the supplied Call-ID.
`DialogBuilder`	`withLocalTag(String tag)`	The new dialog will use the supplied local tag.
`DialogBuilder`	`withSessionTimer(SessionTimerOptions options)`	The new dialog will use a session timer with the given options

- Method Detail
  - reuseCallID
```
DialogBuilder reuseCallID()
```
    If the dialog is being created by forwarding another dialog, then this instructs the builder to reuse the original dialog's Call-ID in the new dialog. Otherwise this method has no effect.
    
    Returns:
    
    this DialogBuilder
  - withCallID
```
DialogBuilder withCallID(String callID)
```
    The new dialog will use the supplied Call-ID.
    
    Parameters:
    
    callID - a call-ID value, may not be null.
    
    Returns:
    
    this DialogBuilder
  - withLocalTag
```
DialogBuilder withLocalTag(String tag)
```
    The new dialog will use the supplied local tag.
    
    Parameters:
    
    tag - a tag value, may not be null.
    
    Returns:
    
    this DialogBuilder
  - withSessionTimer
```
DialogBuilder withSessionTimer(SessionTimerOptions options)
```
    The new dialog will use a session timer with the given options
    
    Parameters:
    
    options - a SessionTimerOptions value, may not be null.
    
    Returns:
    
    this DialogBuilder
  - newDialog
```
net.java.slee.resource.sip.DialogActivity newDialog()
                                             throws javax.sip.SipException
```
    Creates a new DialogActivity based on the parameters supplied to this builder.
    
    Returns:
    
    a DialogActivity
    
    Throws:
    
    javax.sip.SipException - if unable to create the dialog activity