Tags · Functions · Objects
Lucee Tag Reference
Choose a tag:
see all tags

Tag <CFINTERFACE>

Defines an interface that consists of a set of signatures for functions. The interface does not include the full function definitions; instead, you implement the functions in a Component. The interfaces that you define by using this tag can make up the structure of a reusable application framework.

Body

This tag must have a body.

Example

	<cfinterface
		[displayname="string"]
		[extends="string"]
		[hint="string"]>

	</cfinterface>
This tag is also supported within cfscript
	<cfscript>
		interface
		[displayname="string"]
		[extends="string"]
		[hint="string"] {

	}
	</cfscript>

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Description
displayname string No A value to be displayed when using introspection to show a descriptive name for the interface. 
extends string No A comma-delimited list of one or more interfaces that this interface extends.
Any CFC that implements an interface must also implement all the functions in the interfaces specified by this property.
If an interface extends another interface, and the child interface specifies a function with the same name as one in the parent interface,
both functions must have the same attributes; otherwise
generates an error. 
hint string No Text to be displayed when using introspection to show information about the interface.
The hint attribute value follows the syntax line in the function description.