001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl-2.1.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     <a href="mailto:grenard@nuxeo.com">Guillaume</a>
016 */
017package org.nuxeo.ecm.collections.api;
018
019/**
020 * @since 5.9.3
021 */
022public class CollectionConstants {
023
024    public static final String COLLECTABLE_FACET = "CollectionMember";
025
026    public static final String NOT_COLLECTABLE_FACET = "NotCollectionMember";
027
028    public static final String COLLECTION_FACET = "Collection";
029
030    public static final String COLLECTION_TYPE = "Collection";
031
032    public static final String COLLECTION_DOCUMENT_IDS_PROPERTY_NAME = "collection:documentIds";
033
034    public static final String DOCUMENT_COLLECTION_IDS_PROPERTY_NAME = "collectionMember:collectionIds";
035
036    public static final String COLLECTION_SCHEMA_NAME = "collection";
037
038    public static final String COLLECTION_MEMBER_SCHEMA_NAME = "collectionMember";
039
040    public static final String CAN_COLLECT_PERMISSION = "ReadCanCollect";
041
042    public static final String COLLECTION_PAGE_PROVIDER = "default_collection";
043
044    public static final String MAGIC_PREFIX_ID = "-999999";
045
046    public static final String DEFAULT_COLLECTIONS_NAME = "Collections";
047
048    public static final String DEFAULT_COLLECTIONS_TITLE = "label.myCollections.title";
049
050    public static final String COLLECTIONS_TYPE = "Collections";
051
052    public static final String COLLECTION_QUEUE_ID = "collections";
053
054    public static final int DEFAULT_COLLECTION_RETURNED = 10;
055
056    public static final int MAX_COLLECTION_RETURNED = 100;
057
058    public static final String COLLECTION_CONTENT_PAGE_PROVIDER = "default_content_collection";
059
060    /**
061     * @since 6.0
062     */
063    public static final String ALL_COLLECTIONS_PAGE_PROVIDER = "all_collections";
064
065    // Event names
066    /**
067     * @since 6.0
068     */
069    public static final String BEFORE_ADDED_TO_COLLECTION = "beforeAddedToCollection";
070
071    /**
072     * @since 6.0
073     */
074    public static final String ADDED_TO_COLLECTION = "addedToCollection";
075
076    /**
077     * @since 6.0
078     */
079    public static final String BEFORE_REMOVED_FROM_COLLECTION = "beforeRemovedFromCollection";
080
081    /**
082     * @since 6.0
083     */
084    public static final String REMOVED_FROM_COLLECTION = "removedFromCollection";
085
086    /**
087     * @since 6.0
088     */
089    public static final String COLLECTION_REF_EVENT_CTX_PROP = "collectionRef";
090
091}