Publishers of technology books, eBooks, and videos for creative people

Home > Articles > Web Design & Development > Adobe ColdFusion

Working with ColdFusion 8's Advanced Components

This sample chapter from the best-selling Adobe ColdFusion 8 Web Application Construction Kit, Volume 2: Application Development takes you through many of the advanced features of ColdFusion Components.
This chapter is from the book


  • Specifying Data Types and Type Checking
  • Managing Components
  • Working with Inheritance
  • Defining Interfaces
  • Implementing Security
  • Using the OnMissingMethod Method
  • Distributed CFCs, Serialization, and ColdFusion 8
  • CFC Good Practices

The previous chapter covered the basics of ColdFusion Components: how to create them, use them, store data in them, and make them persist. But you can do a lot more with ColdFusion Components. This chapter presents many of the more advanced features of ColdFusion Components, including inheritance, security, type checking, and serialization. This chapter also covers a few features of components new to ColdFusion 8.

Specifying Data Types and Type Checking

As mentioned in the previous chapter, methods in ColdFusion Components can return types through the use of the returntype attribute of cffunction. Consider this example:

<cffunction name="listFilms" returnType="query" output="false">

Here, the method must return a variable with a data type of query. Any other return type would cause an error. For example, it might make sense to return a value of the Boolean false because no valid query could be returned, but that would throw an error. Instead, you'd want to return an empty query or throw a custom error.

You can also specify data types as arguments for methods. In any cfargument, you can specify the type that your method must return (just as with cfparam). This specification can prevent you from having to create a lot of custom error-handling code in your application to check the data types of arguments passed in, and it also helps in introspection (covered in more depth later in this chapter and also in Chapter 26, "Building Reusable Components"). In addition, the cfproperty tag allows you to document for introspection local variables and define a type that the arguments will have for self-documentation.

The data type attributes of cffunction and cfargument are required when creating Web services (see Chapter 68, "Creating and Consuming Web Services," in Adobe ColdFusion 8 Web Application Construction Kit, Volume 3: Advanced Application Development, for more information).

Table 27.1 lists the allowed data types.

Table 27.1. Type Values Used for returntype (cffunction) and type (cfargument, cfproperty)




Can be any type.


ColdFusion Array complex data type.


String of 1s and 0s.


Can be 1, 0, true, false, yes, or no.


Any value that can be parsed into a date. Note that POP dates (see the ParseDateTime function) and time zones are not accepted, but simple timestamps and ODBC formatted dates and times are accepted.


The argument must be a UUID or GUID of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where each x is a character representing a hexadecimal number (0-9A-F)


Integer or float.


ColdFusion Query Result Set.


ColdFusion String simple data type.


ColdFusion Struct complex data type.


The argument must be a ColdFusion UUID of the form xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx where each x is a character representing a hexadecimal number (0-9A-F).


A string formatted according to ColdFusion variable naming conventions (a letter, followed by any number of alphanumeric characters or underscores).


Does not return a value.

If anything else is specified as a return type, ColdFusion processes it as returning a component for which properties have been defined. This technique allows components to define complex types for Web services. Chapter 67, "Using Server-Side HTTP and FTP," in Vol. 3, Advanced Application Development, discusses this feature in depth. Typically, though, the standard data types will suffice.

Our Actors master-detail application has two data-access actions—currently each one a cfquery on each of the two CFML pages. Our Actors component, then, will have two methods, each defined with a <cffunction> tag. <cffunction> uses the same introspection attributes as <cfcomponent>: displayname and hint.

Another attribute, output, can be set to "no" if your function doesn't write anything out. This works like a virtual <cfsilent> tag, and causes all the whitespace in a pure code function to be discarded by ColdFusion. If you set it to "yes", your function works as if the entire function is wrapped in a <cfoutput> tag, and anything in number signs (#) will be interpreted as ColdFusion variables. If you don't specify the output attribute, it works like any other ColdFusion code—you need to either wrap output in <cfoutput> or use the WriteOutput() function.

Finally, there are two additional arguments you can use when defining components in ColdFusion: roles, used to secure functionality by user; and access, used to hide implementation details. We'll come back to these later in this chapter.

Using the GetMetaData() Function

You can dump a component with cfdump. For example, you can dump FilmRotationCFC.cfc from the previous chapter as shown here:

<cfobject component="FilmRotationCFC" name="cfcFilmRotation">
<cfdump var="#cfcFilmRotation#">

The result is shown in Figure 27.1.

Figure 27.1

Figure 27.1 The cfdump output for a component.

As you can see, the dump shows the component's methods and instance data. This data can be useful to your code. ColdFusion provides a means to programmatically examine an instance of a component to get this data: the getMetaData() function. The getMetaData() function returns a structure containing the same information that you can see in the HTML view of a component that cfdump provides.

There are two syntaxes for using the getMetaData() function. From outside of a component, pass the function a reference to the component object. Within a component, pass the function the component's own scope keyword THIS. So, for example, the code

<cfobject component="FilmRotationCFC" name="cfcFilmRotation">
<cfdump var="#getMetaData(cfcFilmRotation)#">

will produce a structure similar to that shown in Figure 27.2.

Figure 27.2

Figure 27.2 The cfdump output for getMetaData().

With this data, you could produce component HTML documentation in whatever form you wish, simply by accessing the information in the structure. This approach can be useful when you want to check the properties of a component that's been passed into a function or verify whether a method is implemented in it. This specification is demonstrated in Listing 27.1.

Listing 27.1. getMetaData.cfm—Display Data Using getMetaData()

  Demonstrate use of getMetaData() function
<!--- instantiate the FilmRotationCFC object into cfcfilmRotation --->
<cfobject component="FilmRotationCFC" name="cfcFilmRotation">
<!--- now get the metadata, into the ourMetaData function --->
<cfset ourMetaData = getMetaData(cfcFilmRotation)>

<!--- Show the displayName and size; we could also show the hint,
  path, etc. --->
<h3>Welcome to the #ourMetaData. Name#!</h3>
Enjoy our #arrayLen(ourMetaData.functions)# functions:
<!--- loop through and show each function's name; could also show
   hint, parameters array, etc. but let's keep it simple. --->
<cfloop index="thisFunction" from="1" to="#arrayLen(ourMetaData.functions)#">
<li>#ourMetaData.functions[thisFunction]. Name#</li>

Peachpit Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Peachpit and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Peachpit products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive:

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020