CEData 1 0-getCEData - Revision history

Gcronkright: /* Usage: */

2015-07-07T19:40:40Z

‎Usage:

Gcronkright: /* Usage: */

2015-07-07T19:39:34Z

‎Usage:

Gcronkright: /* Usage: */

2015-07-07T19:37:54Z

‎Usage:

Gcronkright: /* Usage: */

2015-07-07T18:14:58Z

‎Usage:

Show changes

Gcronkright: /* Usage: */

2015-07-07T18:08:46Z

‎Usage:

Mcarroll: /* Usage: */

2011-03-28T12:25:19Z

‎Usage:

Mcarroll: /* Usage: */

2011-03-28T12:20:59Z

‎Usage:

Mcarroll: /* Usage: */

2011-03-28T12:20:18Z

‎Usage:

Gcronkright: /* Usage: */

2010-11-09T14:56:48Z

‎Usage:

Ssmith at 17:50, 19 October 2010

2010-10-19T17:50:38Z

@@ Line 126: / Line 126: @@
      <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
   </cfloop>
 Example 3: Use getCEData(queryType='selected') to return only the records that match a comma-delimited list of provided values for a specific field (similar to a SQL 'IN' operator):
@@ Line 150: / Line 151: @@
                        );
   </cfscript>
 Example 4: Use getCEData(queryType='notselected') to return only the records that '''DO NOT''' match a comma-delimited list of provided values for a specific field (similar to a SQL 'NOT IN' operator):
@@ Line 177: / Line 179: @@
    uniqueID: 1BC95CDE-DFBC-047C-2011FC37BE5F6A22
    csPageIDList: 2011,3010,3780,1660,9884
   From the example 5 data above, this will only return Record 1
@@ Line 189: / Line 190: @@
                        );
   </cfscript>
 Example 6: Use getCEData(queryType='searchInList') to return the records that match the any of the provided values from a list with any of the items stored in a list as the value of the specified CE field:
@@ Line 202: / Line 204: @@
                        );
   </cfscript>
 Example 7: Use getCEData(queryType='search') to return the records that match at least part of the value of the CE field specified in the 'searchFields' attribute. Specifying querytype of "search" is only for finding records with a specific value in the field, whereas "searchInList" is for finding one or more values in the field.
@@ Line 215: / Line 218: @@
                        );
   </cfscript>
 Example 8: Use getCEData(queryType='multi') to return the records that match multiple fields in the CE record.  The 'searchFields' argument will contain the list of CE fields to search and the 'searchValues' argument is a one-to-one match for the 'searchFields' list.  In the example below, the filter criteria is interpreted as 'department=Science AND building=Adams Hall".

@@ Line 102: / Line 102: @@
                        );
   </cfscript>
-  <!---// loop over results (All the records from the Custom Element)  --->
   <cfloop from="1" to="#arrayLen(data)#" index="itm">
-     <!---// renders data from the uniqueID and Title fields from the element --->
+     &lt;!---// renders data from the uniqueID and Title fields from the element ---&gt;
      <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
   </cfloop>
@@ Line 119: / Line 120: @@
                        );
   </cfscript>
-  <!---// loop over results (Only the records that matched the criteria)  --->
   <cfloop from="1" to="#arrayLen(data)#" index="itm">
-     <!---// renders data from the uniqueID and Title fields from the element --->
+     &lt;!---// renders data from the uniqueID and Title fields from the element ---&gt;
      <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
   </cfloop>

@@ Line 102: / Line 102: @@
                        );
   </cfscript>
   <!---// loop over results (All the records from the Custom Element)  --->
   <cfloop from="1" to="#arrayLen(data)#" index="itm">
@@ Line 120: / Line 119: @@
                        );
   </cfscript>
   <!---// loop over results (Only the records that matched the criteria)  --->
   <cfloop from="1" to="#arrayLen(data)#" index="itm">
@@ Line 140: / Line 138: @@
    Title: 'Record 3'
-From the example 3 data above, this will return Record 1 and Record 2
+ From the example 3 data above, this will return Record 1 and Record 2
   <cfscript>
       // get data from the "My Element" custom element by a uniqueID value

@@ Line 95: / Line 95: @@
 === Usage: ===
 Example 1: Use getCEData(queryType='selected') to return ALL records in a Custom Element:
-<source lang="cfm">
-<cfscript>
+ <cfscript>
       // get data from the "My Element" custom element
       data = application.ADF.ceData.getCEData(
                         customElementName="My Element"
                        );
-</cfscript>
+ </cfscript>
-<!---// loop over results (All the records from the Custom Element)  --->
+ <!---// loop over results (All the records from the Custom Element)  --->
-<cfloop from="1" to="#arrayLen(data)#" index="itm">
+ <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>
+ </cfloop>
-</source>
 Example 2: Use getCEData(queryType='selected') to return only the records that match the provided value for a specific field:

@@ Line 228: / Line 228: @@
 </source>
-Example 8: Use getCEData(queryType='multi') to return the records that match multiple fields in the CE record.
+Example 8: Use getCEData(queryType='multi') to return the records that match multiple fields in the CE record.  The 'searchFields' argument will contain the list of CE fields to search and the 'searchValues' argument is a one-to-one match for the 'searchFields' list.  In the example below, the filter criteria is interpreted as 'department=Science AND building=Adams Hall".
 <source lang="cfm">

@@ Line 238: / Line 238: @@
    Building: Adams Hall
 Record 2:
-   uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
+  uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
-   Title: 'Record 2'
+  Title: 'Record 2'
-   Department: Math
+  Department: Math
-   Building: Washington Hall
+  Building: Washington Hall
 Record 3:
    uniqueID: 1BC95CDE-DFBC-047C-2011FC37BE5F6A22

@@ Line 213: / Line 213: @@
 </source>
-Example 7: Use getCEData(queryType='search') to return the records that exactly match the value of the specified CE field. Specifying querytype of "search" is only for finding records with a specific value in the field whereas "searchInList" is for finding one or more values in the field.
+Example 7: Use getCEData(queryType='search') to return the records that match at least part of the value of the CE field specified in the 'searchFields' attribute. Specifying querytype of "search" is only for finding records with a specific value in the field, whereas "searchInList" is for finding one or more values in the field.
 <source lang="cfm">
@@ Line 222: / Line 222: @@
                         customElementName="My Element",
                         searchFields="uniqueID",
-                        searchValues='DF6D9B32-1143-FF53-952805B368AB301B',
+                        searchValues='DF6D9B32',
                         queryType='search'
                        );
 </cfscript>
 </source>