com.orientechnologies.orient.core.command.OCommandRequest Maven / Gradle / Ivy

/*
 *
 *  *  Copyright 2014 Orient Technologies LTD (info(at)orientechnologies.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.
 *  *
 *  * For more information: http://www.orientechnologies.com
 *
 */
package com.orientechnologies.orient.core.command;

import com.orientechnologies.orient.core.command.OCommandContext.TIMEOUT_STRATEGY;

/**
 * Generic GOF command pattern implementation. Execute a command passing the optional arguments "iArgs" and returns an Object.
 * 
 * @author Luca Garulli
 */
public interface OCommandRequest {
  public  RET execute(Object... iArgs);

  /**
   * Returns the limit of result set. -1 means no limits.
   * 
   */
  public int getLimit();

  /**
   * Sets the maximum items the command can returns. -1 means no limits.
   * 
   * @param iLimit
   *          -1 = no limit. 1 to N to limit the result set.
   * @return
   */
  public OCommandRequest setLimit(int iLimit);

  /**
   * Returns the command timeout. 0 means no timeout.
   * 
   * @return
   */
  public long getTimeoutTime();

  /**
   * Returns the command timeout strategy between the defined ones.
   * 
   * @return
   */
  public TIMEOUT_STRATEGY getTimeoutStrategy();

  /**
   * Sets the command timeout. When the command execution time is major than the timeout the command returns
   * 
   * @param timeout
   */
  public void setTimeout(long timeout, TIMEOUT_STRATEGY strategy);

  /**
   * Returns true if the command doesn't change the database, otherwise false.
   */
  public boolean isIdempotent();

  /**
   * Returns the fetch plan if any
   * 
   * @return Fetch plan as unique string or null if it was not defined.
   */
  public String getFetchPlan();

  /**
   * Set the fetch plan. The format is:
   * 
   *    * <field>:<depth-level>*
   * 
   * 
   * Where:
   * 
   * field is the name of the field to specify the depth-level. * wildcard means any fields
   * depth-level is the depth level to fetch. -1 means infinite, 0 means no fetch at all and 1-N the depth level value.
   * 
   * Uses the blank spaces to separate the fields strategies.

   * Example:
   * 
   *    * children:-1 parent:0 sibling:3 *:0
   * 
   * 
   * 

   * 
   * @param iFetchPlan
   * @return
   */
  public  RET setFetchPlan(String iFetchPlan);

  public void setUseCache(boolean iUseCache);

  public OCommandContext getContext();

  public OCommandRequest setContext(final OCommandContext iContext);
}