org.apache.chemistry.opencmis.client.api.DocumentProperties Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.chemistry.opencmis.client.api;

/**
 * Accessors to CMIS document properties.
 * 
 * @see CmisObjectProperties
 */
public interface DocumentProperties {

    /**
     * Returns true if this CMIS object is immutable (CMIS property
     * cmis:isImmutable).
     * 
     * @cmis 1.0
     */
    Boolean isImmutable();

    /**
     * Returns if this CMIS object is the latest version (CMIS property
     * cmis:isLatestVersion).
     * 
     * @cmis 1.0
     */
    Boolean isLatestVersion();

    /**
     * Returns true if this CMIS object is the latest version (CMIS
     * property cmis:isMajorVersion).
     * 
     * @cmis 1.0
     */
    Boolean isMajorVersion();

    /**
     * Returns true if this CMIS object is the latest major version
     * (CMIS property cmis:isLatestMajorVersion).
     * 
     * @cmis 1.0
     */
    Boolean isLatestMajorVersion();

    /**
     * Returns true if this CMIS object is the PWC (CMIS property
     * cmis:isPrivateWorkingCopy).
     * 
     * @cmis 1.0
     */
    Boolean isPrivateWorkingCopy();

    /**
     * Returns the version label (CMIS property cmis:versionLabel).
     * 
     * @cmis 1.0
     */
    String getVersionLabel();

    /**
     * Returns the version series id (CMIS property
     * cmis:versionSeriesId).
     * 
     * @cmis 1.0
     */
    String getVersionSeriesId();

    /**
     * Returns true if this version series is checked out (CMIS
     * property cmis:isVersionSeriesCheckedOut).
     * 
     * @cmis 1.0
     */
    Boolean isVersionSeriesCheckedOut();

    /**
     * Returns the user who checked out this version series (CMIS property
     * cmis:versionSeriesCheckedOutBy).
     * 
     * @cmis 1.0
     */
    String getVersionSeriesCheckedOutBy();

    /**
     * Returns the PWC id of this version series (CMIS property
     * cmis:versionSeriesCheckedOutId).
     */
    String getVersionSeriesCheckedOutId();

    /**
     * Returns the checkin comment (CMIS property
     * cmis:checkinComment).
     * 
     * @cmis 1.0
     */
    String getCheckinComment();

    /**
     * Returns the content stream length or -1 if the document has no content
     * (CMIS property cmis:contentStreamLength).
     * 
     * @cmis 1.0
     */
    long getContentStreamLength();

    /**
     * Returns the content stream MIME type or null if the document
     * has no content (CMIS property cmis:contentStreamMimeType).
     * 
     * @cmis 1.0
     */
    String getContentStreamMimeType();

    /**
     * Returns the content stream filename or null if the document
     * has no content (CMIS property cmis:contentStreamFileName).
     * 
     * @cmis 1.0
     */
    String getContentStreamFileName();

    /**
     * Returns the content stream id or null if the document has no
     * content (CMIS property cmis:contentStreamId).
     * 
     * @cmis 1.0
     */
    String getContentStreamId();
}