001/*
002 * (C) Copyright 2014 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 *     <a href="mailto:[email protected]">Guillaume</a>
018 */
019package org.nuxeo.ecm.collections.api;
020
021/**
022 * @since 5.9.3
023 */
024public class CollectionConstants {
025
026    public static final String DISABLE_NOTIFICATION_SERVICE = "disableNotificationService";
027
028    public static final String DISABLE_AUDIT_LOGGER = "disableAuditLogger";
029
030    public static final String COLLECTABLE_FACET = "CollectionMember";
031
032    public static final String NOT_COLLECTABLE_FACET = "NotCollectionMember";
033
034    public static final String COLLECTION_FACET = "Collection";
035
036    public static final String COLLECTION_TYPE = "Collection";
037
038    public static final String COLLECTION_DOCUMENT_IDS_PROPERTY_NAME = "collection:documentIds";
039
040    public static final String DOCUMENT_COLLECTION_IDS_PROPERTY_NAME = "collectionMember:collectionIds";
041
042    public static final String COLLECTION_SCHEMA_NAME = "collection";
043
044    public static final String COLLECTION_MEMBER_SCHEMA_NAME = "collectionMember";
045
046    public static final String CAN_COLLECT_PERMISSION = "ReadCanCollect";
047
048    public static final String COLLECTION_PAGE_PROVIDER = "default_collection";
049
050    /**
051     * @since 8.3
052     */
053    public static final String USER_COLLECTION_PAGE_PROVIDER = "user_collections";
054
055    public static final String MAGIC_PREFIX_ID = "-999999";
056
057    public static final String DEFAULT_COLLECTIONS_NAME = "Collections";
058
059    public static final String DEFAULT_COLLECTIONS_TITLE = "label.myCollections.title";
060
061    public static final String COLLECTIONS_TYPE = "Collections";
062
063    public static final String COLLECTION_QUEUE_ID = "collections";
064
065    public static final int DEFAULT_COLLECTION_RETURNED = 10;
066
067    public static final int MAX_COLLECTION_RETURNED = 100;
068
069    public static final String COLLECTION_CONTENT_PAGE_PROVIDER = "default_content_collection";
070
071    /**
072     * @since 8.4
073     */
074    public static final String ORDERED_COLLECTION_CONTENT_PAGE_PROVIDER = "ordered_content_collection";
075
076    /**
077     * @since 6.0
078     */
079    public static final String ALL_COLLECTIONS_PAGE_PROVIDER = "all_collections";
080
081    // Event names
082    /**
083     * @since 6.0
084     */
085    public static final String BEFORE_ADDED_TO_COLLECTION = "beforeAddedToCollection";
086
087    /**
088     * @since 6.0
089     */
090    public static final String ADDED_TO_COLLECTION = "addedToCollection";
091
092    /**
093     * @since 6.0
094     */
095    public static final String BEFORE_REMOVED_FROM_COLLECTION = "beforeRemovedFromCollection";
096
097    /**
098     * @since 6.0
099     */
100    public static final String REMOVED_FROM_COLLECTION = "removedFromCollection";
101
102    /**
103     * @since 6.0
104     */
105    public static final String COLLECTION_REF_EVENT_CTX_PROP = "collectionRef";
106
107}