package org.okip.service.filing.api;

/*
   Copyright (c) 2002 Massachusetts Institute of Technology

   This work, including any software, documents, or other related items
   (the "Work"), is being provided by the copyright holder(s) subject to
   the terms of the MIT OKI(TM) API Definition License. By obtaining,
   using and/or copying this Work, you agree that you have read,
   understand, and will comply with the following terms and conditions of
   the MIT OKI(TM) API Definition License:

   You may use, copy, and distribute unmodified versions of this Work for
   any purpose, without fee or royalty, provided that you include the
   following on ALL copies of the Work that you make or distribute:

    *  The full text of the MIT OKI(TM) API Definition License in a
       location viewable to users of the redistributed Work.

    *  Any pre-existing intellectual property disclaimers, notices, or
       terms and conditions. If none exist, a short notice similar to the
       following should be used within the body of any redistributed
       Work: "Copyright (c) 2002 Massachusetts Institute of Technology. All
       Rights Reserved."

   You may modify or create Derivatives of this Work only for your
   internal purposes. You shall not distribute or transfer any such
   Derivative of this Work to any location or any other third party. For
   purposes of this license, "Derivative" shall mean any derivative of
   the Work as defined in the United States Copyright Act of 1976, such
   as a translation or modification.

   THIS WORK PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
   CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
   TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK
   OR THE USE OR OTHER DEALINGS IN THE WORK.

   The name and trademarks of copyright holder(s) and/or MIT may NOT be
   used in advertising or publicity pertaining to the Work without
   specific, written prior permission. Title to copyright in the Work and
   any associated documentation will at all times remain with the
   copyright holders.

*/

/*
 * $Source: /cvs/oki/tech/src/org/okip/service/filing/api/OkiOutputStream.java,v $
 */

/**
 * <p>
 * OkiOutputStream interface for output stream.
 * </p>
 * <p>
 * Also allows access to native system IO objects, e.g. java's
 * java.io.InputStream.
 * </p>
 * <p>
 * Licensed under the {@link org.okip.service.ApiLicense MIT OKI&#153; API Definition License}.
 *
 * @version $Name:  $ / $Revision: 1.4 $ / $Date: 2002/09/24 23:11:23 $ */
public interface OkiOutputStream //extends java.io.Serializable
{

  /**
   * Writes b.length bytes to this IO Object.
   */
  public void write(byte[] b)
  //throws FilingIOException, FilingPermissionDeniedException;
  throws FilingException;

  /**
   * Writes len bytes from the specified byte array starting at
   * offset off to this IO Object.
   */
  public void write(byte[] b, int off, int len)
  //throws FilingIOException, FilingPermissionDeniedException;
  throws FilingException;

  /**
   * Writes the specified byte to this IO Object.
   */
  public void write(int b)
//  throws FilingIOException, FilingPermissionDeniedException;
   throws FilingException;

  /**
   * Flushes this IO Object and forces any buffered output bytes
   * to be written out to the stream.
   */
  public void flush()
//  throws FilingIOException;
  throws FilingException;

  /**
   * Closes this OutputStream Object and releases any system resources
   * associated with the OutputStream Object.
   */
  public void close()
//  throws FilingIOException;
  throws FilingException;

  /**
   * Return OutputStream in native environment which can be used to
   * access this ByteStore.  In Java, this is a java.io.OutputStream
   * object.  From this one may obtain a Reader via OutputStreamReader.
   *
   * @return A java.io.OutputStream object which may be used to write to this
   * ByteStore.
   *
   * @throws FilingIOException - if an error occurs.
   * 
   * 
   * @throws FilingPermissionDeniedException - if Factory Owner
   * does not have permission to write to this ByteStore.
   * @throws FilingIOException - if an IO error occurs.
   */
  public java.io.OutputStream getNativeOutputStream()
  //throws FilingPermissionDeniedException, FilingIOException;
  throws FilingException;

}