001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.runtime.model.persistence;
020
021import java.io.InputStream;
022
023import org.nuxeo.runtime.model.StreamRef;
024
025/**
026 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
027 */
028public interface Contribution extends StreamRef {
029
030    /**
031     * Gets the contribution name.
032     */
033    String getName();
034
035    /**
036     * Gets the contribution description.
037     */
038    String getDescription();
039
040    /**
041     * Sets the contribution description.
042     */
043    void setDescription(String description);
044
045    /**
046     * Whether this contribution should be automatically installed at startup.
047     */
048    boolean isDisabled();
049
050    /**
051     * Sets the auto install flag for this contribution.
052     */
053    void setDisabled(boolean isAutoStart);
054
055    /**
056     * Gets the contribution XML content. The content should be in Nuxeo XML component format.
057     */
058    @Override
059    InputStream getStream();
060
061    /**
062     * Gets the contribution XML content. The content should be in Nuxeo XML component format.
063     */
064    String getContent();
065
066}