com.autonomy.nonaci.indexing.impl.DreDeleteRefCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of indexing-api Show documentation

API for indexing into IDOL using Java

There is a newer version: 4.0.0

/*
 * (c) Copyright 2008-2015 Micro Focus or one of its affiliates.
 *
 * Licensed under the MIT License (the "License"); you may not use this file
 * except in compliance with the License.
 *
 * The only warranties for products and services of Micro Focus and its affiliates
 * and licensors ("Micro Focus") are as may be set forth in the express warranty
 * statements accompanying such products and services. Nothing herein should be
 * construed as constituting an additional warranty. Micro Focus shall not be
 * liable for technical or editorial errors or omissions contained herein. The
 * information contained herein is subject to change without notice.
 */
package com.autonomy.nonaci.indexing.impl;

/**
 * Allows you to delete one or more documents by their reference.
 *
 * @author boba
 */
public class DreDeleteRefCommand extends IndexCommandImpl {

    /** Creates a new instance of DreDeleteRefCommand */
    public DreDeleteRefCommand() {
        super(CMD_DREDELETEREF);
    }
    
    public String getDocs() {
        return get(PARAM_DOCS);
    }

    /**
     * Enter the escaped references of the documents that you want to delete. If you want to specify multiple 
     * references, you must separate them with plus symbols (there must be no space before or after a plus symbol).
     * 
     * @param docs The references of the documents to be deleted.
     */
    public void setDocs(final String docs) {
        put(PARAM_DOCS, docs);
    }

    public String getDreDbName() {
        return get(PARAM_DRE_DBNAME);
    }

    /**
     * Allows you to specify the name of the database which contains the documents that you want to delete. If you don't
     * specify a database and the specified document is contained in several databases, it is deleted from all of them.
     * 
     * @param dreDbName The database from which to delete the documents.
     */
    public void setDreDbName(final String dreDbName) {
        put(PARAM_DRE_DBNAME, dreDbName);
    }

    public String getField() {
        return get(PARAM_FIELD);
    }

    /**
     * The field containing the reference specified by Docs when a document has more than one 
     * reference.
     * 
     * You can specify multiple fields by separating them with commas or spaces (there must be no space before or after
     * a comma).
     * 
     * @param field The field containing the reference specified by Docs.
     */
    public void setField(final String field) {
        put(PARAM_FIELD, field);
    }

} // End of class DreDeleteRefCommand...