001/*
002 * (C) Copyright 2006-2011 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 *     Florent Guillaume
018 */
019package org.nuxeo.ecm.core.trash;
020
021import java.io.Serializable;
022import java.util.List;
023import java.util.Set;
024
025import org.nuxeo.common.utils.Path;
026import org.nuxeo.ecm.core.api.DocumentModel;
027import org.nuxeo.ecm.core.api.DocumentRef;
028
029/**
030 * Info about the deletion/purge/undeletion of a list of document.
031 */
032public class TrashInfo implements Serializable {
033
034    private static final long serialVersionUID = 1L;
035
036    /** Docs found ok. */
037    public List<DocumentModel> docs;
038
039    /** Refs of common tree roots of docs found ok. */
040    public List<DocumentRef> rootRefs;
041
042    /** Paths of common tree roots of docs found ok. */
043    public Set<Path> rootPaths;
044
045    /** Refs of parents of common tree roots of docs found ok. */
046    public Set<DocumentRef> rootParentRefs;
047
048    /** Number of docs not ok due to permissions or lifecycle state. */
049    public int forbidden;
050
051    /** Number of docs not ok due to lock status. */
052    public int locked;
053
054    /** Number of docs not ok due to being proxies. */
055    public int proxies;
056
057}