Class DEnumItem

The DEnumItem (Dynamic Enum Item) complex data type. Has a one-to-many relationship with the DEnum type.

AlphaDAO

DEnumItem implements AlphaTypeInterface

Package: alpha::model::types
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: DEnumItem.inc 1600 2012-12-10 10:51:41Z alphadevx $
Since: 1.0
Located at model/types/DEnumItem.inc

Methods summary
`public`	# `__construct( )` The constructor The constructor Since 1.0 Overrides `AlphaDAO::__construct()`
`public array`	# `loadItems( integer $EnumID )` Loads all of the items for the given parent DEnum ID. Loads all of the items for the given parent DEnum ID. Parameters `$EnumID` `integer` $EnumID The ID of the parent DEnum object. Returns `array` Throws `AlphaException` Since 1.0
`public String`	# `getValue( )` used to get the current DEnum item used to get the current DEnum item Returns `String` Since 1.0 Implementation of `AlphaTypeInterface::getValue()`
`public`	# `setValue( string $item )` used to set the current DEnum item used to set the current DEnum item Parameters `$item` `string` $item Since 1.0 Implementation of `AlphaTypeInterface::setValue()`
`public string`	# `getHelper( )` Getter for the validation helper string Getter for the validation helper string Returns `string` Since 1.0 Implementation of `AlphaTypeInterface::getHelper()`
`public`	# `setHelper( string $helper )` Set the validation helper text Set the validation helper text Parameters `$helper` `string` $helper Since 1.0 Implementation of `AlphaTypeInterface::setHelper()`
`public string`	# `__toString( )` Used to convert the object to a printable string Used to convert the object to a printable string Returns `string` Since 1.0 Implementation of `AlphaTypeInterface::__toString()`

Methods inherited from AlphaDAO
__wakeup(), addProperty(), addToCache(), begin(), cast(), checkBOTableExists(), checkClassDefExists(), checkRecordExists(), checkTableExists(), checkTableNeedsUpdate(), commit(), createForeignIndex(), createUniqueIndex(), delete(), deleteAllByAttribute(), disconnect(), dropTable(), findMissingFields(), get(), getBOClassNames(), getConnection(), getCount(), getCreateTS(), getCreatorId(), getDataLabel(), getDataLabels(), getDefaultAttributes(), getFriendlyClassName(), getHistoryCount(), getID(), getIndexes(), getLastQuery(), getMAX(), getMaintainHistory(), getOID(), getPersistentAttributes(), getPropObject(), getTableName(), getTransientAttributes(), getUniqueAttributes(), getUpdateTS(), getUpdatorId(), getVersion(), getVersionNumber(), hasAttribute(), isInstalled(), isTableOverloaded(), isTagged(), isTransient(), load(), loadAll(), loadAllByAttribute(), loadAllByAttributes(), loadAllByDayUpdated(), loadAllFieldValuesByAttribute(), loadByAttribute(), loadClassDef(), loadFromCache(), makeHistoryTable(), makeTable(), markPersistent(), markTransient(), markUnique(), populateFromPost(), query(), rebuildTable(), reload(), removeFromCache(), rollback(), save(), saveAttribute(), saveHistory(), set(), setDataLabels(), setEnumOptions(), setLastQuery(), setMaintainHistory(), setOID(), validate()

Constants summary
`string`	`TABLE_NAME`	`'DEnumItem'`	# The name of the database table for the class The name of the database table for the class Since 1.0

Properties summary
`protected String`	`$value`		# The value that will appear in the drop-down. The value that will appear in the drop-down. Since 1.0
`protected Integer`	`$DEnumID`		# The ID of the parent DEnum object. The ID of the parent DEnum object. Since 1.0
`protected array`	`$dataLabels`	`array("OID"=>"DEnumItem ID#","value"=>"Dropdown value")`	# an array of data display labels for the class properties an array of data display labels for the class properties Since 1.0
`protected string`	`$helper`	`'Not a valid DEnumItem value!'`	# The message to display to the user when validation fails The message to display to the user when validation fails Since 1.0

Properties inherited from AlphaDAO
`$OID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num`

Packages

Classes

Interfaces

Class DEnumItem

Since

Overrides

Parameters

Returns

Throws

Since

Returns

Since

Implementation of

Parameters

Since

Implementation of

Returns

Since

Implementation of

Parameters

Since

Implementation of

Returns

Since

Implementation of

Since

Since

Since

Since

Since