com.hp.autonomy.aci.content.identifier.DocumentIdentifiers Maven / Gradle / Ivy

Go to download

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

API for representing aspects of IDOL's Content server, including FieldText and document References

The newest version!

/*
 * Copyright 2009-2015 Open Text.
 *
 * 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 Open Text and its affiliates
 * and licensors ("Open Text") 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. Open Text 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.hp.autonomy.aci.content.identifier;

/**
 * {@code DocumentIdentifiers} can be used to identify documents in a query or getcontent action, as
 * well as in a DREREPLACE.
 *
 * Example 1, filtering out documents:
 *
 * 
 *    DocumentIdentifiers identifiers = ...;
 *
 *    ActionParameters parameters = new ActionParameters("query");
 *    parameters.add("text", "*");
 *    parameters.add(identifiers.getDontMatchParameterName(), identifiers);
 * 
 *
 * Example 2, using getcontent:
 *
 *  *    DocumentIdentifiers identifiers = ...;
 *
 *    ActionParameters parameters = new ActionParameters("getcontent");
 *    parameters.add(identifiers.getGetContentParameterName(), identifiers);
 * 
 */
public interface DocumentIdentifiers extends QueryIdentifiers {
    String DONT_MATCH_ID = "dontmatchid";
    String DONT_MATCH_REFERENCE = "dontmatchreference";
    String STATE_DONT_MATCH_ID = "statedontmatchid";

    String ID = "id";
    String REFERENCE = "reference";
    String STATE_ID = "stateid";

    /**
     * The name of the getcontent ACI parameter to use for this set of identifiers, such as reference.
     *
     * @return The getcontent parameter name
     */
    String getGetContentParameterName();

    /**
     * The name of the 'dontmatch' parameter to use for this set of identifiers, such as dontmatchreference.
     *
     * @return The 'dontmatch' parameter name
     */
    String getDontMatchParameterName();
}