DeferredProgram.java

/*
** Module   : DeferredProgram.java
** Abstract : Implements the deferred program configuration, for SINGLE-RUN or SINGLETON modes.
**
** Copyright (c) 2019, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 CA  20190628 Created initial version.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.util;

/**
 * A deferred program is a configuration saved when a <code>RUN ... {SINGLETON|SINGLE-RUN}</code> 
 * statement is executed.
 * <p>
 * This saves the target, mode and any remote server configuration specified at the RUN statement.
 */
public class DeferredProgram
{
   /** The target of the RUN statement. */
   private String name;
   
   /** The remote server configuration (may be <code>null</code>). */
   private ServerImpl server;
   
   /** Flag indicating if the TRANSACTION-DISTINCT option was used. */
   private boolean transactionDistinct;
   
   /** When <code>true</code>, SINGLETON mode is used. */
   private boolean singleton;
   
   /** When <code>true</code>, SINGLE-RUN mode is used. */
   private boolean singleRun;

   /**
    * Create a new deferred configuration for the given program.
    * 
    * @param    name
    *           The program name.
    */
   public DeferredProgram(String name)
   {
      this.name = name;
   }

   /**
    * Create a new deferred configuration for the given program and remote server.
    * 
    * @param    name
    *           The program name.
    * @param    s
    *           The server configuration.
    * @param    transactionDistinct
    *           Flag indicating if TRANSACTION-DISTINCT option is set.
    */
   public DeferredProgram(String name, ServerImpl s, boolean transactionDistinct)
   {
      this.name = name;
      this.server = s;
      this.transactionDistinct = transactionDistinct;
   }

   /**
    * Get the {@link #server} instance.
    * 
    * @return  See above.
    */
   public ServerImpl getServer()
   {
      return server;
   }

   /**
    * Get the external program {@link #name}.
    * 
    * @return   See above.
    */
   public String getName()
   {
      return name;
   }
   
   /**
    * Get the {@link #transactionDistinct} flag.
    * 
    * @return   See above.
    */
   public boolean isTransactionDistinct()
   {
      return transactionDistinct;
   }

   /**
    * Get the {@link #singleRun} state.
    * 
    * @return   See above.
    */
   public boolean isSingleRun()
   {
      return singleRun;
   }

   /**
    * Set the {@link #singleRun} state.
    * 
    * @param    singleRun
    *           Flag indicating the SINGLE-RUN state, when <code>true</code>.
    */
   public void setSingleRun(boolean singleRun)
   {
      this.singleRun = singleRun;
   }

   /**
    * Get the {@link #singleton} state.
    * 
    * @return   See above.
    */
   public boolean isSingleton()
   {
      return singleton;
   }

   /**
    * Set the {@link #singleton} state.
    * 
    * @param    singleton
    *           Flag indicating the SINGLETON state, when <code>true</code>.
    */
   public void setSingleton(boolean singleton)
   {
      this.singleton = singleton;
   }
}