CFC Reference
Below are listed the default CFC methods that are created for each table. Your CFC's may contain additional methods,
due to either stored procedures that you create or, additional methods you add to your static objects.
Gateway Object Methods
- init
- This is the pseudo constructor that allows us to play little object games.
- Parameters
- datasource
- string
The datasource for database operations.
- dbusername
- string
The database username for database operations.
- dbpassword
- string
The database password for database operations.
- list
- This function retrieves a list of entry(s) from the database.
- list_by_categoryID
- This function retrieves a list of entry(s) from the database.
- Parameters
- categoryID
- numeric
- list_by_commentId
- This function retrieves a list of entry(s) from the database.
- Parameters
- commentId
- numeric
- list_foreign_key_labels
- This function retrieves the primary key and foreign key label of entry(s). Used in building select boxes.
- list_with_FK
- This function retrieves a list of entry(s) from the database with foreign key labels in place of foreign keyed columns.
- listDisplay
- This function will handle returning the correct information to deal with foreign keys.
- search
- This function performs a search for entry(s) based on input parameters.
- Parameters will consist of columns from the database table.
DAO Object Methods
- init
- This is the pseudo constructor that allows us to play little object games.
- Parameters
- datasource
- string
The datasource for database operations.
- dbusername
- string
The database username for database operations.
- dbpassword
- string
The database password for database operations.
- Commit
- Takes an instance of a business object, and persists the object's properties back to the database via internal CRUD methods.
- Parameters
- ObjInstance
An instance of a business object to persist back to the database.
- create
- This function inserts a single entry record into the database.
- Parameters will consist of columns from the database table.
- describe
- This function will describe the data in the table this cfc represents.
- destroy
- This function deletes a single entry record from the database.
- Parameters will consist of columns from the database table.
- read
- This function retrieves a single entry record from the database.
- Parameters will consist of columns from the database table.
- read_with_FK
- This function retrieves a single entry record from the database with foreign key labels in place of foreign keyed columns.
- Parameters will consist of columns from the database table.
- readDisplay
- This function will handle returning the correct information to deal with foreign keys.
- Parameters
- id
- numeric
- sample
- This function will create a sample blank record from the database.
- update
- This function updates a single entry record from the database.
- Parameters will consist of columns from the database table.
Business Object Methods
- init
- Initializes the object, populates properties with a persisted object values when a key value is passed in.
- Parameters
- DAO
- any
The DAO which to manipulate. Used this was to encourage use of singleton dao's in teh application scope.
- KeyValue
- any
Primary key value, pass in to load an existing object from the database
- FormValues
- struct
- WithLinks
- boolean
Whether or not to read in tables with FK links.
- Commit
- Persists object state back to the database.
- Destroy
- Remove object from the database.
- formImageProcessor
- Takes a input form structure and handles turning input image into cfimage objects for use with image crud.
- Parameters
- formValues
- struct
The form to manipulate.
- Get
- Public method for getting cfc property values.
- Parameters
- PropertyName
- string
The name of the property to be gotten.
- New
- Empties all object properties.
- ObjectState
- Diagnostic function -- returns a snapshot struct of the object's current state.
- Refresh
- If a key field is set properties are refreshed from the database. If not, properties are emptied. WARNING: This destroys any uncomitted changes made to the object.
- Set
- Public method for setting cfc property values.
- Parameters
- PropertyName
- string
The name of the property to be set.
- PropertyValue
- any
The value to set the property.