luos/workflow/engine/classes/model/om/BaseOutputDocument.php

<?php
/**
 * BaseOutputDocument.php
 * @package    workflow.classes.model.om
 */

require_once 'propel/om/BaseObject.php';
require_once 'propel/om/Persistent.php';

include_once 'propel/util/Criteria.php';
include_once 'classes/model/OutputDocumentPeer.php';

/**
 * Base class that represents a row from the 'OUTPUT_DOCUMENT' table.
 *
 * 
 *
 * @package    workflow.classes.model.om
 */
abstract class BaseOutputDocument extends BaseObject  implements Persistent {


	/**
	 * The Peer class.
	 * Instance provides a convenient way of calling static methods on a class
	 * that calling code may not be able to identify.
	 * @var        OutputDocumentPeer
	 */
	protected static $peer;


	/**
	 * The value for the out_doc_uid field.
	 * @var        string
	 */
	protected $out_doc_uid = '';


	/**
	 * The value for the pro_uid field.
	 * @var        string
	 */
	protected $pro_uid = '';


	/**
	 * The value for the out_doc_landscape field.
	 * @var        int
	 */
	protected $out_doc_landscape = 0;


	/**
	 * The value for the out_doc_media field.
	 * @var        string
	 */
	protected $out_doc_media = 'Letter';


	/**
	 * The value for the out_doc_left_margin field.
	 * @var        int
	 */
	protected $out_doc_left_margin = 30;


	/**
	 * The value for the out_doc_right_margin field.
	 * @var        int
	 */
	protected $out_doc_right_margin = 15;


	/**
	 * The value for the out_doc_top_margin field.
	 * @var        int
	 */
	protected $out_doc_top_margin = 15;


	/**
	 * The value for the out_doc_bottom_margin field.
	 * @var        int
	 */
	protected $out_doc_bottom_margin = 15;


	/**
	 * The value for the out_doc_generate field.
	 * @var        string
	 */
	protected $out_doc_generate = 'BOTH';


	/**
	 * The value for the out_doc_type field.
	 * @var        string
	 */
	protected $out_doc_type = 'HTML';


	/**
	 * The value for the out_doc_current_revision field.
	 * @var        int
	 */
	protected $out_doc_current_revision = 0;


	/**
	 * The value for the out_doc_field_mapping field.
	 * @var        string
	 */
	protected $out_doc_field_mapping;


	/**
	 * The value for the out_doc_versioning field.
	 * @var        int
	 */
	protected $out_doc_versioning = 0;


	/**
	 * The value for the out_doc_destination_path field.
	 * @var        string
	 */
	protected $out_doc_destination_path;


	/**
	 * The value for the out_doc_tags field.
	 * @var        string
	 */
	protected $out_doc_tags;

	/**
	 * Flag to prevent endless save loop, if this object is referenced
	 * by another object which falls in this transaction.
	 * @var        boolean
	 */
	protected $alreadyInSave = false;

	/**
	 * Flag to prevent endless validation loop, if this object is referenced
	 * by another object which falls in this transaction.
	 * @var        boolean
	 */
	protected $alreadyInValidation = false;

	/**
	 * Get the [out_doc_uid] column value.
	 * 
	 * @return     string
	 */
	public function getOutDocUid()
	{

		return $this->out_doc_uid;
	}

	/**
	 * Get the [pro_uid] column value.
	 * 
	 * @return     string
	 */
	public function getProUid()
	{

		return $this->pro_uid;
	}

	/**
	 * Get the [out_doc_landscape] column value.
	 * 
	 * @return     int
	 */
	public function getOutDocLandscape()
	{

		return $this->out_doc_landscape;
	}

	/**
	 * Get the [out_doc_media] column value.
	 * 
	 * @return     string
	 */
	public function getOutDocMedia()
	{

		return $this->out_doc_media;
	}

	/**
	 * Get the [out_doc_left_margin] column value.
	 * 
	 * @return     int
	 */
	public function getOutDocLeftMargin()
	{

		return $this->out_doc_left_margin;
	}

	/**
	 * Get the [out_doc_right_margin] column value.
	 * 
	 * @return     int
	 */
	public function getOutDocRightMargin()
	{

		return $this->out_doc_right_margin;
	}

	/**
	 * Get the [out_doc_top_margin] column value.
	 * 
	 * @return     int
	 */
	public function getOutDocTopMargin()
	{

		return $this->out_doc_top_margin;
	}

	/**
	 * Get the [out_doc_bottom_margin] column value.
	 * 
	 * @return     int
	 */
	public function getOutDocBottomMargin()
	{

		return $this->out_doc_bottom_margin;
	}

	/**
	 * Get the [out_doc_generate] column value.
	 * 
	 * @return     string
	 */
	public function getOutDocGenerate()
	{

		return $this->out_doc_generate;
	}

	/**
	 * Get the [out_doc_type] column value.
	 * 
	 * @return     string
	 */
	public function getOutDocType()
	{

		return $this->out_doc_type;
	}

	/**
	 * Get the [out_doc_current_revision] column value.
	 * 
	 * @return     int
	 */
	public function getOutDocCurrentRevision()
	{

		return $this->out_doc_current_revision;
	}

	/**
	 * Get the [out_doc_field_mapping] column value.
	 * 
	 * @return     string
	 */
	public function getOutDocFieldMapping()
	{

		return $this->out_doc_field_mapping;
	}

	/**
	 * Get the [out_doc_versioning] column value.
	 * 
	 * @return     int
	 */
	public function getOutDocVersioning()
	{

		return $this->out_doc_versioning;
	}

	/**
	 * Get the [out_doc_destination_path] column value.
	 * 
	 * @return     string
	 */
	public function getOutDocDestinationPath()
	{

		return $this->out_doc_destination_path;
	}

	/**
	 * Get the [out_doc_tags] column value.
	 * 
	 * @return     string
	 */
	public function getOutDocTags()
	{

		return $this->out_doc_tags;
	}

	/**
	 * Set the value of [out_doc_uid] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setOutDocUid($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->out_doc_uid !== $v || $v === '') {
			$this->out_doc_uid = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_UID;
		}

	} // setOutDocUid()

	/**
	 * Set the value of [pro_uid] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setProUid($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->pro_uid !== $v || $v === '') {
			$this->pro_uid = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::PRO_UID;
		}

	} // setProUid()

	/**
	 * Set the value of [out_doc_landscape] column.
	 * 
	 * @param      int $v new value
	 * @return     void
	 */
	public function setOutDocLandscape($v)
	{

		// Since the native PHP type for this column is integer,
		// we will cast the input value to an int (if it is not).
		if ($v !== null && !is_int($v) && is_numeric($v)) {
			$v = (int) $v;
		}

		if ($this->out_doc_landscape !== $v || $v === 0) {
			$this->out_doc_landscape = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_LANDSCAPE;
		}

	} // setOutDocLandscape()

	/**
	 * Set the value of [out_doc_media] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setOutDocMedia($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->out_doc_media !== $v || $v === 'Letter') {
			$this->out_doc_media = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_MEDIA;
		}

	} // setOutDocMedia()

	/**
	 * Set the value of [out_doc_left_margin] column.
	 * 
	 * @param      int $v new value
	 * @return     void
	 */
	public function setOutDocLeftMargin($v)
	{

		// Since the native PHP type for this column is integer,
		// we will cast the input value to an int (if it is not).
		if ($v !== null && !is_int($v) && is_numeric($v)) {
			$v = (int) $v;
		}

		if ($this->out_doc_left_margin !== $v || $v === 30) {
			$this->out_doc_left_margin = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_LEFT_MARGIN;
		}

	} // setOutDocLeftMargin()

	/**
	 * Set the value of [out_doc_right_margin] column.
	 * 
	 * @param      int $v new value
	 * @return     void
	 */
	public function setOutDocRightMargin($v)
	{

		// Since the native PHP type for this column is integer,
		// we will cast the input value to an int (if it is not).
		if ($v !== null && !is_int($v) && is_numeric($v)) {
			$v = (int) $v;
		}

		if ($this->out_doc_right_margin !== $v || $v === 15) {
			$this->out_doc_right_margin = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_RIGHT_MARGIN;
		}

	} // setOutDocRightMargin()

	/**
	 * Set the value of [out_doc_top_margin] column.
	 * 
	 * @param      int $v new value
	 * @return     void
	 */
	public function setOutDocTopMargin($v)
	{

		// Since the native PHP type for this column is integer,
		// we will cast the input value to an int (if it is not).
		if ($v !== null && !is_int($v) && is_numeric($v)) {
			$v = (int) $v;
		}

		if ($this->out_doc_top_margin !== $v || $v === 15) {
			$this->out_doc_top_margin = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_TOP_MARGIN;
		}

	} // setOutDocTopMargin()

	/**
	 * Set the value of [out_doc_bottom_margin] column.
	 * 
	 * @param      int $v new value
	 * @return     void
	 */
	public function setOutDocBottomMargin($v)
	{

		// Since the native PHP type for this column is integer,
		// we will cast the input value to an int (if it is not).
		if ($v !== null && !is_int($v) && is_numeric($v)) {
			$v = (int) $v;
		}

		if ($this->out_doc_bottom_margin !== $v || $v === 15) {
			$this->out_doc_bottom_margin = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_BOTTOM_MARGIN;
		}

	} // setOutDocBottomMargin()

	/**
	 * Set the value of [out_doc_generate] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setOutDocGenerate($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->out_doc_generate !== $v || $v === 'BOTH') {
			$this->out_doc_generate = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_GENERATE;
		}

	} // setOutDocGenerate()

	/**
	 * Set the value of [out_doc_type] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setOutDocType($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->out_doc_type !== $v || $v === 'HTML') {
			$this->out_doc_type = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_TYPE;
		}

	} // setOutDocType()

	/**
	 * Set the value of [out_doc_current_revision] column.
	 * 
	 * @param      int $v new value
	 * @return     void
	 */
	public function setOutDocCurrentRevision($v)
	{

		// Since the native PHP type for this column is integer,
		// we will cast the input value to an int (if it is not).
		if ($v !== null && !is_int($v) && is_numeric($v)) {
			$v = (int) $v;
		}

		if ($this->out_doc_current_revision !== $v || $v === 0) {
			$this->out_doc_current_revision = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_CURRENT_REVISION;
		}

	} // setOutDocCurrentRevision()

	/**
	 * Set the value of [out_doc_field_mapping] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setOutDocFieldMapping($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->out_doc_field_mapping !== $v) {
			$this->out_doc_field_mapping = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_FIELD_MAPPING;
		}

	} // setOutDocFieldMapping()

	/**
	 * Set the value of [out_doc_versioning] column.
	 * 
	 * @param      int $v new value
	 * @return     void
	 */
	public function setOutDocVersioning($v)
	{

		// Since the native PHP type for this column is integer,
		// we will cast the input value to an int (if it is not).
		if ($v !== null && !is_int($v) && is_numeric($v)) {
			$v = (int) $v;
		}

		if ($this->out_doc_versioning !== $v || $v === 0) {
			$this->out_doc_versioning = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_VERSIONING;
		}

	} // setOutDocVersioning()

	/**
	 * Set the value of [out_doc_destination_path] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setOutDocDestinationPath($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->out_doc_destination_path !== $v) {
			$this->out_doc_destination_path = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_DESTINATION_PATH;
		}

	} // setOutDocDestinationPath()

	/**
	 * Set the value of [out_doc_tags] column.
	 * 
	 * @param      string $v new value
	 * @return     void
	 */
	public function setOutDocTags($v)
	{

		// Since the native PHP type for this column is string,
		// we will cast the input to a string (if it is not).
		if ($v !== null && !is_string($v)) {
			$v = (string) $v; 
		}

		if ($this->out_doc_tags !== $v) {
			$this->out_doc_tags = $v;
			$this->modifiedColumns[] = OutputDocumentPeer::OUT_DOC_TAGS;
		}

	} // setOutDocTags()

	/**
	 * Hydrates (populates) the object variables with values from the database resultset.
	 *
	 * An offset (1-based "start column") is specified so that objects can be hydrated
	 * with a subset of the columns in the resultset rows.  This is needed, for example,
	 * for results of JOIN queries where the resultset row includes columns from two or
	 * more tables.
	 *
	 * @param      ResultSet $rs The ResultSet class with cursor advanced to desired record pos.
	 * @param      int $startcol 1-based offset column which indicates which restultset column to start with.
	 * @return     int next starting column
	 * @throws     PropelException  - Any caught Exception will be rewrapped as a PropelException.
	 */
	public function hydrate(ResultSet $rs, $startcol = 1)
	{
		try {

			$this->out_doc_uid = $rs->getString($startcol + 0);

			$this->pro_uid = $rs->getString($startcol + 1);

			$this->out_doc_landscape = $rs->getInt($startcol + 2);

			$this->out_doc_media = $rs->getString($startcol + 3);

			$this->out_doc_left_margin = $rs->getInt($startcol + 4);

			$this->out_doc_right_margin = $rs->getInt($startcol + 5);

			$this->out_doc_top_margin = $rs->getInt($startcol + 6);

			$this->out_doc_bottom_margin = $rs->getInt($startcol + 7);

			$this->out_doc_generate = $rs->getString($startcol + 8);

			$this->out_doc_type = $rs->getString($startcol + 9);

			$this->out_doc_current_revision = $rs->getInt($startcol + 10);

			$this->out_doc_field_mapping = $rs->getString($startcol + 11);

			$this->out_doc_versioning = $rs->getInt($startcol + 12);

			$this->out_doc_destination_path = $rs->getString($startcol + 13);

			$this->out_doc_tags = $rs->getString($startcol + 14);

			$this->resetModified();

			$this->setNew(false);

			// FIXME - using NUM_COLUMNS may be clearer.
			return $startcol + 15; // 15 = OutputDocumentPeer::NUM_COLUMNS - OutputDocumentPeer::NUM_LAZY_LOAD_COLUMNS).

		} catch (Exception $e) {
			throw new PropelException("Error populating OutputDocument object", $e);
		}
	}

	/**
	 * Removes this object from datastore and sets delete attribute.
	 *
	 * @param      Connection $con
	 * @return     void
	 * @throws     PropelException
	 * @see        BaseObject::setDeleted()
	 * @see        BaseObject::isDeleted()
	 */
	public function delete($con = null)
	{
		if ($this->isDeleted()) {
			throw new PropelException("This object has already been deleted.");
		}

		if ($con === null) {
			$con = Propel::getConnection(OutputDocumentPeer::DATABASE_NAME);
		}

		try {
			$con->begin();
			OutputDocumentPeer::doDelete($this, $con);
			$this->setDeleted(true);
			$con->commit();
		} catch (PropelException $e) {
			$con->rollback();
			throw $e;
		}
	}

	/**
	 * Stores the object in the database.  If the object is new,
	 * it inserts it; otherwise an update is performed.  This method
	 * wraps the doSave() worker method in a transaction.
	 *
	 * @param      Connection $con
	 * @return     int The number of rows affected by this insert/update and any referring fk objects' save() operations.
	 * @throws     PropelException
	 * @see        doSave()
	 */
	public function save($con = null)
	{
		if ($this->isDeleted()) {
			throw new PropelException("You cannot save an object that has been deleted.");
		}

		if ($con === null) {
			$con = Propel::getConnection(OutputDocumentPeer::DATABASE_NAME);
		}

		try {
			$con->begin();
			$affectedRows = $this->doSave($con);
			$con->commit();
			return $affectedRows;
		} catch (PropelException $e) {
			$con->rollback();
			throw $e;
		}
	}

	/**
	 * Stores the object in the database.
	 *
	 * If the object is new, it inserts it; otherwise an update is performed.
	 * All related objects are also updated in this method.
	 *
	 * @param      Connection $con
	 * @return     int The number of rows affected by this insert/update and any referring fk objects' save() operations.
	 * @throws     PropelException
	 * @see        save()
	 */
	protected function doSave($con)
	{
		$affectedRows = 0; // initialize var to track total num of affected rows
		if (!$this->alreadyInSave) {
			$this->alreadyInSave = true;


			// If this object has been modified, then save it to the database.
			if ($this->isModified()) {
				if ($this->isNew()) {
					$pk = OutputDocumentPeer::doInsert($this, $con);
					$affectedRows += 1; // we are assuming that there is only 1 row per doInsert() which
										 // should always be true here (even though technically
										 // BasePeer::doInsert() can insert multiple rows).

					$this->setNew(false);
				} else {
					$affectedRows += OutputDocumentPeer::doUpdate($this, $con);
				}
				$this->resetModified(); // [HL] After being saved an object is no longer 'modified'
			}

			$this->alreadyInSave = false;
		}
		return $affectedRows;
	} // doSave()

	/**
	 * Array of ValidationFailed objects.
	 * @var        array ValidationFailed[]
	 */
	protected $validationFailures = array();

	/**
	 * Gets any ValidationFailed objects that resulted from last call to validate().
	 *
	 *
	 * @return     array ValidationFailed[]
	 * @see        validate()
	 */
	public function getValidationFailures()
	{
		return $this->validationFailures;
	}

	/**
	 * Validates the objects modified field values and all objects related to this table.
	 *
	 * If $columns is either a column name or an array of column names
	 * only those columns are validated.
	 *
	 * @param      mixed $columns Column name or an array of column names.
	 * @return     boolean Whether all columns pass validation.
	 * @see        doValidate()
	 * @see        getValidationFailures()
	 */
	public function validate($columns = null)
	{
		$res = $this->doValidate($columns);
		if ($res === true) {
			$this->validationFailures = array();
			return true;
		} else {
			$this->validationFailures = $res;
			return false;
		}
	}

	/**
	 * This function performs the validation work for complex object models.
	 *
	 * In addition to checking the current object, all related objects will
	 * also be validated.  If all pass then <code>true</code> is returned; otherwise
	 * an aggreagated array of ValidationFailed objects will be returned.
	 *
	 * @param      array $columns Array of column names to validate.
	 * @return     mixed <code>true</code> if all validations pass; array of <code>ValidationFailed</code> objets otherwise.
	 */
	protected function doValidate($columns = null)
	{
		if (!$this->alreadyInValidation) {
			$this->alreadyInValidation = true;
			$retval = null;

			$failureMap = array();


			if (($retval = OutputDocumentPeer::doValidate($this, $columns)) !== true) {
				$failureMap = array_merge($failureMap, $retval);
			}



			$this->alreadyInValidation = false;
		}

		return (!empty($failureMap) ? $failureMap : true);
	}

	/**
	 * Retrieves a field from the object by name passed in as a string.
	 *
	 * @param      string $name name
	 * @param      string $type The type of fieldname the $name is of:
	 *                     one of the class type constants TYPE_PHPNAME,
	 *                     TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
	 * @return     mixed Value of field.
	 */
	public function getByName($name, $type = BasePeer::TYPE_PHPNAME)
	{
		$pos = OutputDocumentPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
		return $this->getByPosition($pos);
	}

	/**
	 * Retrieves a field from the object by Position as specified in the xml schema.
	 * Zero-based.
	 *
	 * @param      int $pos position in xml schema
	 * @return     mixed Value of field at $pos
	 */
	public function getByPosition($pos)
	{
		switch($pos) {
			case 0:
				return $this->getOutDocUid();
				break;
			case 1:
				return $this->getProUid();
				break;
			case 2:
				return $this->getOutDocLandscape();
				break;
			case 3:
				return $this->getOutDocMedia();
				break;
			case 4:
				return $this->getOutDocLeftMargin();
				break;
			case 5:
				return $this->getOutDocRightMargin();
				break;
			case 6:
				return $this->getOutDocTopMargin();
				break;
			case 7:
				return $this->getOutDocBottomMargin();
				break;
			case 8:
				return $this->getOutDocGenerate();
				break;
			case 9:
				return $this->getOutDocType();
				break;
			case 10:
				return $this->getOutDocCurrentRevision();
				break;
			case 11:
				return $this->getOutDocFieldMapping();
				break;
			case 12:
				return $this->getOutDocVersioning();
				break;
			case 13:
				return $this->getOutDocDestinationPath();
				break;
			case 14:
				return $this->getOutDocTags();
				break;
			default:
				return null;
				break;
		} // switch()
	}

	/**
	 * Exports the object as an array.
	 *
	 * You can specify the key type of the array by passing one of the class
	 * type constants.
	 *
	 * @param      string $keyType One of the class type constants TYPE_PHPNAME,
	 *                        TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
	 * @return     an associative array containing the field names (as keys) and field values
	 */
	public function toArray($keyType = BasePeer::TYPE_PHPNAME)
	{
		$keys = OutputDocumentPeer::getFieldNames($keyType);
		$result = array(
			$keys[0] => $this->getOutDocUid(),
			$keys[1] => $this->getProUid(),
			$keys[2] => $this->getOutDocLandscape(),
			$keys[3] => $this->getOutDocMedia(),
			$keys[4] => $this->getOutDocLeftMargin(),
			$keys[5] => $this->getOutDocRightMargin(),
			$keys[6] => $this->getOutDocTopMargin(),
			$keys[7] => $this->getOutDocBottomMargin(),
			$keys[8] => $this->getOutDocGenerate(),
			$keys[9] => $this->getOutDocType(),
			$keys[10] => $this->getOutDocCurrentRevision(),
			$keys[11] => $this->getOutDocFieldMapping(),
			$keys[12] => $this->getOutDocVersioning(),
			$keys[13] => $this->getOutDocDestinationPath(),
			$keys[14] => $this->getOutDocTags(),
		);
		return $result;
	}

	/**
	 * Sets a field from the object by name passed in as a string.
	 *
	 * @param      string $name peer name
	 * @param      mixed $value field value
	 * @param      string $type The type of fieldname the $name is of:
	 *                     one of the class type constants TYPE_PHPNAME,
	 *                     TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
	 * @return     void
	 */
	public function setByName($name, $value, $type = BasePeer::TYPE_PHPNAME)
	{
		$pos = OutputDocumentPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
		return $this->setByPosition($pos, $value);
	}

	/**
	 * Sets a field from the object by Position as specified in the xml schema.
	 * Zero-based.
	 *
	 * @param      int $pos position in xml schema
	 * @param      mixed $value field value
	 * @return     void
	 */
	public function setByPosition($pos, $value)
	{
		switch($pos) {
			case 0:
				$this->setOutDocUid($value);
				break;
			case 1:
				$this->setProUid($value);
				break;
			case 2:
				$this->setOutDocLandscape($value);
				break;
			case 3:
				$this->setOutDocMedia($value);
				break;
			case 4:
				$this->setOutDocLeftMargin($value);
				break;
			case 5:
				$this->setOutDocRightMargin($value);
				break;
			case 6:
				$this->setOutDocTopMargin($value);
				break;
			case 7:
				$this->setOutDocBottomMargin($value);
				break;
			case 8:
				$this->setOutDocGenerate($value);
				break;
			case 9:
				$this->setOutDocType($value);
				break;
			case 10:
				$this->setOutDocCurrentRevision($value);
				break;
			case 11:
				$this->setOutDocFieldMapping($value);
				break;
			case 12:
				$this->setOutDocVersioning($value);
				break;
			case 13:
				$this->setOutDocDestinationPath($value);
				break;
			case 14:
				$this->setOutDocTags($value);
				break;
		} // switch()
	}

	/**
	 * Populates the object using an array.
	 *
	 * This is particularly useful when populating an object from one of the
	 * request arrays (e.g. $_POST).  This method goes through the column
	 * names, checking to see whether a matching key exists in populated
	 * array. If so the setByName() method is called for that column.
	 *
	 * You can specify the key type of the array by additionally passing one
	 * of the class type constants TYPE_PHPNAME, TYPE_COLNAME, TYPE_FIELDNAME,
	 * TYPE_NUM. The default key type is the column's phpname (e.g. 'authorId')
	 *
	 * @param      array  $arr     An array to populate the object from.
	 * @param      string $keyType The type of keys the array uses.
	 * @return     void
	 */
	public function fromArray($arr, $keyType = BasePeer::TYPE_PHPNAME)
	{
		$keys = OutputDocumentPeer::getFieldNames($keyType);

		if (array_key_exists($keys[0], $arr)) $this->setOutDocUid($arr[$keys[0]]);
		if (array_key_exists($keys[1], $arr)) $this->setProUid($arr[$keys[1]]);
		if (array_key_exists($keys[2], $arr)) $this->setOutDocLandscape($arr[$keys[2]]);
		if (array_key_exists($keys[3], $arr)) $this->setOutDocMedia($arr[$keys[3]]);
		if (array_key_exists($keys[4], $arr)) $this->setOutDocLeftMargin($arr[$keys[4]]);
		if (array_key_exists($keys[5], $arr)) $this->setOutDocRightMargin($arr[$keys[5]]);
		if (array_key_exists($keys[6], $arr)) $this->setOutDocTopMargin($arr[$keys[6]]);
		if (array_key_exists($keys[7], $arr)) $this->setOutDocBottomMargin($arr[$keys[7]]);
		if (array_key_exists($keys[8], $arr)) $this->setOutDocGenerate($arr[$keys[8]]);
		if (array_key_exists($keys[9], $arr)) $this->setOutDocType($arr[$keys[9]]);
		if (array_key_exists($keys[10], $arr)) $this->setOutDocCurrentRevision($arr[$keys[10]]);
		if (array_key_exists($keys[11], $arr)) $this->setOutDocFieldMapping($arr[$keys[11]]);
		if (array_key_exists($keys[12], $arr)) $this->setOutDocVersioning($arr[$keys[12]]);
		if (array_key_exists($keys[13], $arr)) $this->setOutDocDestinationPath($arr[$keys[13]]);
		if (array_key_exists($keys[14], $arr)) $this->setOutDocTags($arr[$keys[14]]);
	}

	/**
	 * Build a Criteria object containing the values of all modified columns in this object.
	 *
	 * @return     Criteria The Criteria object containing all modified values.
	 */
	public function buildCriteria()
	{
		$criteria = new Criteria(OutputDocumentPeer::DATABASE_NAME);

		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_UID)) $criteria->add(OutputDocumentPeer::OUT_DOC_UID, $this->out_doc_uid);
		if ($this->isColumnModified(OutputDocumentPeer::PRO_UID)) $criteria->add(OutputDocumentPeer::PRO_UID, $this->pro_uid);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_LANDSCAPE)) $criteria->add(OutputDocumentPeer::OUT_DOC_LANDSCAPE, $this->out_doc_landscape);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_MEDIA)) $criteria->add(OutputDocumentPeer::OUT_DOC_MEDIA, $this->out_doc_media);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_LEFT_MARGIN)) $criteria->add(OutputDocumentPeer::OUT_DOC_LEFT_MARGIN, $this->out_doc_left_margin);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_RIGHT_MARGIN)) $criteria->add(OutputDocumentPeer::OUT_DOC_RIGHT_MARGIN, $this->out_doc_right_margin);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_TOP_MARGIN)) $criteria->add(OutputDocumentPeer::OUT_DOC_TOP_MARGIN, $this->out_doc_top_margin);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_BOTTOM_MARGIN)) $criteria->add(OutputDocumentPeer::OUT_DOC_BOTTOM_MARGIN, $this->out_doc_bottom_margin);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_GENERATE)) $criteria->add(OutputDocumentPeer::OUT_DOC_GENERATE, $this->out_doc_generate);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_TYPE)) $criteria->add(OutputDocumentPeer::OUT_DOC_TYPE, $this->out_doc_type);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_CURRENT_REVISION)) $criteria->add(OutputDocumentPeer::OUT_DOC_CURRENT_REVISION, $this->out_doc_current_revision);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_FIELD_MAPPING)) $criteria->add(OutputDocumentPeer::OUT_DOC_FIELD_MAPPING, $this->out_doc_field_mapping);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_VERSIONING)) $criteria->add(OutputDocumentPeer::OUT_DOC_VERSIONING, $this->out_doc_versioning);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_DESTINATION_PATH)) $criteria->add(OutputDocumentPeer::OUT_DOC_DESTINATION_PATH, $this->out_doc_destination_path);
		if ($this->isColumnModified(OutputDocumentPeer::OUT_DOC_TAGS)) $criteria->add(OutputDocumentPeer::OUT_DOC_TAGS, $this->out_doc_tags);

		return $criteria;
	}

	/**
	 * Builds a Criteria object containing the primary key for this object.
	 *
	 * Unlike buildCriteria() this method includes the primary key values regardless
	 * of whether or not they have been modified.
	 *
	 * @return     Criteria The Criteria object containing value(s) for primary key(s).
	 */
	public function buildPkeyCriteria()
	{
		$criteria = new Criteria(OutputDocumentPeer::DATABASE_NAME);

		$criteria->add(OutputDocumentPeer::OUT_DOC_UID, $this->out_doc_uid);

		return $criteria;
	}

	/**
	 * Returns the primary key for this object (row).
	 * @return     string
	 */
	public function getPrimaryKey()
	{
		return $this->getOutDocUid();
	}

	/**
	 * Generic method to set the primary key (out_doc_uid column).
	 *
	 * @param      string $key Primary key.
	 * @return     void
	 */
	public function setPrimaryKey($key)
	{
		$this->setOutDocUid($key);
	}

	/**
	 * Sets contents of passed object to values from current object.
	 *
	 * If desired, this method can also make copies of all associated (fkey referrers)
	 * objects.
	 *
	 * @param      object $copyObj An object of OutputDocument (or compatible) type.
	 * @param      boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
	 * @throws     PropelException
	 */
	public function copyInto($copyObj, $deepCopy = false)
	{

		$copyObj->setProUid($this->pro_uid);

		$copyObj->setOutDocLandscape($this->out_doc_landscape);

		$copyObj->setOutDocMedia($this->out_doc_media);

		$copyObj->setOutDocLeftMargin($this->out_doc_left_margin);

		$copyObj->setOutDocRightMargin($this->out_doc_right_margin);

		$copyObj->setOutDocTopMargin($this->out_doc_top_margin);

		$copyObj->setOutDocBottomMargin($this->out_doc_bottom_margin);

		$copyObj->setOutDocGenerate($this->out_doc_generate);

		$copyObj->setOutDocType($this->out_doc_type);

		$copyObj->setOutDocCurrentRevision($this->out_doc_current_revision);

		$copyObj->setOutDocFieldMapping($this->out_doc_field_mapping);

		$copyObj->setOutDocVersioning($this->out_doc_versioning);

		$copyObj->setOutDocDestinationPath($this->out_doc_destination_path);

		$copyObj->setOutDocTags($this->out_doc_tags);


		$copyObj->setNew(true);

		$copyObj->setOutDocUid(''); // this is a pkey column, so set to default value

	}

	/**
	 * Makes a copy of this object that will be inserted as a new row in table when saved.
	 * It creates a new object filling in the simple attributes, but skipping any primary
	 * keys that are defined for the table.
	 *
	 * If desired, this method can also make copies of all associated (fkey referrers)
	 * objects.
	 *
	 * @param      boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
	 * @return     OutputDocument Clone of current object.
	 * @throws     PropelException
	 */
	public function copy($deepCopy = false)
	{
		// we use get_class(), because this might be a subclass
		$clazz = get_class($this);
		$copyObj = new $clazz();
		$this->copyInto($copyObj, $deepCopy);
		return $copyObj;
	}

	/**
	 * Returns a peer instance associated with this om.
	 *
	 * Since Peer classes are not to have any instance attributes, this method returns the
	 * same instance for all member of this class. The method could therefore
	 * be static, but this would prevent one from overriding the behavior.
	 *
	 * @return     OutputDocumentPeer
	 */
	public function getPeer()
	{
		if (self::$peer === null) {
			self::$peer = new OutputDocumentPeer();
		}
		return self::$peer;
	}

} // BaseOutputDocument