com.autonomy.nonaci.indexing.impl.DreCreateDBaseCommand 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;

import org.apache.commons.lang3.BooleanUtils;

/**
 * Allows you to create a new database in IDOL server (for example, to store documents that related to one particular 
 * subject or to store documents that are relevant to a particular user group).
 *
 * @author boba
 */
public class DreCreateDBaseCommand extends IndexCommandImpl {

    /** Creates a new instance of DreCreateDBaseCommand. */
    public DreCreateDBaseCommand() {
        super(CMD_DRECREATEDBASE);
    }
    
    public String getDreDbName() {
        return get(PARAM_DRE_DBNAME);
    }

    /**
     * The name of the database that you want to create in IDOL server. Once the command has been executed, the new 
     * database is listed in the IDOL server configuration file.
     * 
     * @param dreDbName The database to be created. Required
     */
    public void setDreDbName(final String dreDbName) {
        put(PARAM_DRE_DBNAME, dreDbName);
    }
    
    public boolean isInternal() {
        return BooleanUtils.toBoolean(get(PARAM_INTERNAL));
    }

    /**
     * Specify true to create an internal database. 
     * 
     * @param internal Specifies if the database is internal.
     */
    public void setInternal(final boolean internal) {
        put(PARAM_INTERNAL, BooleanUtils.toStringTrueFalse(internal));
    }
    
    public boolean isReadOnly() {
        return BooleanUtils.toBoolean(get(PARAM_READ_ONLY));
    }

    /**
     * Specify true to create a database that is read-only. 
     * 
     * @param readOnly Specifies if the database is read-only. 
     */
    public void setReadOnly(final boolean readOnly) {
        put(PARAM_READ_ONLY, BooleanUtils.toStringTrueFalse(readOnly));
    }

} // End of class DreCreateDBaseCommand...