framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/system/DeleteQueuedDocument.java

/* $Id: DeleteQueuedDocument.java 988245 2010-08-23 18:39:35Z kwright $ */

/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.manifoldcf.crawler.system;

import org.apache.manifoldcf.core.interfaces.*;
import org.apache.manifoldcf.agents.interfaces.*;
import org.apache.manifoldcf.crawler.interfaces.*;

/** This class represents a document that will be placed on the document delete queue, and will be
* processed by a delete or expire worker thread.
* The reason that DocumentDescription by itself is not used has to do with the fact that
* a good deal more information about the document must be obtained in order to find the
* last version ingested (which must be done in bulk, for performance reasons).  Since we
* are finding everything anyway, it makes sense to put what we have in a structure so
* that the worker threads don't need to repeat what the stuffer thread did.
*/
public class DeleteQueuedDocument
{
  public static final String _rcsid = "@(#)$Id: DeleteQueuedDocument.java 988245 2010-08-23 18:39:35Z kwright $";

  /** The document description. */
  protected DocumentDescription documentDescription;
  /** This flag indicates whether the document has been processed or not. */
  protected boolean wasProcessed = false;

  /** Constructor.
  *@param documentDescription is the document description.
  */
  public DeleteQueuedDocument(DocumentDescription documentDescription)
  {
    this.documentDescription = documentDescription;
  }

  /** Get the document description.
  *@return the document description.
  */
  public DocumentDescription getDocumentDescription()
  {
    return documentDescription;
  }

  /** Check if document has been processed yet.
  *@return true if processed, false if not.
  */
  public boolean wasProcessed()
  {
    return wasProcessed;
  }

  /** Note that the document was processed in some way.
  */
  public void setProcessed()
  {
    wasProcessed = true;
  }

}