listerror.java

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

/*
 * 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: ListError.java,v 1.2 2000/09/05 13:30:48 festor Exp $
//

//---------------------------------------------------------------------------//
//  Todo
//---------------------------------------------------------------------------//
// Check meaningness (or less) of baseinfo stuff.
// 

package fr.dyade.cmis.api.types;

// Java related packages
import java.util.Vector;
import java.util.Enumeration;

/**
  *  Java base class for both <code>SetListError</code> and <code>GetListError</code>.
  * <p>
  * It holds a <code>BaseResultInfo</code> which provides access to <code>ObjectClass</code>, 
  * <code>ObjectInstance</code> and <code>CurrentTime</code> related to the 
  * <code>Set/GetListError</code>. (These arguments are also available from both <code>Set/GetConfirmation</code>).
  *
  * @see fr.dyade.cmis.api.types.SetListError
  * @see fr.dyade.cmis.api.types.GetListError
  * @see fr.dyade.cmis.api.operation.SetConfirmation
  * @see fr.dyade.cmis.api.operation.GetConfirmation
  *
  * TODO: remove BaseResultInfo stuff. This type should just implement what is needed at the CMIS service level.
  *       ManageObjectClass, ManagedObjectInstance, and CurrentTime are supposed to come from
  *       some other parameters (within response/confirmation). 
  *       This type is not exactly the one in X711 (CMIP protocl level), it rather the implementation
  *       of Open Master fmk-c-api's one.
  * @version cvs $Id: ListError.java,v 1.2 2000/09/05 13:30:48 festor Exp $
  */
public abstract class ListError extends CMISType {
      /**
	* Allows to set the <code>BaseResultInfo</code> for the current <code>Set/GetResponse</code>.
	* <strong>This method should only be called from a agent application. Otherwise, within a manager application, this method is called from C-code through JNI.</strong>
	* @param pBaseResultInfo The <code>BaseResultInfo</code> to set.
	*/
      public void setBaseResultInfo(BaseResultInfo pBaseResultInfo) {
	 fBaseResultInfo = pBaseResultInfo;
      }
      
      /** 
	* Returns <code>BaseResultInfo</code>, which holds <code>ObjectClass</code>, <code>ObjectInstance</code> 
	* and <code>CurrentTime</code> related to the <code>Set/GetListError</code>.
	* @return BaseResultInfo for the current <code>Set/GetResponse</code>
	*/
      public BaseResultInfo getBaseResultInfo() {
	 return fBaseResultInfo;
      }
      
      /**
	*  Returns an <code>Enumeration</code> of the <code>InfoStatus</code> elements of the <code>ListError</code>.
	*  @return Enumeration of the <code>InfoStatus</code> list.
	*/
      public Enumeration getInfoStatus() {
	 return fInfoStatus.elements();
      }
      /** Emptyness test.
	* @return true if the list is empty.
	*/
      public final boolean isEmpty() {
	 return fInfoStatus.isEmpty();
      }
      /**
	* Return a <code>String</code> representation of the <code>ListError</code>.
	* This method provides an easy way to print debug informations.
	* @return  a <code>String</code> representation of the <code>ListError</code>.
	*/
      public String toString() {
	 String res="[";
	 for(Enumeration e = fInfoStatus.elements(); e.hasMoreElements();) {
	    res += e.nextElement().toString();
	    if (e.hasMoreElements()) {
	       res+="; ";
	    }
	 }
	 return res+"]"; 
      }
      
      protected BaseResultInfo fBaseResultInfo;
      protected Vector fInfoStatus = new Vector();
      
} // ListError