cmisconfirmation.java

来自「CmisJavaApi」· Java 代码 · 共 133 行

/*
 * 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
 */

//  $Id: CMISConfirmation.java,v 1.2 2000/09/05 13:04:29 festor Exp $
//
// TODO


package fr.dyade.cmis.api.operation;

import fr.dyade.cmis.api.types.*;
import java.util.*;

/** CMIS reponse/confirmation data common to any operation.
  *    This <b>abstract</b> class is an abstract view for a reponse/confirmation of any
  *  CMIS service. 
  *  It is a generic type for  the parameter of the 
  *  <a href="fr.dyade.cmis.api.operation.CMISRequest.html#addConfirmation"> 
  *  cmis.api.operation.CMISRequest.addConfirmation method</a>.
  *  It is a seriable class, so such a confirmation will copied in the jvm that handle the operation
  *  object. So all parameters of req/ind and any confirmation are store in the same place.
  *  
  *  This class must be derived to handle specific parameters of the various CMIS services.
  *  
  *  @see fr.dyade.cmis.api.operation.CMISRequest#addConfirmation
  *  @version cvs $Id: CMISConfirmation.java,v 1.2 2000/09/05 13:04:29 festor Exp $
  */
public abstract class CMISConfirmation  implements java.io.Serializable {
      public static final short ACTION=0;
      public static final short CANCEL_GET=1;
      public static final short CREATE=2;
      public static final short DELETE=3;
      public static final short EVENT_REPORT=4;
      public static final short GET=5;
      public static final short SET=6;

      protected CMISConfirmation() {}
      /** Get numeric code for confirmation  type.
	* @return a short corresponding to CMISConfirmation.ACTION, CANCEL_GET...
	* It is surely not a nice programming style, but it could be useful
	* (ListeningThread).
	*/
      public abstract short getType();
      /**
	* Set the invoke identifier of the confirmation
	*/
      public void setInvokeId(InvokeId pIId) {
	 fInvokeId = pIId;
      }
      
      public InvokeId getInvokeId() {
	 return fInvokeId;
      }
      
      /** Sets the CMIS error parameter of the confirmation.
	*/   
      public void setCMISError(fr.dyade.cmis.api.types.CMISError pCMISError) {
	 fCMISError=pCMISError;
      }
  
      /** Gets the CMIS error parameter of the confirmation.
	*/
      public fr.dyade.cmis.api.types.CMISError getCMISError() {
	 return fCMISError;
      }

      /** Sets the FMK error parameter of the confirmation.
	*/   
      public void setInternalError(fr.dyade.cmis.api.types.InternalError pInternalError) {
	 fInternalError=pInternalError;
      }
  
      /** Gets the FMK error parameter of the confirmation.
	*/
      public fr.dyade.cmis.api.types.InternalError getInternalError() {
	 return fInternalError;
      }
      
      /** Gets  Reponse generation time.
	* This is a "free" interpretation of X710. It is supposed to be the time at which 
	*  the response was generated. Actually it is the local time at which 
	*  the confirmation was created on the responding JVM. Standard states that this
	*  confirmation parameter <i>may be included in the success confirmation</i>.
	*  We  provide it in any case. But CancelGet does use it....
	*/
      public GeneralizedTime getCurrentTime() {
	 return fCurrentTime;
      }
      
      /** Response generation time implementation.
	* @see CMISConfirmation#getCurrentTime
	*/
      protected GeneralizedTime fCurrentTime= null;
      
      /**
	* CMIS Error 
	*/
      private fr.dyade.cmis.api.types.CMISError fCMISError = null;
      
      /**
	* FMK Error 
	*/
      private fr.dyade.cmis.api.types.InternalError fInternalError = null;
      
      /**
	* Invoke identifier
	*/
      private InvokeId fInvokeId = null;
}