/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/


#ifndef __com_sun_star_datatransfer_XMimeContentType_idl__
#define __com_sun_star_datatransfer_XMimeContentType_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/container/NoSuchElementException.idl>

module com { module sun { module star { module datatransfer {

//-------------------------------------------------------------------------
/** An implementation of this interface represents a MIME content-type that
    is conform to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and
    <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>.
    Instances that implement this interface could be created using the
    interface <type>XMimeContentTypeFactory</type>.
*/

published interface XMimeContentType : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** To get the media type of the MIME content-type.

        @returns
        The media type of the MIME content-type.
    */
    string getMediaType( );

    //-------------------------------------------------------------------------
    /** To get the media subtype of the MIME content-type.

        @returns
        The media subtype of the MIME content-type.
    */
    string getMediaSubtype( );

    //-------------------------------------------------------------------------
    /** To get the full media/submedia type of the MIME content-type.

        @returns
        The full media/submedia type of the MIME content-type.
    */
    string getFullMediaType( );

    //-------------------------------------------------------------------------
    /** To get a list of parameters that the MIME content-type contains.

        @returns
        A list of the names of all parameters of the MIME content-type.
    */
    sequence< string > getParameters( );

    //-------------------------------------------------------------------------
    /** To query if a specific parameter is supported.

        @param aName
        The name of the parameter to query for.

        @returns
        A value of <TRUE/> if the MIME content-type has the specified parameter.
        <p>A value of <FALSE/> if the MIME content-type has not the specified parameter.</p>
    */
    boolean hasParameter( [in] string aName );

    //-------------------------------------------------------------------------
    /** To get the value of a specified parameter.

        @param aName
        The name of the parameter for which the value is requested.

        @returns
        The value of the specified parameter.

        @throws com::sun::star::container::NoSuchElementException
        if the specified parameter doesn't exist.
    */
    string getParameterValue( [in] string aName )
        raises ( com::sun::star::container::NoSuchElementException );
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
