/*
* Copyright 2013
*
* 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.
*/
package org.openntf.domino;
import org.openntf.domino.types.FactorySchema;
import org.openntf.domino.types.SessionDescendant;
/**
* The Interface DxlImporter.
*/
public interface DxlImporter extends Base<lotus.domino.DxlImporter>, lotus.domino.DxlImporter, org.openntf.domino.ext.DxlImporter,
SessionDescendant {
public static class Schema extends FactorySchema<DxlImporter, lotus.domino.DxlImporter, Session> {
@Override
public Class<DxlImporter> typeClass() {
return DxlImporter.class;
}
@Override
public Class<lotus.domino.DxlImporter> delegateClass() {
return lotus.domino.DxlImporter.class;
}
@Override
public Class<Session> parentClass() {
return Session.class;
}
};
public static final Schema SCHEMA = new Schema();
/**
* Enum to allow easy access to Document import options
*
* @since org.openntf.domino 2.5.0
*
*/
public static enum DocumentImportOption {
IGNORE(DxlImporter.DXLIMPORTOPTION_IGNORE), CREATE(DxlImporter.DXLIMPORTOPTION_CREATE), REPLACE_ELSE_CREATE(
DxlImporter.DXLIMPORTOPTION_REPLACE_ELSE_CREATE), REPLACE_ELSE_IGNORE(DxlImporter.DXLIMPORTOPTION_REPLACE_ELSE_IGNORE), UPDATE_ELSE_CREATE(
DxlImporter.DXLIMPORTOPTION_UPDATE_ELSE_CREATE), UPDATE_ELSE_IGNORE(DxlImporter.DXLIMPORTOPTION_UPDATE_ELSE_IGNORE);
private final int value_;
private DocumentImportOption(final int value) {
value_ = value;
}
public int getValue() {
return value_;
}
public static DocumentImportOption valueOf(final int value) {
for (DocumentImportOption opt : values()) {
if (opt.getValue() == value) {
return opt;
}
}
return null;
}
}
/**
* Enum to allow easy access to design element import options
*
* @since org.openntf.domino 2.5.0
*
*/
public static enum DesignImportOption {
IGNORE(DxlImporter.DXLIMPORTOPTION_IGNORE), CREATE(DxlImporter.DXLIMPORTOPTION_CREATE), REPLACE_ELSE_CREATE(
DxlImporter.DXLIMPORTOPTION_REPLACE_ELSE_CREATE), REPLACE_ELSE_IGNORE(DxlImporter.DXLIMPORTOPTION_REPLACE_ELSE_IGNORE);
private final int value_;
private DesignImportOption(final int value) {
value_ = value;
}
public int getValue() {
return value_;
}
public static DesignImportOption valueOf(final int value) {
for (DesignImportOption opt : values()) {
if (opt.getValue() == value) {
return opt;
}
}
return null;
}
}
/**
* Enum to allow easy access to ACL import settings
*
* @since org.openntf.domino 2.5.0
*
*/
public static enum AclImportOption {
IGNORE(DxlImporter.DXLIMPORTOPTION_IGNORE), REPLACE_ELSE_IGNORE(DxlImporter.DXLIMPORTOPTION_REPLACE_ELSE_IGNORE), UPDATE_ELSE_CREATE(
DxlImporter.DXLIMPORTOPTION_UPDATE_ELSE_CREATE), UPDATE_ELSE_IGNORE(DxlImporter.DXLIMPORTOPTION_UPDATE_ELSE_IGNORE);
private final int value_;
private AclImportOption(final int value) {
value_ = value;
}
public int getValue() {
return value_;
}
public static AclImportOption valueOf(final int value) {
for (AclImportOption opt : values()) {
if (opt.getValue() == value) {
return opt;
}
}
return null;
}
}
public static enum InputValidationOption {
NEVER(DxlImporter.DXLVALIDATIONOPTION_VALIDATE_NEVER), ALWAYS(DxlImporter.DXLVALIDATIONOPTION_VALIDATE_ALWAYS), AUTO(
DxlImporter.DXLVALIDATIONOPTION_VALIDATE_AUTO);
private final int value_;
private InputValidationOption(final int value) {
value_ = value;
}
public int getValue() {
return value_;
}
public static InputValidationOption valueOf(final int value) {
for (InputValidationOption opt : values()) {
if (opt.getValue() == value) {
return opt;
}
}
return null;
}
}
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getAclImportOption()
*/
@Override
public int getAclImportOption();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getCompileLotusScript()
*/
@Override
public boolean getCompileLotusScript();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getCreateFTIndex()
*/
@Override
public boolean getCreateFTIndex();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getDesignImportOption()
*/
@Override
public int getDesignImportOption();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getDocumentImportOption()
*/
@Override
public int getDocumentImportOption();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getExitOnFirstFatalError()
*/
@Override
public boolean getExitOnFirstFatalError();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getFirstImportedNoteID()
*/
@Override
public String getFirstImportedNoteID();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getImportedNoteCount()
*/
@Override
public int getImportedNoteCount();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getInputValidationOption()
*/
@Override
public int getInputValidationOption();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getLog()
*/
@Override
public String getLog();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getLogComment()
*/
@Override
public String getLogComment();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getNextImportedNoteID(java.lang.String)
*/
@Override
public String getNextImportedNoteID(final String noteid);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getReplaceDbProperties()
*/
@Override
public boolean getReplaceDbProperties();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getReplicaRequiredForReplaceOrUpdate()
*/
@Override
public boolean getReplicaRequiredForReplaceOrUpdate();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#getUnknownTokenLogOption()
*/
@Override
public int getUnknownTokenLogOption();
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#importDxl(lotus.domino.RichTextItem, lotus.domino.Database)
*/
@Override
public void importDxl(final lotus.domino.RichTextItem rtitem, final lotus.domino.Database database);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#importDxl(lotus.domino.Stream, lotus.domino.Database)
*/
@Override
public void importDxl(final lotus.domino.Stream stream, final lotus.domino.Database database);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#importDxl(java.lang.String, lotus.domino.Database)
*/
@Override
public void importDxl(final String dxl, final lotus.domino.Database database);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setAclImportOption(int)
*/
@Override
@Deprecated
public void setAclImportOption(final int option);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setCompileLotusScript(boolean)
*/
@Override
public void setCompileLotusScript(final boolean flag);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setCreateFTIndex(boolean)
*/
@Override
public void setCreateFTIndex(final boolean flag);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setDesignImportOption(int)
*/
@Override
@Deprecated
public void setDesignImportOption(final int option);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setDocumentImportOption(int)
*/
@Override
@Deprecated
public void setDocumentImportOption(final int option);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setExitOnFirstFatalError(boolean)
*/
@Override
public void setExitOnFirstFatalError(final boolean flag);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setInputValidationOption(int)
*/
@Override
@Deprecated
public void setInputValidationOption(final int option);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setLogComment(java.lang.String)
*/
@Override
public void setLogComment(final String comment);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setReplaceDbProperties(boolean)
*/
@Override
public void setReplaceDbProperties(final boolean flag);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setReplicaRequiredForReplaceOrUpdate(boolean)
*/
@Override
public void setReplicaRequiredForReplaceOrUpdate(final boolean flag);
/*
* (non-Javadoc)
*
* @see lotus.domino.DxlImporter#setUnknownTokenLogOption(int)
*/
@Override
public void setUnknownTokenLogOption(final int option);
}