deleteerror.java

CmisJavaApi

/*
 * The contents of this file are subject to the Dyade Public License, 
 * as defined by the file DYADE_PUBLIC_LICENSE.TXT
 *
 * You may not use this file except in compliance with the License. You may
 * obtain a copy of the License on the Dyade web site (www.dyade.fr).
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific terms governing rights and limitations under the License.
 *
 * The Original Code is CmisJava API, including the java package 
 * fr.dyade.cmis, released September 5, 2000.
 *
 * The Initial Developer of the Original Code is Dyade. The Original Code and
 * portions created by Dyade are Copyright Bull and Copyright INRIA. 
 * All Rights Reserved.
 */

/*      Copyright 1996-2000 by Institut National de Recherche en Informatique 
 *                             et en Automatique (INRIA)
 *          All rights reserved.  See COPYRIGHT in top-level directory.
 *
 *      Authors: Laurent Andrey, Eric Dillon, Olivier Festor
 */

//---------------------------------------------------------------------------//
//  CVS Info
//---------------------------------------------------------------------------//
//
//  $Id: DeleteError.java,v 1.2 2000/09/05 13:30:37 festor Exp $
//
//---------------------------------------------------------------------------//
//  Todo
//---------------------------------------------------------------------------//
// Make things clear !!!!
// This type is a CMIP asn1 type. It does not realy appear in CMIS delete 
// service specification (Delete Req/ind resp/conf).
// But it is used by Open Master fmk c interface to CMIS.
// This type should be pushed to fr.dyade.cmis.om.types package  for confirmation handling
// For Delete reponse fr/dyade/cmis/om/operation/C-code/DeleteResponseImpl.c (or j2c_CMISErrorMap) should make a
// guess : linked reply + error== acces denied and build the proprer intermediary
// Open Master C level DeleteError structure (ISMc_delete_Error).
// 
package fr.dyade.cmis.api.types;

/**
  *  Java representation of an ASN.1 DeleteError datatype.
  * <p>
  * This object is used for a delete response error. It has 2 fields:
  * <menu>
  *   <li> a <code>BaseResultInfo</code> field, inherited from <code>ResponseError</code>,
  *   <li> a <code>DeleteInfoError</code> integer field, that should only be set to one value, ACCESS_DENIED.
  * </menu>
  * <strong>This object is built from C-code through the JNI, so "set" methods are intended to be used
  * within an agent application.</strong>
  * See X711 page 22.
  */
public class DeleteError  extends ResponseError {
      public static final int ACCESS_DENIED = 2;
      
      public DeleteError() {
      }
      /**
	*  Sets the <code>int</code> deleteErrorInfo field of the <code>DeleteError</code> instance.
	*  @param pDeleteErrorInfo the <code>int</code> value for DeleteErrorInfo field.
	*/
      public void setDeleteErrorInfo(int pDeleteErrorInfo) {
	 fDeleteErrorInfo = pDeleteErrorInfo;
      }
      
      /**
	* Returns the <code>int</code> deleteErrorInfo field of the <code>DeleteError</code> instance.
	* @return the <code>int</code> value of DeleteErrorInfo field.
	*/
      public int getDeleteErrorInfo() {
	 return fDeleteErrorInfo;
      }
      
      protected int fDeleteErrorInfo;
} // DeleteError