attributeiderror.java

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

/*
 * 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:          AttributeIdError.java
//  Project:	   
//  Author(s):     Eric DILLON
//  Creation:      01.04.1998
//  Last modified: 09.04.1998
//
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//
//  CVS Info
//---------------------------------------------------------------------------//
//
//  $Id: AttributeIdError.java,v 1.2 2000/09/05 13:30:29 festor Exp $
//  $Source: /local/resedas/CVS-Repository/CmisJavaApi/src/fr/dyade/cmis/api/types/AttributeIdError.java,v $

//---------------------------------------------------------------------------//
//  Todo
//---------------------------------------------------------------------------//
//

package fr.dyade.cmis.api.types;

/**
  *  Java representation of an ASN.1 AttributeId Error.
  *  <p>
  *  This type is used within <code>GetInfoStatus</code> object in case of "attribute Id errors"
  * <p>
  *  Two kinds of error are defined here:
  * <menu>
  *    <li>ACCESSDENIED,
  *    <li>NOSUCH_ATTRIBUTE.
  * </menu>
  * <strong>Here again this object is build from C-code through JNI.</strong>
  * @see fr.dyade.cmis.api.types.GetInfoStatus
  */
public class AttributeIdError   extends CMISType {
      public final static short ACCESSDENIED = 2;
      public final static short NOSUCH_ATTRIBUTE = 5;
      
      private AttributeIdError(AttributeId pAttributeId, short pErrorStatus) {
	 fAttributeId = pAttributeId;
	 fErrorStatus = pErrorStatus;
      }
      
      public static AttributeIdError ACCESSDENIED(AttributeId pAttributeId) {
	 return new AttributeIdError(pAttributeId, ACCESSDENIED);
      }
      
      public static AttributeIdError NOSUCH_ATTRIBUTE(AttributeId pAttributeId) {
	 return new AttributeIdError(pAttributeId, NOSUCH_ATTRIBUTE);
      }
      
      /** Basic constructor.
	* dedicated to C level mappers responsible for filling the object
	* in a proper way.
	*/
      private  AttributeIdError(){}
      /**
	*  Returns the ErrorStatus for this <code>AttributeIdError</code>. Defined values are ACCESSDENIED, and NOSUCH_ATTRIBUTE.
	*  @return The errorStatus for this <code>AttributeIdError</code>
	*/
      public short getErrorStatus() {
	 return fErrorStatus;
      }
      
      /**
	*  Returns a Java representation of the <code>AttributeIdError</code>. For debug purpose.
	* @return A <code>String</code> explaining the <code>AttributeIdError</code>
	*/
      public String toString() {
	 return (fErrorStatus == ACCESSDENIED)
	    ? "ACCESSDENIED:" + fAttributeId.toString() 
	    : "NOSUCH_ATTRIBUTE:" + fAttributeId.toString();
      }
      
      private short fErrorStatus;
      private AttributeId fAttributeId;
} // AttributeIdError