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

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

package fr.dyade.cmis.api.types;

/**
  *  Java representation of ActionInfo ASN.1 Datatype.
  *  <p> 
  *  This type is used as an argument of <code>CMISError</code> is case of "invalid Argument Action Value" error.
  *  <p>
  * <strong>All "set" methods should not be called within 
  * a manager application. Indeed, instances of this object are build from C-code through JNI.</strong>
  * @version cvs $Id: ActionInfo.java,v 1.2 2000/09/05 13:30:26 festor Exp $
  */
public class ActionInfo extends CMISType {
      /** Basic constructor
	* Mostly dedicated to native mapper.
	*/
      public ActionInfo() {
	 super();
      }

      /** Convenient constructor.
	* Build an ActionInfo without optional ActionInfoArg field.
	* @param pActionTypeId the non optionam ActionType
	*/
      public ActionInfo( ActionTypeId pActionType ) {
	  fActionType = pActionType;
      }
      /** Convenient constructor.
	* Build an ActionInfo with ActionType and ActionInfoArg fields.
	* @param pActionTypeId the non optionam ActionType
	* @param pInfoArgument the ActionInformationArg (optional can be null)
	*/
      public ActionInfo( ActionTypeId pActionType, Any pInfoArgument ) {
	 fActionType = pActionType;
	 fInfoArgument = pInfoArgument;
      }
      /**
	*  Sets the <code>ActionTypeId</code> for this <code>ActionInfo</code>
	*  @param pActionTypeId The <code>ActionTypeId</code> to set.
	*/
      public void setActionTypeId(ActionTypeId pActionTypeId) {
	 fActionType = pActionTypeId;
      }
      
      /**
	*  Returns the <code>ActionTypeId</code> of this <code>ActionInfo</code>
	* @return The <code>ActionTypeId</code> of this <code>ActionInfo</code>
	*/
      public ActionTypeId getActionTypeId(){
	 return fActionType;
      }
      
      /**
	*  Sets the InfoArgument for this <code>ActionInfo</code>
	*  @param pInfoArgument The <code>Any</code> InfoArgument to use.
	*/
      public void setInfoArgument(Any pInfoArgument){
	 fInfoArgument = pInfoArgument;
      }
      
      /**
	*  Returns the <code>Any</code> InfoArgument for this <code>ActionInfo</code>
	*  @return the <code>Any</code> InfoArgument
	*/
      public Any getInfoArgument() {
	 return fInfoArgument;
      }
      
      private ActionTypeId fActionType;
      private Any fInfoArgument;
} // ActionInfo