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 *     Nuxeo - initial API and implementation
018 *
019 * $Id$
020 */
021package org.nuxeo.ecm.core.schema;
022
023/**
024 * Defines base facet names used in the core.
025 *
026 * @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
027 */
028public final class FacetNames {
029
030    public static final String IMMUTABLE = "Immutable";
031
032    /**
033     * Document may have children
034     */
035    public static final String FOLDERISH = "Folderish";
036
037    /**
038     * It will make it possible to create versions for this document type
039     */
040    public static final String VERSIONABLE = "Versionable";
041
042    /**
043     * If your Nuxeo target version is 5.3.2 or higher, you'll be able to manage the order of this document children
044     */
045    public static final String ORDERABLE = "Orderable";
046
047    /**
048     * The download link will be displayed in consistent places of the application
049     */
050    public static final String DOWNLOADABLE = "Downloadable";
051
052    /**
053     * The document type will be available in the seam context as variable "currentSuperSpace" when navigating in its
054     * children documents
055     */
056    public static final String SUPER_SPACE = "SuperSpace";
057
058    /**
059     * The publishing tab will be displayed on the document (unless you forbid the display of the publishing tab in the
060     * tabs filtering section)
061     */
062    public static final String PUBLISHABLE = "Publishable";
063
064    /**
065     * The document will be flagged as able to receive publications (and will be displayed in the publication tree).
066     */
067    public static final String PUBLISH_SPACE = "PublishSpace";
068
069    /**
070     * The document will be flagged as a container for documents able to receive publications (and will be displayed as
071     * a root in the available publication trees)
072     */
073    public static final String MASTER_PUBLISH_SPACE = "MasterPublishSpace";
074
075    /**
076     * It will display the comment tab and the comments associated to the document instance in the summary tab
077     */
078    public static final String COMMENTABLE = "Commentable";
079
080    /**
081     * The document type won't appear in the tree and in the folder content listing
082     */
083    public static final String HIDDEN_IN_NAVIGATION = "HiddenInNavigation";
084
085    /**
086     * The document type corresponds to a system document, not a user-visible document. It is often (but not always)
087     * hidden in navigation as well.
088     */
089    public static final String SYSTEM_DOCUMENT = "SystemDocument";
090
091    /**
092     * The document won't be full-text indexed.
093     *
094     * @since 5.7
095     */
096    public static final String NOT_FULLTEXT_INDEXABLE = "NotFulltextIndexable";
097
098    @Deprecated
099    public static final String BROWSE_VIA_SEARCH = "BrowseViaSearch";
100
101    /**
102     * Facet to be used for full-text indexing of related text content (e.g. comments, annotations, tags...)
103     */
104    public static final String HAS_RELATED_TEXT = "HasRelatedText";
105
106    private FacetNames() {
107    }
108
109}