baseresultinfo.java

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

/*
 * 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
 */
//---------------------------------------------------------------------------//
//
//  File:          BaseResultInfo.java
//  Project:	   
//  Creation:      01.04.1998
//  Last modified: 09.04.1998
//
//---------------------------------------------------------------------------//

//---------------------------------------------------------------------------//
//  CVS Info
//---------------------------------------------------------------------------//
//
//  $Id: BaseResultInfo.java,v 1.2 2000/09/05 13:30:32 festor Exp $
//  $Source: /local/resedas/CVS-Repository/CmisJavaApi/src/fr/dyade/cmis/api/types/BaseResultInfo.java,v $

//---------------------------------------------------------------------------//
//  Todo
//---------------------------------------------------------------------------//
// - This is probably Open Mater fmk-c-api related stuff.
// - Get rid of mask shit

package fr.dyade.cmis.api.types;

/**
  *  Java representation of an ASN.1 BaseResultInfo datatype.
  *  <p>
  *  This object is returned within every CMISResponse Error.
  *  According to the Error one of the following field may be set to non-<code>null</code> values.
  *  <menu>
  *     <li> ObjectClass,
  *     <li> ObjectInstance,
  *     <li> CurrentTime
  *  </menu>
  *  <p>
  *  <strong>This object is build from C-code within a Manager application. 
  *  As a consequence, all "set" methods are only provided for agent implementations.</strong>
  *
  *  @see fr.dyade.cmis.api.types.ActionError
  *  @see fr.dyade.cmis.api.types.DeleteError
  *  @see fr.dyade.cmis.api.types.GetListError
  *  @see fr.dyade.cmis.api.types.SetListError
  *  @see fr.dyade.cmis.api.types.ResponseError
  */
public class BaseResultInfo  {
      // These masks are used during mapping to ISMc structs.
      private final static int MASK_RESULT_OBJECTCLASS = 0x0001;
      private final static int MASK_RESULT_OBJINSTANCE = 0x0002;
      private final static int MASK_RESULT_CURRENTTIME = 0x0004;
      private final static int MASK_NONE = 0x0000;
      
      /**
	*  Sets the <code>ObjectClass</code> for this <code>BaseResultInfo</code> instance.
	*  @param pObjectClass the <code>ObjectClass</code> to use.
	*/
      public void setObjectClass(ObjectClass pObjectClass) {
	 fObjectClass = pObjectClass;
	 fMask = fMask + MASK_RESULT_OBJECTCLASS;
      }
      
      /**
	*  Returns the <code>ObjectClass</code> field of this <code>BaseResultInfo</code> instance.
	*  @return <code>ObjectClass</code> object.
	*/
      public ObjectClass getObjectClass() {
	 return fObjectClass;    
      }
  
      /**
	*  Sets the <code>ObjectInstance</code> for this <code>BaseResultInfo</code> instance.
	*  @param pObjectInstance the <code>ObjectInstance</code> to use.
	*/
      public void setObjectInstance(ObjectInstance pObjectInstance) {
	 fObjectInstance = pObjectInstance;
	 fMask = fMask + MASK_RESULT_OBJINSTANCE;
      }
      
      /**
	*  Returns the <code>ObjectInstance</code> field of this <code>BaseResultInfo</code> instance.
	*  @return <code>ObjectInstance</code> object.
	*/
      public ObjectInstance getObjectInstance() {
	 return fObjectInstance;
      }
      
      /**
	*  Sets the CurrentTime for this <code>BaseResultInfo</code> instance.
	*  @param pCurrentTime the <code>GeneralizedTime</code> parameter to use.
	*/
      public void setCurrentTime(GeneralizedTime pCurrentTime) {
	 fCurrentTime = pCurrentTime;
	 fMask = fMask + MASK_RESULT_CURRENTTIME;
      }
      
      /**
	*  Returns the CurrentTime field of this <code>BaseResultInfo</code> instance.
	*  @return <code>GeneralizedTime</code> object.
	*/
      public GeneralizedTime getCurrentTime() {
	 return fCurrentTime;
      }

      private int fMask = MASK_NONE;
      private ObjectClass     fObjectClass;
      private ObjectInstance  fObjectInstance;
      private GeneralizedTime fCurrentTime;
} // BaseResultInfo