actionerrorinfo.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: ActionErrorInfo.java,v 1.2 2000/09/05 13:30:26 festor Exp $
//  $Source: /local/resedas/CVS-Repository/CmisJavaApi/src/fr/dyade/cmis/api/types/ActionErrorInfo.java,v $

//---------------------------------------------------------------------------//
//  Todo
//---------------------------------------------------------------------------//
// This class is related to Open Master. May be it could be removed from the general api level.

package fr.dyade.cmis.api.types;

/**
  * This class representation the different kinds of CMIS errors that may arise for a CMISAction Request.
  * <p>
  * 4 action errors are supported:
  * <menu>
  *   <li> ACCESS_DENIED,
  *   <li> NO_SUCH_ACTION,
  *   <li> NOSUCH_ARGUMENT,
  *   <li> INVALIDE_ARGUMENT_VALUE
  * </menu>
  * 
  * This object is instantiated from C-code through JNI calls. As a consequence, no constructor and no
  * "set" method is provided. The user may only get informations.
  */
public class ActionErrorInfo   extends CMISType {
      private final static short STATUS_ACCESS_DENIED = 2;
      private final static short STATUS_NO_SUCH_ACTION = 9;
      private final static short STATUS_NOSUCH_ARGUMENT = 14;
      private final static short STATUS_INVALID_ARGUMENT_VALUE = 15;
      
      public final static short ACCESS_DENIED = STATUS_ACCESS_DENIED;
      public final static short NO_SUCH_ACTION = STATUS_NO_SUCH_ACTION;
      public final static short NOSUCH_ARGUMENT = STATUS_NOSUCH_ARGUMENT;
      public final static short INVALID_ARGUMENT_VALUE = STATUS_INVALID_ARGUMENT_VALUE;
      
      /** Basic constructor.
	* Mainly dedicated to mapper package.
	*/
      private ActionErrorInfo(){
	 super();
      }
      private ActionErrorInfo(ActionTypeId pActionType, short pStatus)  {
	 fActionType = pActionType;
	 fErrorStatus = pStatus;
      }
      
      private static ActionErrorInfo ACCESS_DENIED(ActionTypeId pActionType) {
	 return new ActionErrorInfo(pActionType, STATUS_ACCESS_DENIED);
      }
      
      private static ActionErrorInfo NO_SUCH_ACTION(ActionTypeId pActionType) {
	 return new ActionErrorInfo(pActionType, STATUS_NO_SUCH_ACTION);
      }
      
      private ActionErrorInfo(NoSuchArgumentAction pNoSuchArgumentAction, short pStatus) {
	 fNoSuchArgumentAction = pNoSuchArgumentAction;
	 fErrorStatus = STATUS_NOSUCH_ARGUMENT;
      }
      
      private static ActionErrorInfo NO_SUCH_ARGUMENT(NoSuchArgumentAction pNoSuchArgumentAction) {
	 return new ActionErrorInfo(pNoSuchArgumentAction, STATUS_NOSUCH_ARGUMENT);
      }
      
      private ActionErrorInfo(ActionInfo pActionInfo, short pStatus) {
	 fActionInfo = pActionInfo;
	 fErrorStatus = pStatus;
      }
  
      private static ActionErrorInfo INVALIDE_ARGUMENT_VALUE(ActionInfo pActionInfo) {
	 return new ActionErrorInfo(pActionInfo, STATUS_INVALID_ARGUMENT_VALUE);
      }
      
      /**
	*  Returns the kind of Action Error. The returned value is among the following ones:
	*  <menu>
	*    <li>  ACCESS_DENIED,
	*    <li>  NO_SUCH_ACTION, in this case, the <code>ActionType</code> is available from <a href="#getActionType()">getActionType()</a>
	*    <li>  NOSUCH_ARGUMENT, in this case, the <code>NoSuchArgumentAction</code> is available from <a href="#getNoSuchArgumentAction()">getNoSuchArgumentAction()</a>,
	*    <li>  INVALID_ARGUMENT_VALUE, in this case, the <code>ActionInfo</code> is available from <a href="#getActionInfo()">getActionInfo()</a>.
	*  </menu>
	*
	*  @return Action Error status.
	*/
      public short getActionErrorStatus() {
	 return fErrorStatus;
      }
      
      /**
	*  Returns a ActionTypeId Object when the ActionErrorStatus equals NO_SUCH_ACTION.
	* @return ActionTypeId corresponding to this action error.
	*/
      public ActionTypeId getActionType() {
	 return fActionType;
      }
      
      /**
	*  Returns a ActionInfo object when the ActionErrorStatus equals INVALID_ARGUMENT_VALUE.
	* @return ActionInfo corresponding to this action error.
	*/
      public ActionInfo getActionInfo() {
	 return fActionInfo;
      }
      
      /**
	*  Returns a NoSuchArgumentAction object when the ActionErrorStatus equals NOSUCH_ARGUMENT.
	* @return NoSuchArgumentAction corresponding to this action error.
	*/
      public NoSuchArgumentAction getNoSuchArgumentAction() {
	 return fNoSuchArgumentAction;
      }
      
      
      private ActionInfo fActionInfo;
      private ActionTypeId fActionType;
      private NoSuchArgumentAction fNoSuchArgumentAction;
      private short fErrorStatus;
      
} // ActionErrorInfo