Element index for package alpha--model--types
Package indexes
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ v ]
[ z ]
[ _ ]
_
- __construct
- in file Enum.inc, method Enum::__construct()
Constructor that sets up the enum options
- __construct
- in file Sequence.inc, method Sequence::__construct()
The constructor
- __construct
- in file Integer.inc, method Integer::__construct()
Constructor
- __construct
- in file Relation.inc, method Relation::__construct()
Constructor
- __construct
- in file RelationLookup.inc, method RelationLookup::__construct()
The constructor
- __construct
- in file Double.inc, method Double::__construct()
Constructor
- __construct
- in file DEnumItem.inc, method DEnumItem::__construct()
The constructor
- __construct
- in file Text.inc, method Text::__construct()
Constructor
- __construct
- in file Boolean.inc, method Boolean::__construct()
Constructor
- __construct
- in file Timestamp.inc, method Timestamp::__construct()
Constructor
- __construct
- in file Date.inc, method Date::__construct()
Constructor. Leave $date param empty to default to now.
- __construct
- in file DEnum.inc, method DEnum::__construct()
Constructor that sets up the DEnum options
- __construct
- in file String.inc, method String::__construct()
Constructor
- __toString
- in file Sequence.inc, method Sequence::__toString()
Used to convert the object to a printable string
- __toString
- in file RelationLookup.inc, method RelationLookup::__toString()
Used to convert the object to a printable string
- __toString
- in file Double.inc, method Double::__toString()
Used to convert the object to a printable string
- __toString
- in file AlphaTypeInterface.inc, method AlphaTypeInterface::__toString()
Convert the valud of the complex type to a string
- __toString
- in file Boolean.inc, method Boolean::__toString()
Used to convert the object to a printable string
- __toString
- in file DEnum.inc, method DEnum::__toString()
Used to convert the object to a printable string
- __toString
- in file DEnumItem.inc, method DEnumItem::__toString()
Used to convert the object to a printable string
- __toString
- in file AlphaType.inc, method AlphaType::__toString()
Used to convert the object to a printable string
a
- AlphaType
- in file AlphaType.inc, class AlphaType
The base (abstract) complex data type
- AlphaTypeInterface
- in file AlphaTypeInterface.inc, class AlphaTypeInterface
The interface for all complex data types
- AlphaType.inc
- procedural page AlphaType.inc
- AlphaTypeInterface.inc
- procedural page AlphaTypeInterface.inc
b
- Boolean
- in file Boolean.inc, class Boolean
The Boolean complex data type
- Boolean.inc
- procedural page Boolean.inc
d
- $dataLabels
- in file DEnum.inc, variable DEnum::$dataLabels
An array of data display labels for the class properties
- $dataLabels
- in file RelationLookup.inc, variable RelationLookup::$dataLabels
an array of data display labels for the class properties
- $dataLabels
- in file DEnumItem.inc, variable DEnumItem::$dataLabels
an array of data display labels for the class properties
- $dataLabels
- in file Sequence.inc, variable Sequence::$dataLabels
An array of data display labels for the class properties
- $DEnumID
- in file DEnumItem.inc, variable DEnumItem::$DEnumID
The ID of the parent DEnum object.
- Date
- in file Date.inc, class Date
The Date complex data type
- DEnum
- in file DEnum.inc, class DEnum
The DEnum (Dynamic Enum) complex data type. Similiar to Enum, except list items are stored in a database table and are editable.
- DEnumItem
- in file DEnumItem.inc, class DEnumItem
The DEnumItem (Dynamic Enum Item) complex data type. Has a one-to-many relationship with the DEnum type.
- Double
- in file Double.inc, class Double
The Double complex data type
- Date.inc
- procedural page Date.inc
- DEnum.inc
- procedural page DEnum.inc
- DEnumItem.inc
- procedural page DEnumItem.inc
- Double.inc
- procedural page Double.inc
e
- Enum
- in file Enum.inc, class Enum
The Enum complex data type
- Enum.inc
- procedural page Enum.inc
g
- getAllowHTML
- in file Text.inc, method Text::getAllowHTML()
Get the $allowHTML value
- getBooleanValue
- in file Boolean.inc, method Boolean::getBooleanValue()
Used to get the boolean value of the Boolean
- getDate
- in file Timestamp.inc, method Timestamp::getDate()
Getter for the date part
- getDay
- in file Timestamp.inc, method Timestamp::getDay()
Getter for the day part
- getDay
- in file Date.inc, method Date::getDay()
Get the day part
- getDisplayValue
- in file DEnum.inc, method DEnum::getDisplayValue()
Used to get the current DEnum item string value
- getEuroValue
- in file Timestamp.inc, method Timestamp::getEuroValue()
Get the date value as a string in the format "DD/MM/YYYY"
- getEuroValue
- in file Date.inc, method Date::getEuroValue()
Get the date value as a string in the format "DD/MM/YYYY"
- getHelper
- in file AlphaType.inc, method AlphaType::getHelper()
Used to get the validation helper message string
- getHelper
- in file RelationLookup.inc, method RelationLookup::getHelper()
Getter for the validation helper string
- getHelper
- in file DEnumItem.inc, method DEnumItem::getHelper()
Getter for the validation helper string
- getHelper
- in file Sequence.inc, method Sequence::getHelper()
Getter for the validation helper string
- getHelper
- in file DEnum.inc, method DEnum::getHelper()
Getter for the validation helper string
- getHelper
- in file AlphaTypeInterface.inc, method AlphaTypeInterface::getHelper()
Get the validation helper text
- getHelper
- in file Timestamp.inc, method Timestamp::getHelper()
Get the validation helper text
- getHour
- in file Timestamp.inc, method Timestamp::getHour()
Getter for the hour part
- getItemCount
- in file DEnum.inc, method DEnum::getItemCount()
Gets the count from the database of the DEnumItems associated with this object
- getLeftClassName
- in file RelationLookup.inc, method RelationLookup::getLeftClassName()
Get the leftClassName value
- getLookup
- in file Relation.inc, method Relation::getLookup()
Get the lookup object if available (only on MANY-TO-MANY relations, null otherwise)
- getMinute
- in file Timestamp.inc, method Timestamp::getMinute()
Getter for the minute part
- getMonth
- in file Date.inc, method Date::getMonth()
Get the month part
- getMonth
- in file Timestamp.inc, method Timestamp::getMonth()
Getter for the month part
- getName
- in file DEnum.inc, method DEnum::getName()
Getter for the name
- getOptionID
- in file DEnum.inc, method DEnum::getOptionID()
Used to get the DenumItem ID for the given option name
- getOptions
- in file DEnum.inc, method DEnum::getOptions()
Get the array of DEnum options from the database
- getOptions
- in file Enum.inc, method Enum::getOptions()
Get the array of enum options
- getRelatedClass
- in file Relation.inc, method Relation::getRelatedClass()
Get the name of the business object class that this class is related to
- getRelatedClassDisplayField
- in file Relation.inc, method Relation::getRelatedClassDisplayField()
Getter for the display field from the related class
- getRelatedClassDisplayFieldValue
- in file Relation.inc, method Relation::getRelatedClassDisplayFieldValue()
Getter for the display value of the related class field. In the case of a MANY-TO-MANY Relation, a comma-seperated sorted list of values is returned.
- getRelatedClassField
- in file Relation.inc, method Relation::getRelatedClassField()
Getter for the field of the related class
- getRelatedClassHeaderFields
- in file Relation.inc, method Relation::getRelatedClassHeaderFields()
Getter for the selection widget field headings of the related class
- getRelatedObject
- in file Relation.inc, method Relation::getRelatedObject()
For one-to-one relations, get the object on the other side
- getRelatedObjects
- in file Relation.inc, method Relation::getRelatedObjects()
For one-to-many and many-to-many relations, get the objects on the other side
- getRelationType
- in file Relation.inc, method Relation::getRelationType()
Getter for the relation type
- getRightClassName
- in file RelationLookup.inc, method RelationLookup::getRightClassName()
Get the rightClassName value
- getRule
- in file Timestamp.inc, method Timestamp::getRule()
Get the validation rule
- getRule
- in file Relation.inc, method Relation::getRule()
Get the validation rule
- getRule
- in file Sequence.inc, method Sequence::getRule()
Get the validation rule
- getRule
- in file Text.inc, method Text::getRule()
Get the validation rule
- getRule
- in file Integer.inc, method Integer::getRule()
Get the validation rule
- getRule
- in file Date.inc, method Date::getRule()
Get the validation rule
- getRule
- in file String.inc, method String::getRule()
Get the validation rule
- getRule
- in file Double.inc, method Double::getRule()
Get the validation rule
- getSecond
- in file Timestamp.inc, method Timestamp::getSecond()
Getter for the second part
- getSide
- in file Relation.inc, method Relation::getSide()
Gets the side ('left' or 'right') of the passed classname on the current Relation object
- getSize
- in file String.inc, method String::getSize()
Get the allowable size of the Double in the database field
- getSize
- in file Integer.inc, method Integer::getSize()
Get the allowable size of the Integer in the database field
- getSize
- in file Text.inc, method Text::getSize()
Get the allowable size of the Double in the database field
- getSize
- in file Double.inc, method Double::getSize()
Get the allowable size of the Double in the database field
- getSize
- in file Sequence.inc, method Sequence::getSize()
Get the allowable size of the Sequence in the database field
- getSize
- in file Relation.inc, method Relation::getSize()
Get the allowable size of the Relation in the database field
- getTableName
- in file RelationLookup.inc, method RelationLookup::getTableName()
Custom getter for the TABLE_NAME, which can't be static in this class due to the lookup tablenames being different each time.
- getTime
- in file Timestamp.inc, method Timestamp::getTime()
Getter for the time part
- getUnixValue
- in file Timestamp.inc, method Timestamp::getUnixValue()
Return the value in UNIX timestamp format
- getUnixValue
- in file Date.inc, method Date::getUnixValue()
Return the value in UNIX timestamp format
- getUSValue
- in file Date.inc, method Date::getUSValue()
Get the date value as a string in the format "MM/DD/YYYY"
- getValue
- in file Date.inc, method Date::getValue()
Get the date value as a string in the format "YYYY-MM-DD"
- getValue
- in file Timestamp.inc, method Timestamp::getValue()
Getter for the Timestamp value
- getValue
- in file AlphaTypeInterface.inc, method AlphaTypeInterface::getValue()
Get the value
- getValue
- in file Boolean.inc, method Boolean::getValue()
Used to get the binary (1/0) value of the Boolean. This is the value stored in the database.
- getValue
- in file Sequence.inc, method Sequence::getValue()
Used to get the Sequence value as a string
- getValue
- in file DEnumItem.inc, method DEnumItem::getValue()
used to get the current DEnum item
- getValue
- in file Relation.inc, method Relation::getValue()
Getter for the Relation value
- getValue
- in file Double.inc, method Double::getValue()
Getter for the Double value
- getValue
- in file Enum.inc, method Enum::getValue()
Used to get the current enum item
- getValue
- in file DEnum.inc, method DEnum::getValue()
Used to get the current DEnum item selected index value
- getValue
- in file RelationLookup.inc, method RelationLookup::getValue()
Returns an array of the OIDs of the related objects
- getValue
- in file Text.inc, method Text::getValue()
Getter for the value
- getValue
- in file String.inc, method String::getValue()
Getter for the value
- getValue
- in file Integer.inc, method Integer::getValue()
Getter for the Integer value
- getWeekday
- in file Timestamp.inc, method Timestamp::getWeekday()
Get the textual weekday part, e.g. Monday
- getWeekday
- in file Date.inc, method Date::getWeekday()
Get the textual weekday part, e.g. Monday
- getYear
- in file Timestamp.inc, method Timestamp::getYear()
Getter for the year part
- getYear
- in file Date.inc, method Date::getYear()
Get the year part
h
- $helper
- in file RelationLookup.inc, variable RelationLookup::$helper
The message to display to the user when validation fails
- $helper
- in file Relation.inc, variable Relation::$helper
The error message for the Relation type when validation fails
- $helper
- in file Sequence.inc, variable Sequence::$helper
The message to display to the user when validation fails
- $helper
- in file String.inc, variable String::$helper
The error message for the string type when validation fails
- $helper
- in file Text.inc, variable Text::$helper
The error message for the string type when validation fails
- $helper
- in file Integer.inc, variable Integer::$helper
The error message for the Integer type when validation fails
- $helper
- in file Enum.inc, variable Enum::$helper
The message to display to the user when validation fails
- $helper
- in file Date.inc, variable Date::$helper
The error message returned for invalid values
- $helper
- in file DEnum.inc, variable DEnum::$helper
The message to display to the user when validation fails
- $helper
- in file DEnumItem.inc, variable DEnumItem::$helper
The message to display to the user when validation fails
- $helper
- in file Double.inc, variable Double::$helper
The error message for the Double type when validation fails
- $helper
- in file Boolean.inc, variable Boolean::$helper
The error message returned for invalid values
i
- Integer
- in file Integer.inc, class Integer
The Integer complex data type
- isPassword
- in file String.inc, method String::isPassword()
Define the string as a password (making it required by validation rule)
- isRequired
- in file String.inc, method String::isRequired()
Sets up an appropriate validation rule for a required field
- Integer.inc
- procedural page Integer.inc
l
- $leftID
- in file RelationLookup.inc, variable RelationLookup::$leftID
The OID of the left business object in the relation
- loadAllByAttribute
- in file RelationLookup.inc, method RelationLookup::loadAllByAttribute()
This custom version provides the left/right class names to the business object constructor, required for RelationLookup objects.
- loadItems
- in file DEnumItem.inc, method DEnumItem::loadItems()
Loads all of the items for the given parent DEnum ID.
m
- MAX_SIZE
- in file String.inc, class constant String::MAX_SIZE
The absolute maximum size of the value for the this String
- MAX_SIZE
- in file Text.inc, class constant Text::MAX_SIZE
The absolute maximum size of the value for the this Text
- MAX_SIZE
- in file Sequence.inc, class constant Sequence::MAX_SIZE
The absolute maximum size of the value for the this Sequence
- MAX_SIZE
- in file Relation.inc, class constant Relation::MAX_SIZE
The absolute maximum size of the value for the this Relation
- MAX_SIZE
- in file Integer.inc, class constant Integer::MAX_SIZE
The absolute maximum size of the value for the this Integer
- MAX_SIZE
- in file Double.inc, class constant Double::MAX_SIZE
The absolute maximum size of the value for the this double
n
- $name
- in file DEnum.inc, variable DEnum::$name
The name of the DEnum used in the database
o
- $options
- in file DEnum.inc, variable DEnum::$options
An array of valid DEnum options
p
- $prefix
- in file Sequence.inc, variable Sequence::$prefix
The string prefix (must be capital alphabet characters only)
- populateFromString
- in file Timestamp.inc, method Timestamp::populateFromString()
Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format
- populateFromString
- in file Date.inc, method Date::populateFromString()
Accepts a full date string in YYYY-MM-DD format and populates relevent Date attributes.
r
- $rightID
- in file RelationLookup.inc, variable RelationLookup::$rightID
The OID of the right business object in the relation
- Relation.inc
- procedural page Relation.inc
- RelationLookup.inc
- procedural page RelationLookup.inc
- Relation
- in file Relation.inc, class Relation
The Relation complex data type
- RelationLookup
- in file RelationLookup.inc, class RelationLookup
The RelationLookup complex data type. Used to store object2object lookup tables for MANY-TO-MANY relationships between business objects
s
- $sequence
- in file Sequence.inc, variable Sequence::$sequence
The integer sequence number incremented for each Sequence value with this prefix
- $size
- in file Sequence.inc, variable Sequence::$size
The size of the value for the this Sequence
- Sequence.inc
- procedural page Sequence.inc
- String.inc
- procedural page String.inc
- Sequence
- in file Sequence.inc, class Sequence
A customer sequence datatype, which is stored as a string and is made up of a string prefix and an integer sequence, which is stored in a database.
- setAllowHTML
- in file Text.inc, method Text::setAllowHTML()
Set the $allowHTML value
- setDate
- in file Timestamp.inc, method Timestamp::setDate()
Setter for the date part
- setDateValue
- in file Date.inc, method Date::setDateValue()
Set the Date attributes to match the three values provided
- setHelper
- in file Timestamp.inc, method Timestamp::setHelper()
Set the validation helper text
- setHelper
- in file AlphaType.inc, method AlphaType::setHelper()
Set the validation helper text
- setHelper
- in file Sequence.inc, method Sequence::setHelper()
Set the validation helper text
- setHelper
- in file DEnumItem.inc, method DEnumItem::setHelper()
Set the validation helper text
- setHelper
- in file DEnum.inc, method DEnum::setHelper()
Set the validation helper text
- setHelper
- in file RelationLookup.inc, method RelationLookup::setHelper()
Set the validation helper text
- setHelper
- in file AlphaTypeInterface.inc, method AlphaTypeInterface::setHelper()
Set the validation helper text
- setName
- in file DEnum.inc, method DEnum::setName()
Setter for the name of the DEnum used in the database
- setOptions
- in file Enum.inc, method Enum::setOptions()
Setter for the enum options
- setRelatedClass
- in file Relation.inc, method Relation::setRelatedClass()
Set the name of the business object class that this class is related to
- setRelatedClassDisplayField
- in file Relation.inc, method Relation::setRelatedClassDisplayField()
Setter for the display field from the related class
- setRelatedClassField
- in file Relation.inc, method Relation::setRelatedClassField()
Setter for the field of the related class
- setRelatedClassHeaderFields
- in file Relation.inc, method Relation::setRelatedClassHeaderFields()
Setter for ONE-TO-MANY relations, which sets the header fields to render from the related class
- setRelationType
- in file Relation.inc, method Relation::setRelationType()
Setter for the relation type
- setRule
- in file Relation.inc, method Relation::setRule()
Setter to override the default validation rule
- setRule
- in file Timestamp.inc, method Timestamp::setRule()
Set the validation rule
- setRule
- in file Date.inc, method Date::setRule()
Set the validation rule
- setRule
- in file Text.inc, method Text::setRule()
Setter to override the default validation rule
- setRule
- in file String.inc, method String::setRule()
Setter to override the default validation rule
- setSequenceToNext
- in file Sequence.inc, method Sequence::setSequenceToNext()
Sets the sequence number to be the maximum value matching the prefix in the database plus one. Note that calling this method increments the maximum value in the database.
- setSize
- in file String.inc, method String::setSize()
Used to set the allowable size of the String in the database field
- setSize
- in file Text.inc, method Text::setSize()
Used to set the allowable size of the Text in the database field
- setSize
- in file Double.inc, method Double::setSize()
Used to set the allowable size of the Double in the database field
- setSize
- in file Integer.inc, method Integer::setSize()
Used to set the allowable size of the Integer in the database field
- setTaggedClass
- in file Relation.inc, method Relation::setTaggedClass()
Set the taggedClass property to the name of the tagged class when building relations to the TagObject BO.
- setTime
- in file Timestamp.inc, method Timestamp::setTime()
Setter for the time part
- setTimestampValue
- in file Timestamp.inc, method Timestamp::setTimestampValue()
Setter for the timestamp value
- setValue
- in file Date.inc, method Date::setValue()
Accepts a full date string in ISO YYYY-mm-dd format and populates relevent Date attributes.
- setValue
- in file Text.inc, method Text::setValue()
Setter for the value
- setValue
- in file Boolean.inc, method Boolean::setValue()
Used to set the Boolean value.
- setValue
- in file AlphaTypeInterface.inc, method AlphaTypeInterface::setValue()
Set the value of the type
- setValue
- in file DEnum.inc, method DEnum::setValue()
Used to select the current DEnum item
- setValue
- in file Timestamp.inc, method Timestamp::setValue()
Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format
- setValue
- in file DEnumItem.inc, method DEnumItem::setValue()
used to set the current DEnum item
- setValue
- in file Relation.inc, method Relation::setValue()
Setter for the value (OID of related object) of this relation
- setValue
- in file Sequence.inc, method Sequence::setValue()
Accepts a string to set the Sequence prefix/sequence values to, in the format PREFIX-00000000000
- setValue
- in file Integer.inc, method Integer::setValue()
Setter for the Integer value
- setValue
- in file Enum.inc, method Enum::setValue()
Used to select the current enum item
- setValue
- in file String.inc, method String::setValue()
Setter for the value
- setValue
- in file RelationLookup.inc, method RelationLookup::setValue()
Used to set the OIDs of the related objects. Pass a two-item array of OIDs, the first one being the left object OID, the second being the right.
- setValue
- in file Double.inc, method Double::setValue()
Setter for the Double value
- String
- in file String.inc, class String
The String complex data type
t
- Text.inc
- procedural page Text.inc
- Timestamp.inc
- procedural page Timestamp.inc
- TABLE_NAME
- in file DEnumItem.inc, class constant DEnumItem::TABLE_NAME
The name of the database table for the class
- TABLE_NAME
- in file DEnum.inc, class constant DEnum::TABLE_NAME
The name of the database table for the class
- TABLE_NAME
- in file Sequence.inc, class constant Sequence::TABLE_NAME
The name of the database table for the class
- Text
- in file Text.inc, class Text
The Text complex data type
- Timestamp
- in file Timestamp.inc, class Timestamp
The Timestamp complex data type
v
- $validationRule
- in file Sequence.inc, variable Sequence::$validationRule
The validation rule for the Sequence type
- $value
- in file DEnumItem.inc, variable DEnumItem::$value
The value that will appear in the drop-down.
- $value
- in file DEnum.inc, variable DEnum::$value
The currently selected DEnum option
z
- zeroPad
- in file Integer.inc, method Integer::zeroPad()
Returns the integer value provided but padded with zeros to MAX_SIZE
|
|