sip.header.SubjectHeader Maven / Gradle / Ivy
/**
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Unpublished - rights reserved under the Copyright Laws of the United States.
* Copyright ? 2003 Sun Microsystems, Inc. All rights reserved.
* Copyright ? 2005 BEA Systems, Inc. All rights reserved.
*
* Use is subject to license terms.
*
* This distribution may include materials developed by third parties.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Module Name : JSIP Specification
* File Name : SubjectHeader.java
* Author : Phelim O'Doherty
*
* HISTORY
* Version Date Author Comments
* 1.1 08/10/2002 Phelim O'Doherty
*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
package javax.sip.header;
import java.text.ParseException;
/**
* The Subject header field provides a summary or indicates the nature of the
* call, allowing call filtering without having to parse the session
* description. The session description does not have to use the same subject
* indication as the invitation.
*
* For Example:
* Subject: Where is the Moscone?
*
* @author BEA Systems, NIST
* @version 1.2
*/
public interface SubjectHeader extends Header {
/**
* Sets the subject value of the SubjectHeader to the supplied string
* subject value.
*
* @param subject - the new subject value of this header.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the subject value.
*/
public void setSubject(String subject) throws ParseException;
/**
* Gets the subject value of SubjectHeader.
*
* @return subject of SubjectHeader.
*/
public String getSubject();
/**
* Name of SubjectHeader
*/
public final static String NAME = "Subject";
}