This project has retired. For details please refer to its Attic page.
ObjectData xref 

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.commons.data;
20  
21  import java.util.List;
22  
23  import org.apache.chemistry.opencmis.commons.enums.BaseTypeId;
24  
25  /**
26   * Base object for CMIS documents, folders, relationships and policies.
27   * 
28   * @author <a href="mailto:fmueller@opentext.com">Florian M&uuml;ller</a>
29   * 
30   */
31  public interface ObjectData extends ExtensionsData {
32  
33      /**
34       * Returns the object id.
35       * 
36       * @return the object id or <code>null</code> if the object id is unknown
37       */
38      String getId();
39  
40      /**
41       * Returns the base object type.
42       * 
43       * @return the base object type or <code>null</code> if the base object type
44       *         is unknown
45       */
46      BaseTypeId getBaseTypeId();
47  
48      /**
49       * Returns the object properties. The properties can be incomplete if a
50       * property filter was used.
51       * 
52       * @return the properties or <code>null</code> if no properties are known
53       */
54      Properties getProperties();
55  
56      /**
57       * Returns the allowable actions.
58       * 
59       * @return the allowable actions or <code>null</code> if the allowable
60       *         actions are unknown
61       */
62      AllowableActions getAllowableActions();
63  
64      /**
65       * Returns the relationships from and to this object.
66       * 
67       * @return the list of relationship objects or <code>null</code> if no
68       *         relationships exist or the relationships are unknown
69       */
70      List<ObjectData> getRelationships();
71  
72      /**
73       * Returns the change event infos.
74       * 
75       * @return the change event infos or <code>null</code> if the infos are
76       *         unknown
77       */
78      ChangeEventInfo getChangeEventInfo();
79  
80      /**
81       * Returns the access control list.
82       * 
83       * @return the access control list or <code>null</code> if the access
84       *         control list is unknown
85       */
86      Acl getAcl();
87  
88      /**
89       * Returns if the access control list reflects the exact permission set in
90       * the repository.
91       * 
92       * @return <code>true<code> - exact; <code>false</code> - not exact, other
93       *         permission constraints exist; <code>null</code> - unknown
94       */
95      Boolean isExactAcl();
96  
97      /**
98       * Returns the ids of the applied policies.
99       * 
100      * @return the policy ids or <code>null</code> if no policies are applied or
101      *         the ids are unknown
102      */
103     PolicyIdList getPolicyIds();
104 
105     /**
106      * Returns the renditions of this object.
107      * 
108      * @return the list of renditions (might be empty) or <code>null</code> if
109      *         no renditions exist or the renditions are unknown
110      */
111     List<RenditionData> getRenditions();
112 }