Difference between revisions of "CEData 1 0-getCEData"

From ADF Docs
Jump to: navigation, search
Line 79: Line 79:
 
== Examples ==
 
== Examples ==
  
−
The getCEDdata function is handy way to get element data out of a CommonSpot custom element. Making a call to this method will return an Array of Structures of the data contained in the element.
+
The getCEDdata function is handy way to get data out of a CommonSpot Custom Element. Making a call to this method will return an Array of Structures of the data contained in the element specified.  
  
−
<!--
+
=== Usage ===
−
=== CE Data calls return Taxonomy Term ID ===
+
Example 1: Use getCEData to get ALL the Custom Element data:  
−
If you have Taxonomy fields inside your Custom Element and you make calls to get data for that custom Element using CEData, the Taxonomy fields will return term ID's.  You can convert those term ID's using code like this:
 
 
<source lang="cfm">
 
<source lang="cfm">
−
<cfscript>
+
<cfscript>
−
     // custom element data
+
     // get data form the "My Element" custom element  
−
     data = application.ADF.ceData.getCEData("My Element");
+
     data = application.ADF.ceData.getCEData(
−
    // returns taxonomy object
+
                      customElementName="My Element"
−
    taxObj = application.ADF.taxonomy.getCSTaxObj("My Taxonomy");
+
                      );
−
</cfscript>
+
</cfscript>
  
−
<cfloop from="1" to="#arrayLen(data)#" index="itm">
+
<cfloop from="1" to="#arrayLen(data)#" index="itm">
−
     <!---// renders the term name instead of the term id --->
+
     <!---// renders data from the uniqueID and Title fields from the element --->
−
     <cfoutput>#taxObj.getTermName(data[itm].values.myTaxField)#</cfoutput>
+
     <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
−
</cfloop>
+
</cfloop>
 
</source>
 
</source>
  
−
-->
+
Example 2: Use getCEData to get records that match provide criteria:
 +
<source lang="cfm">
 +
<cfscript>
 +
    // get data form the "My Element" custom element
 +
    data = application.ADF.ceData.getCEData(
 +
                      customElementName="My Element",
 +
                      customElementFieldName="uniqueID",
 +
                      item='DF6D9B32-1143-FF53-952805B368AB301B'
 +
                      );
 +
</cfscript>
 +
 
 +
<cfloop from="1" to="#arrayLen(data)#" index="itm">
 +
    <!---// renders data from the uniqueID and Title fields from the element --->
 +
    <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
 +
</cfloop>
 +
</source>

Revision as of 21:19, 13 August 2010

Attention: Do not change any text in the description, signature, and paramter sections.

Return to CEData_1_0

Description

Returns array of structs for all data matching the Custom Element.

Signature

public array getCEData ( string customElementName, string customElementFieldName, any item, string queryType, string searchValues, string searchFields )

Parameters

Required Name Type Description
required customElementName string
optional customElementFieldName string [Default: ]
  item any [Default: ]
  queryType string [Default: selected]
  searchValues string [Default: ]
  searchFields string [Default: ]

Examples

The getCEDdata function is handy way to get data out of a CommonSpot Custom Element. Making a call to this method will return an Array of Structures of the data contained in the element specified.

Usage

Example 1: Use getCEData to get ALL the Custom Element data: 

<cfscript>
     // get data form the "My Element" custom element 
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element"
                      );
</cfscript>

<cfloop from="1" to="#arrayLen(data)#" index="itm">
    <!---// renders data from the uniqueID and Title fields from the element --->
    <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
</cfloop>

Example 2: Use getCEData to get records that match provide criteria: 

<cfscript>
     // get data form the "My Element" custom element 
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element",
                       customElementFieldName="uniqueID",
                       item='DF6D9B32-1143-FF53-952805B368AB301B'
                      );
</cfscript>

<cfloop from="1" to="#arrayLen(data)#" index="itm">
    <!---// renders data from the uniqueID and Title fields from the element --->
    <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
</cfloop>
Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=CEData_1_0-getCEData&oldid=3973"