com.hp.autonomy.searchcomponents.hod.fields.HodFieldsRequestBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 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.searchcomponents.hod.fields;

import com.hp.autonomy.hod.client.api.resource.ResourceName;
import com.hp.autonomy.searchcomponents.core.fields.FieldsRequestBuilder;

import java.util.Collection;

/**
 * Builder for {@link HodFieldsRequest}
 */
@SuppressWarnings("unused")
public interface HodFieldsRequestBuilder extends FieldsRequestBuilder {
    /**
     * Sets The indexes from which to retrieve fields
     *
     * @param databases The indexes from which to retrieve fields
     * @return The builder (for chaining)
     */
    HodFieldsRequestBuilder databases(Collection databases);

    /**
     * Sets an index from which to retrieve fields
     *
     * @param database An index from which to retrieve fields
     * @return The builder (for chaining)
     */
    HodFieldsRequestBuilder database(ResourceName database);

    /**
     * Clears the collection of indexes from which to retrieve fields
     *
     * @return The builder (for chaining)
     */
    HodFieldsRequestBuilder clearDatabases();
}