cfcomponent

Overview ColdFusion Open BlueDragon Lucee

Creates and defines a component object; encloses functionality that you build in CFML and enclose within cffunction tags. This tag contains one or more cffunction tags that define methods. Code within the body of this tag, other than cffunction tags, is executed when the component is instantiated.

Attributes

Name Required Type Default Description
9
accessors No Boolean If set to false, ColdFusion ORM does not generate the implicit getters and setters.
9
3
alias No String Specifies the type label to give the object when it is converted from CFML to ActionScript 3. It matches the alias attribute of AS3 types. This is attribute applies only to Flash Remoting and LiveCycle Data Services value objects, and lets you work with typed objects in both ColdFusion and Flash.
10
autoindex No Boolean false If false, auto-indexing of CFC does not occur. The value set here overrides the value defined in the Application.cfc
9
batchsize No Numeric An integer value that specifies the number of records to be retrieved at a single instance.
bindingname No String Specifies the name of the binding element in the WSDL. This attribute applies only when style="document".
9
cacheName No String Specifies name of the secondary cache.
9
cacheUse No String Specifies the caching strategy to be used for caching this component's data in the secondary cache
9
catalog No String Used to specify the database catalog name.
11
client No Boolean Specifies if this CFC is a client side CFC
10
consumes No String The Default Consumes value used by all the CFFunctions defined in the CFC
9
datasource No String Datasource to use for this CFC. If you do not specify a datasource, the default datasource is used for that CFC.
9
discriminatorColumn No String Defines the discriminator column to be used in inheritance mapping
9
discriminatorValue No String Defines the discriminator value to be used in inheritance mapping
display No
displayname No String A string to be displayed when using introspection to show information about the CFC. The information appears on the heading, following the component name. If the style attribute is set to document, the displayname attribute is used as the name of the service element in the WSDL.
9
dynamicinsert No Boolean false Specifies whether INSERT SQL is to be generated at runtime.Only those columns whose values are not null are included in the SQL.
9
dynamicupdate No Boolean false Specifies whether UPDATE SQL is to be generated at runtime.Only those columns whose values are not null are included in the SQL.
9
embedded No Boolean Marks CFC as embeded
9
entityName No String Specifies the name of the entity. Entity name is the name used by the ORM related functions to work with the persistent CFC. If entityName is not specified, then the CFC name is taken as the entityName. The entityName must be unique in the application.
extends No String Name of parent component from which to inherit methods and properties.
hint No String Text to be displayed when using introspection to show information about the CFC. The hint attribute value appears below the component name heading. This attribute can be useful for describing the purpose of the parameter. If the style attribute is set to document, the hint attribute is used as the document element of the service in the WSDL.
10
httpMethod No String The default HttpMethod value used by all the CFFunctions defined in the CFC
8
implements No String Name of the ColdFusion interface or interfaces that this component implements. If the component implements an interface, it must define all the functions in the interface, and the function definitions must conform to the definitions specified in the interface. For more information, see cfinterface. A component can implement any number of interfaces. To specify multiple interface, use a comma delimited list, of the format interface1,interface2.
10
indexable No Boolean false If true, marks the column for indexing. Except in the case of PK and compositekey (which are indexed if any of the non-PK property is set to indexed), the default value is false
10
indexLanguage No String Specify the language that is used to index and search. The value overrides the value defined in cfcomponent and the Application.cfc
9
initmethod No String Method that will be called when ColdFusion instantiates the component
9
joinColumn No String Defines the join column for inheritance mapping.
9
lazy No Boolean true If true, the component loads lazily.
9
3
mappedSuperClass No Boolean false If set to true on a non-persistent CFC, child CFCs can inherit its properties. For instance, you can define a base cfc with common properties such as ID, version, or createdOn which all other persistent CFCs would extend and thus get one common behavior.MappedSuperClass attribute can not be set to true on a persistent CFC.
name No String Name for the component
namespace No String Specifies the namespace used in the WSDL when using the CFC as a document-literal style web service. If you don't specify this attribute, ColdFusion MX derives the namespace from the CFC class name. This attribute applies only when style="document".
9
optimisticlock No String version Determines the locking strategy.It can be any one of the following four values:noneversiondirtyall
output No Boolean Specifies whether constructor code in the component can generate HTML output; does not affect output in the body of cffunction tags in the component.
9
3
persistent No Boolean Specifies CFC is persistent or not
porttypename No String Specifies the name of the porttype element in the WSDL. This attribute applies only when style="document".
10
produces No String The Default Produces value used by all the CFFunctions defined in the CFC
9
readonly No Boolean Specify whether table is readonly or not
10
rest No Boolean false Enables the CFC as root rest resource.
10
restPath No String Specifies the URI path that a resource CFC will serve requests for
9
rowid No String Row id
9
saveMapping No Boolean false Specifies whether the generated Hibernate mapping file has to be saved to disk. If you set the value to true, the Hibernate mapping XML file is saved with the filename "CFC name".hbm.xml in the same directory as the CFC.
9
schema No String Used to specify the schema name.
9
selectbeforeupdate No Boolean Specify whether Hibernate should never perform an SQL UPDATE unless it is certain that an object is actually modified.In cases when a transient object is associated with a new session using update(), Hibernate performs an extra SQL SELECT to determine if an UPDATE is actually required.
9
serializable No Boolean Specifies whether this component can be serialized. If you set this value to false, the component and the data in the component’s This and Variables scopes cannot be serialized, so they are not retained on session replication, and the component is in its default state.
8
3
serviceaddress No String Specifies the SOAP URL of the web service.
serviceportname No String Specifies the name of the port element in the WSDL. This attribute applies only when style="document".
style No String rpc Specifies whether a CFC used for web services uses RPC-encoded style or document-literal style: - rpc: RPC-encoded style, default - document: Document-literal style If you specify document, you must also specify the namespace, serviceportname, porttypename, and bindingname attributes.
synchronized No
9
table No String Specifies the name of the database table to which the CFC maps.
type No The type of this CFC; component, interface or abstract
wsdlfile No String A properly formatted WSDL file to be used instead of WSDL generated by ColdFusion MX. This attribute applies only when style="document".
10
wsversion No String Specifies version of the Axis engine to be used. If the wsversion is "1" then Axis 1 will be used else if it is "2" then axis 2 will be used