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