filteredandscopedoperation.java

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

/*
 * 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: FilteredAndScopedOperation.java,v 1.2 2000/09/05 13:04:42 festor Exp $
//

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

package fr.dyade.cmis.api.operation;

import java.util.Enumeration;
import fr.dyade.cmis.api.types.*;

/** Interface for any operation which provides filtering and scoping.  
  * This sub interface of the <tt>CMISRequest</tt> one give an abstraction
  * for CMIS operation that can handle filtering and scoping.  That mainly
  * means that such an operation has a <tt>filter/tt> and <tt>scope</tt>
  * parameters (request/indication). This operation usually has multiple
  * replies. Four CMIS parameters are grouped into this interface: filter, scope,
  * base object and its class. It makes sense as these parameters 
  * appears together and only together when they are used by an
  * operation (set, get, delete, action).
  *
  * @version cvs $Id: FilteredAndScopedOperation.java,v 1.2 2000/09/05 13:04:42 festor Exp $
  */
public interface FilteredAndScopedOperation extends CMISRequest {
      /**
	* Set the Filter parameter.
	* @param pFilter the Filter object
	*/
      void setFilter( Filter pFilter );
      
      /**
	* Get the Filter parameter.
	* @return the Filter object
	*/
      Filter getFilter() ;
      
      /**
	* Set the Scope parameter.
	* @param pScope the Scope object
	*/
      void setScope( Scope pScope ) ;
      
      /**
	* Get the Scope parameter.
	* @return the Scope object
	*/
      Scope getScope();
      
      /**
	* Set the Base object parameter.
	* @param pCalss the ObjectClass object for the base object identifier
	*/
      void  setBaseObjectClass ( ObjectClass pClass ) ;
      
      /**
	* Get the Base object class parameter.
	* @return the ObjectClass object for the base object class identifier
	*/
      ObjectClass getBaseObjectClass() ;
      
      /**
	* Set the Base object instance parameter.
	* @param pName the ObjectInstance object for the base object instance identifier
	*/
      void setBaseObject( ObjectInstance pName ) ;
      
      /**
	* Get the Base object instance parameter.
	* @return the ObjectInstance object for the base object instance identifier
	*/
      ObjectInstance getBaseObject() ;
      
      /**
	* Set the Access control parameter.
	* @param pAC the Accesscontrol object
	*/
      void setAccessControl(AccessControl pAC) ;
      
      /**
	* Set the Synchronization parameter.
	* @param pSynchro the Synchronization object
	*/
      void setSynchronization(Synchronization pSynchro);
      
      /**
	* Get the Access control parameter.
	* @return the Accesscontrol object
	*/
      AccessControl getAccessControl() ;
      
      /**
	* Set the Synchronization parameter.
	* @return the Synchronization object
	*/
      Synchronization getSynchronization() ;
      
      /** Errors raised for a possibly linked operation.
	* This accessor is mostly dedicated to (confirmed) requests 
	* involving linked replies.
	* @return An enumeration to access any error replies (confirmation).
	*/
      Enumeration getErrors() ;
      /** CMIS Errors for a possibly linked operation.
	* @return An enumeration to access any CMIS error replies (confirmation).
	*/
      Enumeration getCMISErrors();
      /** Internal  Errors for a possibly linked operation.
	* This accessor is pretty meaningless, usually internal
	* errors occurs only once for a request.
	* @return An enumeration to access any replies (confirmation) featuring an internal 
	* (stack provider) error.
	*/
      Enumeration getInternalErrors();
}