ResourceXmlPropertyEmitterInterface.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.resource;

public interface ResourceXmlPropertyEmitterInterface {

  /**
   * Allows injection of additional relevant properties in the to-xml of the Resource Reference.
   *
   * @param ref
   *          The Resource Reference Holder (a step, or a job entry)
   * @param indention
   *          If -1, then no indenting, otherwise, it's the indent level to indent the XML strings
   * @return String of injected XML
   */
  public String getExtraResourceProperties( ResourceHolderInterface ref, int indention );

}