View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   * http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.chemistry.opencmis.client.api;
20  
21  import java.util.List;
22  
23  /**
24   * Accessors to CMIS folder properties.
25   * 
26   * @see CmisObjectProperties
27   */
28  public interface FolderProperties {
29  
30      /**
31       * Returns the parent id or {@code null} if the folder is the root folder
32       * (CMIS property {@code cmis:parentId}).
33       * 
34       * @return the property value or {@code null} if the property hasn't been
35       *         requested, hasn't been provided by the repository, or the folder
36       *         is the root folder
37       * 
38       * @cmis 1.0
39       */
40      String getParentId();
41  
42      /**
43       * Returns the list of the allowed object types in this folder (CMIS
44       * property {@code cmis:allowedChildObjectTypeIds}). If the list is empty or
45       * {@code null} all object types are allowed.
46       * 
47       * @return the property value or {@code null} if the property hasn't been
48       *         requested, hasn't been provided by the repository, or the
49       *         property value isn't set
50       * 
51       * @cmis 1.0
52       */
53      List<ObjectType> getAllowedChildObjectTypes();
54  }