PseudoFileInterface


1   /*
2    * Copyright (C) 2005 Alfresco, Inc.
3    *
4    * Licensed under the Mozilla Public License version 1.1 
5    * with a permitted attribution clause. You may obtain a
6    * copy of the License at
7    *
8    *   http://www.alfresco.org/legal/license.txt
9    *
10   * Unless required by applicable law or agreed to in writing,
11   * software distributed under the License is distributed on an
12   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific
14   * language governing permissions and limitations under the
15   * License.
16   */
17  
18  package org.alfresco.filesys.smb.server.repo.pseudo;
19  
20  import org.alfresco.filesys.server.SrvSession;
21  import org.alfresco.filesys.server.filesys.TreeConnection;
22  
23  /**
24   * Pseudo File Interface
25   * 
26   * <p>Provides the ability to add files into the file listing of a folder.
27   * 
28   * @author gkspencer
29   */
30  public interface PseudoFileInterface
31  {
32      /**
33       * Check if the specified path refers to a pseudo file
34       * 
35       * @param sess SrvSession
36       * @param tree TreeConnection
37       * @param path String
38       * @return boolean
39       */
40      public boolean isPseudoFile(SrvSession sess, TreeConnection tree, String   path);
41  
42      /**
43       * Return the pseudo file for the specified path, or null if the path is not a pseudo file
44       * 
45       * @param sess SrvSession
46       * @param tree TreeConnection
47       * @param path String
48       * @return PseudoFile
49       */
50      public PseudoFile getPseudoFile(SrvSession sess, TreeConnection tree, String   path);
51      
52      /**
53       * Add pseudo files to a folder so that they appear in a folder search
54       * 
55       * @param sess SrvSession
56       * @param tree TreeConnection
57       * @param path String
58       * @return int
59       */
60      public int addPseudoFilesToFolder(SrvSession sess, TreeConnection tree, String   path);
61      
62      /**
63       * Delete a pseudo file
64       * 
65       * @param sess SrvSession
66       * @param tree TreeConnection
67       * @param path String
68       */
69      public void deletePseudoFile(SrvSession sess, TreeConnection tree, String   path);
70  }
71
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags