<?php
/**
 * This is an interface so we can decorate it later.
 *
 * PHP Version 5
 *
 * @category   Pagi
 * @package    Client
 * @subpackage Result
 * @author     Marcelo Gornstein <[email protected]>
 * @license    http://marcelog.github.com/PAGI/ Apache License 2.0
 * @version    SVN: $Id$
 * @link       http://marcelog.github.com/PAGI/
 *
 * Copyright 2011 Marcelo Gornstein <[email protected]>
 *
 * 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.
 *
 */
namespace PAGI\Client\Result;

/**
 * This is an interface so we can decorate it later.
 *
 * PHP Version 5
 *
 * @category   Pagi
 * @package    Client
 * @subpackage Result
 * @author     Marcelo Gornstein <[email protected]>
 * @license    http://marcelog.github.com/PAGI/ Apache License 2.0
 * @link       http://marcelog.github.com/PAGI/
 */
interface IResult
{
    /**
     * Returns original line.
     *
     * @return string
     */
    public function getOriginalLine();

    /**
     * Returns the integer value of the code returned by agi.
     *
     * @return integer
     */
    public function getCode();

    /**
     * Returns result (result=xxx) from the result.
     *
     * @return integer
     */
    public function getResult();

    /**
     * Compares result to a given value.
     *
     * @param string $value Value to match against.
     *
     * @return boolean
     */
    public function isResult($value);

    /**
     * Returns true if this command returned any data.
     *
     * @return boolean
     */
    public function hasData();

    /**
     * Returns data, if any. False if none.
     *
     * @return string
     */
    public function getData();
}