Top level element for the xml file
Configure any include files that are used in the configuration of Transfer
Configure the settings for all object caching parameters.
If this is not set, the default values are used. More details on caching can be found at Using Caching
Configure the default null values for properties
All the Object definitions
Defines the keys that Transfer stores it's caching when using caching in shared scopes. If this is not set, the default values are used.
The scope key for 'application' cached objects, if not set, all caching is done under the 'application.transfer' scope.
The scope key for 'session', and cached objects, if not set, all caching is done under the 'session.transfer' scope. This also applies to 'transaction' scoped objects, as these caches share these scopes.
he scope key for 'request' cached objects, if not set, all caching is done under the 'request.transfer' scope.
The scope key for 'server' cached objects, if not set, all caching is done under the 'server.transfer' scope.
This sets the default values for caching of objects within Transfer. If this is not set, the default values are used.
This overwrites the default settings for caching for a specific class
The class to set the caching settings for
The maximum number of objects to store for any one Object class.
The number of TransferObjects to cache, defaults to unlimited (0).
The maximum number of minutes to store any TransferObject of a given class.
The number of minutes to cache, defaults to unlimited (0).
The number of minutes in which a TransferObject will timeout in, if it has not been accessed.
Number of minutes until cache timeout, defaults to having no effect (0)
The scope to store all TransferObjects under. Details on the types of caching available can found at Using Caching.
'instance', 'application', 'session', 'request', 'transaction', 'server', 'none'. Defaults to 'instance'.
The key to set the cache under, e.g. 'transfer'
The default null value for all string types. Defaults to ''.
The default null value for all numeric types. Defaults to 0.
The default null value for all date types.
The default null value for all boolean types. Defaults to 1/1/100.
The default null value for all UUID types. Defaults to '00000000-0000-0000-0000000000000000'.
The default null value for all GUID types. Defaults to '00000000-0000-0000-0000-000000000000'.
The default null value for all binary types. (Whatever is written here is converted to a Java binary array). Defaults to empty binary array.
The null value to use.
Organisational element to store various objects of similar aspect together
A class definition for a transfer.com.TransferObject to be manufactured into a bean that represents a record in the set database table.
This is the definition of the primary key as set in the database.
This results in getter and setter functions on the TransferObject. Details on all these methods can be found at generated methods.
There can only be one ID declaration, but either 'id' or 'compositeid' must be present.
A composite key declaration, which contains any combination of foreign key relationships and/or property values.
This results in a 'getCompositeID()' function on the TransferObject. Details on all these methods can be found at generated methods.
There can only be one compositeid declaration, but either 'id' or 'compositeid' must be present.
A single property on the TransferObject.
This results in getter and setter functions on the TransferObject. Details on these methods can be found at generated methods.
TransferObjects can have multiple property declarations.
This defines a relationship when many of a this object's table records link directly to one of another tables. e.g. 'tbl_User.lnkIDPermission = tbl_Permission.IDPermission'.
It creates getter and setter functions on the TransferObject that get and set the composite TransferObject. Details on these methods can be found at generated methods.
TransferObjects can have multiple manytoone declarations.
Defines what other TransferObject the composition is made up of.
The name of this relationship, e.g. 'Permission'.
If this is set to 'true', the manytoone composition will only be loaded when requested. This defaults to 'false'.
If this is set to 'true', only a proxy of the TransferObject will be loaded, rather than the full object data, for each TransferObject.
Default is 'false'.
This defines a relationship where one of this object's table records corresponds to many of another tables records. e.g. 'tbl_User.IDUser = tbl_Post.lnkIDUser'.
This creates several methods on the parent and child TransferObjects, dependent on the set collection type. Details on all these methods can be found at generated methods.
TransferObjects can have multiple one to many declarations.
name The name of this collection, e.g. 'Permission'.
Defines the TransferObject the composition is made up of.
This element sets the details of the type of collection of TransferObject that is added to the parent.
The name of this collection, e.g. 'Permission'.
If this is set to 'true', the onetomany composition will only be loaded when requested. This defaults to 'false'.
If this is set to 'true', only a proxy of the TransferObject will be loaded, rather than the full object data, for each TransferObject.
Default is 'false'.
This defines a relationship where many of this object's table records corresponds to many of another tables. This is normally accomplished at a database level by use of an intermediary linking table. e.g. 'tbl_User.IDUser = lnk_UserPermssion.lnkIDUser AND lnk_UserPermission.lnkIDPermission = tbl_Permission.IDPermission'.
This creates several methods on the parent TransferObject, dependent on the set collection type. Details on all these methods can be found at generated methods.
TransferObjects can have multiple manytomany declarations.
The first link specifies the connection information for the intermediary table to the parent table.
The second link defines the TransferObject the composition is made up of.
This element sets the details of the type of collection of TransferObject that is added to the parent.
The name of this collection, e.g. 'Permission'.
The name of the intermediary table that creates the many to many relationship. e.g. 'lnk_UserPermission'
This is an table alias that will be used for get() operations in Transfer.
This is usually most useful for Oracle when the generated alias is over 30 characters.
If this is set to 'true', the manytomany composition will only be loaded when requested. This defaults to 'false'.
If this is set to 'true', only a proxy of the TransferObject will be loaded, rather than the full object data, for each TransferObject.
Default is 'false'.
A cfml function that you want added to this TransferObject.
TransferObjects can have multiple function declarations.
Details on custom methods can be found at custom methods.
The name of the TransferObject, e.g. 'User'.
The database table that the TransferObject refers to, e.g. 'tbl_User'. Defaults to the value of @name
Specifically for Oracle and PostGreSQL support. This is the name of the sequence that corresponds with this object's table. Defaults to the value of @table + '_seq'
Specify the Decorator CFC that will wrap around this TransferObject.
This object must extend transfer.com.TransferDecorator.
More details on Decorators can be found at Creating Decorators.
This is an table alias that will be used for get() operations in Transfer.
This is usually most useful for Oracle when the generated alias is over 30 characters.
The name of the ID, e.g. 'IDUser'
The typing of the primary key, either numeric, string, date, boolean, UUID, GUID.
The primary key column on the table of this TransferObject. e.g. 'IDUser'. Defaults to the value of @name.
If this is set to true, Transfer will generate the primary key when the record is inserted into the database.
Otherwise it will assume that the primary key is automatically generated by the database.
Transfer currently supports generating numeric, UUID, and GUID IDs. Defaults to false.
The property to use in this composite id
The name attribute matches the name attribute of a configured property within the object
The manytoone relationship to use in this composite id. This represents the usage of a foreign key in the composite id.
The name attribute matches the name element of a configured manytone element within the object
The parent onetomany relationship to use in this composite id. This represents the usage of a foreign key in the composite id.
The class attribute matches the class name of a object that has a onetomany composite element that points to this object.
The name of the property, e.g. 'Name'
The type of the property. Either numeric, string, date, boolean, UUID, GUID.
If this is set to 'false' the setter function has a scope of private. Defaults to 'true'.
The column on the table this property refers to, e.g. 'user_Name'. Defaults to the value of @name
Will ignore this property when performing an insert of this object into its table.
This will query the database for the value of this column and refresh its state after an insert.
Will ignore this property when performing an update of this object into its table.
This will query the database for the value of this column and refresh its state after an update.
Defines whether or not values from this property can be inserted into the database as NULL values.
Overrides the default null value for this property. Only relevent if @nullable='true'.
Organisational element to store various objects of similar aspect together
A class definition for a transfer.com.TransferObject to be manufactured into a bean that represents a record in the set database table.
The name of the package
The class name of the TransferObject this links to, e.g. 'user.Permission'.
The column on the child TranferObject table that is the foreign key, e.g. lnkUserID.
Used to place a filtering condition on the child elements that are retrieved from the database.
The property on the child object to filter by.
(required if property has a value) The value of the property to filter by.
(required if property/value is not set)
The SQL statement to filter the child object by. Child properties enclosed with '{}' will be resolved to their column names.
(if collection[@type] = 'struct')
The property to be used in the key when adding and retrieving items from parent.
This property much have a unique value.
The name of the property on the child TransferObject to be used as the key, e.g. 'permissionName'.
(optional if collection[@type] = 'array')
The order in which to sort the collection.
The name of the property on the child TransferObject to sort the array by.
The order to sort by, either 'asc' or 'desc'.
Either 'struct' or 'array'.
If 'struct' is selected, a structure is used to manage the composite TransferObjects,
whereas an array is used when the type is set to 'array'.
A defined argument for the function
A Function can have multiple function declarations.
The name of the argument
The type of the argument
If the argument is required, defaults to 'false'.
The default value for this argument if it is not set.
The cfml body of the function. It may be neccessary to utilise a CDATA declaration in this area.
There can only be one body declaration per function.
The name of the argument
Access of the function, public, private or package.
Type of what is returned by this function.
This is an include of a Transfer configuration file.
The relative path from your application root to the include file.
Whether or not to overwrite the previous configurations. Defaults to 'false'.
This is an table alias that will be used for get() operations in Transfer.
This is usually most useful for Oracle when the generated alias is over 30 characters.