Difference between revisions of "CEData 1 0-getCEData"

From ADF Docs
Jump to: navigation, search
(→‎Examples)
(→‎Usage:)
Line 128: Line 128:
 
</source>
 
</source>
  
−
Example 3a: Use getCEData(queryType='searchInList') to return the records that match the provided value with any of the items stored in a list as the value of the specified CE field:
+
Example 3: Use getCEData to return only the records that match a comma-delimited list of provided values for a specific field (similar to a SQL 'IN' clause):
 +
<source lang="cfm">
 +
A example of three records stored in the "My Element" custom element:
 +
Record 1:
 +
  uniqueID: DF6D9B32-1143-FF53-952805B368AB301B
 +
  Title: 'Record 1'
 +
Record 2:
 +
  uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
 +
  Title: 'Record 2'
 +
Record 3:
 +
  uniqueID: 1BC95CDE-DFBC-047C-2011FC37BE5F6A22
 +
  Title: 'Record 3'
 +
</source>
 +
 
 +
<source lang="cfm">
 +
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
 +
    data = application.ADF.ceData.getCEData(
 +
                      customElementName="My Element",
 +
                      customElementFieldName="uniqueID",
 +
                      item='DF6D9B32-1143-FF53-952805B368AB301B,122FFB4E-C95E-77C1-D217186D857F2228',
 +
                      queryType="selected"
 +
                      );
 +
</cfscript>
 +
</source>
 +
 
 +
Example 4: Use getCEData to return only the records that match a comma-delimited list of provided values for a specific field (similar to a SQL 'IN' clause):
 +
<source lang="cfm">
 +
A example of three records stored in the "My Element" custom element:
 +
Record 1:
 +
  uniqueID: DF6D9B32-1143-FF53-952805B368AB301B
 +
  Title: 'Record 1'
 +
Record 2:
 +
  uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
 +
  Title: 'Record 2'
 +
Record 3:
 +
  uniqueID: 1BC95CDE-DFBC-047C-2011FC37BE5F6A22
 +
  Title: 'Record 3'
 +
</source>
 +
 
 +
<source lang="cfm">
 +
From the example 4 data above, this will return Record 3
 +
<cfscript>
 +
    // get data from the "My Element" custom element by a uniqueID value
 +
    data = application.ADF.ceData.getCEData(
 +
                      customElementName="My Element",
 +
                      customElementFieldName="uniqueID",
 +
                      item='DF6D9B32-1143-FF53-952805B368AB301B,122FFB4E-C95E-77C1-D217186D857F2228',
 +
                      queryType="notselected"
 +
                      );
 +
</cfscript>
 +
</source>
 +
 
 +
Example 5: Use getCEData(queryType='searchInList') to return the records that match the provided value with any of the items stored in a list as the value of the specified CE field:
  
 
<source lang="cfm">
 
<source lang="cfm">
Line 141: Line 195:
  
 
<source lang="cfm">
 
<source lang="cfm">
−
From the 3a example data above, this will only return Record 1
+
From the example 5 data above, this will only return Record 1
 
<cfscript>
 
<cfscript>
 
     // get data from the "My Element" custom element  
 
     // get data from the "My Element" custom element  
Line 153: Line 207:
 
</source>
 
</source>
  
−
Example 3b: 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:  
+
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:  
  
 
<source lang="cfm">
 
<source lang="cfm">
Line 169: Line 223:
  
 
<source lang="cfm">
 
<source lang="cfm">
−
From the 3b example data above, this will return Record 1 and Record 3
+
From the example 6 data above, this will return Record 1 and Record 3
 
<cfscript>
 
<cfscript>
 
     // get data from the "My Element" custom element  
 
     // get data from the "My Element" custom element  

Revision as of 21:07, 1 October 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 the data as an Array of Structures for the element specified.

queryType options:

  • selected
  • notSelected
  • search
  • multi
  • versions
  • list
  • numericList
  • greaterThan
  • between
  • searchInList

Usage:

Example 1: Use getCEData to return ALL records in a Custom Element: 

<cfscript>
     // get data from the "My Element" custom element 
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element"
                      );
</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 --->
    <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
</cfloop>

Example 2: Use getCEData to return only the records that match the provided value for a specific field: 

<cfscript>
     // get data from the "My Element" custom element by a uniqueID value
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element",
                       customElementFieldName="uniqueID",
                       item='DF6D9B32-1143-FF53-952805B368AB301B'
                      );
</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 --->
    <cfoutput>#data[itm].values.uniqueID# #data[itm].values.Title#</cfoutput>
</cfloop>

Example 3: Use getCEData to return only the records that match a comma-delimited list of provided values for a specific field (similar to a SQL 'IN' clause): 

A example of three records stored in the "My Element" custom element: 
Record 1:
  uniqueID: DF6D9B32-1143-FF53-952805B368AB301B
  Title: 'Record 1' 
Record 2:
   uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
   Title: 'Record 2' 
Record 3:
  uniqueID: 1BC95CDE-DFBC-047C-2011FC37BE5F6A22
  Title: 'Record 3'
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
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element",
                       customElementFieldName="uniqueID",
                       item='DF6D9B32-1143-FF53-952805B368AB301B,122FFB4E-C95E-77C1-D217186D857F2228',
                       queryType="selected"
                      );
</cfscript>

Example 4: Use getCEData to return only the records that match a comma-delimited list of provided values for a specific field (similar to a SQL 'IN' clause): 

A example of three records stored in the "My Element" custom element: 
Record 1:
  uniqueID: DF6D9B32-1143-FF53-952805B368AB301B
  Title: 'Record 1' 
Record 2:
   uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
   Title: 'Record 2' 
Record 3:
  uniqueID: 1BC95CDE-DFBC-047C-2011FC37BE5F6A22
  Title: 'Record 3'
From the example 4 data above, this will return Record 3
<cfscript>
     // get data from the "My Element" custom element by a uniqueID value
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element",
                       customElementFieldName="uniqueID",
                       item='DF6D9B32-1143-FF53-952805B368AB301B,122FFB4E-C95E-77C1-D217186D857F2228',
                       queryType="notselected"
                      );
</cfscript>

Example 5: Use getCEData(queryType='searchInList') to return the records that match the provided value with any of the items stored in a list as the value of the specified CE field: 

A example of two records stored in the "My Element" custom element:
Record 1:
  uniqueID: DF6D9B32-1143-FF53-952805B368AB301B
  csPageIDList: 2011,3010,4808,1660,3710
Record 2:
  uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
  csPageIDList: 2011,3010,1660,3710
From the example 5 data above, this will only return Record 1
<cfscript>
     // get data from the "My Element" custom element 
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element",
                       customElementFieldName="csPageIDList",
                       item='4808',
                       queryType='searchInList'
                      );
</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: 

A example of three records stored in the "My Element" custom element: 
Record 1:
  uniqueID: DF6D9B32-1143-FF53-952805B368AB301B
    csPageIDList: 2011,3010,4808,1660,3210 
Record 2:
  uniqueID: 122FFB4E-C95E-77C1-D217186D857F2228
  csPageIDList: 2011,3010,1660,3210 
Record 3:
  uniqueID: 1BC95CDE-DFBC-047C-2011FC37BE5F6A22
  csPageIDList: 2011,3010,3780,1660,9884
From the example 6 data above, this will return Record 1 and Record 3
<cfscript>
     // get data from the "My Element" custom element 
     data = application.ADF.ceData.getCEData(
                       customElementName="My Element",
                       customElementFieldName="csPageIDList",
                       item='3780,4808',
                       queryType='searchInList'
                      );
</cfscript>
Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=CEData_1_0-getCEData&oldid=4261"