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:grenard@nuxeo.com">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 COLLECTABLE_FACET = "CollectionMember";
027
028    public static final String NOT_COLLECTABLE_FACET = "NotCollectionMember";
029
030    public static final String COLLECTION_FACET = "Collection";
031
032    public static final String COLLECTION_TYPE = "Collection";
033
034    public static final String COLLECTION_DOCUMENT_IDS_PROPERTY_NAME = "collection:documentIds";
035
036    public static final String DOCUMENT_COLLECTION_IDS_PROPERTY_NAME = "collectionMember:collectionIds";
037
038    public static final String COLLECTION_SCHEMA_NAME = "collection";
039
040    public static final String COLLECTION_MEMBER_SCHEMA_NAME = "collectionMember";
041
042    public static final String CAN_COLLECT_PERMISSION = "ReadCanCollect";
043
044    public static final String COLLECTION_PAGE_PROVIDER = "default_collection";
045
046    /**
047     * @since 8.3
048     */
049    public static final String USER_COLLECTION_PAGE_PROVIDER = "user_collections";
050
051    public static final String MAGIC_PREFIX_ID = "-999999";
052
053    public static final String DEFAULT_COLLECTIONS_NAME = "Collections";
054
055    public static final String DEFAULT_COLLECTIONS_TITLE = "label.myCollections.title";
056
057    public static final String COLLECTIONS_TYPE = "Collections";
058
059    public static final String COLLECTION_QUEUE_ID = "collections";
060
061    public static final int DEFAULT_COLLECTION_RETURNED = 10;
062
063    public static final int MAX_COLLECTION_RETURNED = 100;
064
065    public static final String COLLECTION_CONTENT_PAGE_PROVIDER = "default_content_collection";
066
067    /**
068     * @since 8.4
069     */
070    public static final String ORDERED_COLLECTION_CONTENT_PAGE_PROVIDER = "ordered_content_collection";
071
072    /**
073     * @since 6.0
074     */
075    public static final String ALL_COLLECTIONS_PAGE_PROVIDER = "all_collections";
076
077    // Event names
078    /**
079     * @since 6.0
080     */
081    public static final String BEFORE_ADDED_TO_COLLECTION = "beforeAddedToCollection";
082
083    /**
084     * @since 6.0
085     */
086    public static final String ADDED_TO_COLLECTION = "addedToCollection";
087
088    /**
089     * @since 6.0
090     */
091    public static final String BEFORE_REMOVED_FROM_COLLECTION = "beforeRemovedFromCollection";
092
093    /**
094     * @since 6.0
095     */
096    public static final String REMOVED_FROM_COLLECTION = "removedFromCollection";
097
098    /**
099     * @since 6.0
100     */
101    public static final String COLLECTION_REF_EVENT_CTX_PROP = "collectionRef";
102
103}