com.hp.autonomy.aci.content.identifier.QueryIdentifiers 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

There is a newer version: 4.2.0

Show newest version

/*
 * Copyright 2009-2015 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */
package com.hp.autonomy.aci.content.identifier;

/**
 * {@code QueryIdentifiers} are document identifiers that can be used to filter a query action using a 'match'
 * parameter, such as matchreference or statematchid. e.g.:
 *
 *  *    QueryIdentifiers identifiers = ...;
 *
 *    AciParameters parameters = new AciParameters("query");
 *    parameters.add("text", "*");
 *    parameters.add(identifiers.getMatchParameterName(), identifiers);
 * 
 */
public interface QueryIdentifiers extends IndexingIdentifiers {
    String DATABASE_MATCH = "databasematch";
    String MATCH_ID = "matchid";
    String MATCH_REFERENCE = "matchreference";
    String STATE_MATCH_ID = "statematchid";

    /**
     * The name of the 'match' parameter to use for this set of identifiers, such as matchreference.
     *
     * @return The query 'match' parameter name
     */
    String getMatchParameterName();

    /**
     * The string representation of this identifier, suitable for use as the value of a 'match' parameter on a
     * query action.
     *
     * @return The query 'match' parameter value
     */
    @Override
    String toString();
}