trunk/chemistry-opencmis-server/chemistry-opencmis-server-inmemory/src/main/java/org/apache/chemistry/opencmis/inmemory/storedobj/api/Content.java

/*
 * 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.inmemory.storedobj.api;

import org.apache.chemistry.opencmis.commons.data.ContentStream;

/**
 * Interface to represent a content stream according to the CMIS spec.
 *
 */
public interface Content {

    /**
     * return true if this object has content or false if there is no content
     * attached.
     * 
     * @return true if has content otherwise false
     */
    boolean hasContent();

    /**
     * Retrieve the content of a document.
     * 
     * @param offset
     *            offset in content stream
     * @param length
     *            length of content to return
     * 
     * @return object containing mime-type, length and a stream with content
     */
    ContentStream getContent();

    /**
     * Assign content to a document. Existing content gets overwritten. The
     * document is not yet persisted in the new state.
     * 
     * @param content
     *            content to be assigned to the document.
     */
    void setContent(ContentStream content);
}