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 org.apache.chemistry.opencmis.commons.data.PropertyData;
22 import org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition;
23 import org.apache.chemistry.opencmis.commons.enums.PropertyType;
24
25 /**
26 * CMIS Property.
27 */
28 public interface Property<T> extends PropertyData<T> {
29
30 /**
31 * Returns if the property is a multi-value property.
32 *
33 * @return {@code true} if the property is multi-value property,
34 * {@code false} if the property is single-value property,
35 */
36 boolean isMultiValued();
37
38 /**
39 * Returns the property data type.
40 *
41 * @return the data type of the property, not {@code null}
42 */
43 PropertyType getType();
44
45 /**
46 * Returns the property definition.
47 *
48 * @return the property definition, not {@code null}
49 */
50 PropertyDefinition<T> getDefinition();
51
52 /**
53 * Returns the property value (single or multiple).
54 *
55 * @return the property value or {@code null} if the property value isn't
56 * set
57 */
58 <U> U getValue();
59
60 /**
61 * Returns a human readable representation of the property value. If the
62 * property is multi-value property, only the first value will be returned.
63 *
64 * @return the (first) property value as a string or {@code null} if the
65 * property value isn't set
66 */
67 String getValueAsString();
68
69 /**
70 * Returns a human readable representation of the property values.
71 *
72 * @return the property value as a string or {@code null} if the property
73 * value isn't set
74 */
75 String getValuesAsString();
76 }