001/*
002 * (C) Copyright 2010 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 * Contributors:
016 * Nuxeo - initial API and implementation
017 */
018
019package org.nuxeo.ecm.platform.rendition;
020
021/**
022 * Constants used by the {@link org.nuxeo.ecm.platform.rendition.service.RenditionService}.
023 *
024 * @author <a href="mailto:troger@nuxeo.com">Thomas Roger</a>
025 * @since 5.4.1
026 */
027public class Constants {
028
029    private Constants() {
030        // Constants class
031    }
032
033    public static final String RENDITION_FACET = "Rendition";
034
035    public static final String FILES_SCHEMA = "files";
036
037    public static final String FILES_FILES_PROPERTY = "files:files";
038
039    public static final String RENDITION_SCHEMA = "rendition";
040
041    // version from which the rendition was derived (or live doc if not versionable)
042    public static final String RENDITION_SOURCE_ID_PROPERTY = "rend:sourceId";
043
044    // live doc if the rendition was derived from a versionable doc, otherwise null
045    public static final String RENDITION_SOURCE_VERSIONABLE_ID_PROPERTY = "rend:sourceVersionableId";
046
047    // date the source doc was modified according to property named
048    // RenditionDefinition#sourceDocumentModificationDatePropertyName
049    public static final String RENDITION_SOURCE_MODIFICATION_DATE_PROPERTY = "rend:sourceModificationDate";
050
051    public static final String RENDITION_NAME_PROPERTY = "rend:renditionName";
052
053    /**
054     * Rendition variant property name.
055     *
056     * @since 8.1
057     */
058    public static final String RENDITION_VARIANT_PROPERTY = "rend:renditionVariant";
059
060    /**
061     * Rendition variant property value prefix for a user.
062     *
063     * @since 8.1
064     */
065    public static final String RENDITION_VARIANT_PROPERTY_USER_PREFIX = "user:";
066
067    /**
068     * Rendition variant property value for an administrator.
069     *
070     * @since 8.1
071     */
072    public static final String RENDITION_VARIANT_PROPERTY_ADMINISTRATOR_USER = "administratoruser:";
073
074}