com.marklogic.developer.corb.Task Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of marklogic-corb Show documentation

CoRB is a Java tool designed for bulk content-reprocessing of documents stored in MarkLogic.

There is a newer version: 2.5.6

/*
 * Copyright (c) 2004-2021 MarkLogic Corporation
 *
 * Licensed 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.
 *
 * The use of the Apache License does not indicate that this project is
 * affiliated with the Apache Software Foundation.
 */
package com.marklogic.developer.corb;

import java.util.concurrent.Callable;
import java.util.Properties;
import java.util.TimeZone;

/**
 * @author Bhagat Bandlamudi, MarkLogic Corporation
 */
public interface Task extends Callable {

	void setContentSourcePool(ContentSourcePool csp);

	/**
	 * INIT-MODULE,PRE-BATCH-MODULE,PROCESS-MODULE,POST-BATCH-MODULE
	 *
	 * @param moduleType
	 */
	void setModuleType(String moduleType);

	void setModuleURI(String moduleURI);

	void setAdhocQuery(String adhocQuery);

	void setQueryLanguage(String language);

    void setTimeZone(TimeZone timeZone);

	/**
	 * If additional data is sent from CUSTOM URI module, it is available in
	 * properties with key @{value #URIS_BATCH_REF}
	 *
	 * @param props
	 */
	void setProperties(Properties props);

	void setInputURI(String... inputUri);

	void setFailOnError(boolean failOnError);

	void setExportDir(String exportFileDir);
}