Difference between revisions of "CEData 1 0"
From ADF Docs
Line 15: | Line 15: | ||
== Functions == | == Functions == | ||
− | :public [[CEData_1_0-arrayOfCEDataSort|arrayOfCEDataSort]] ( array, string, string, string, string ) | + | :public [[CEData_1_0-arrayOfCEDataSort|arrayOfCEDataSort]] ( <div id='library-api'>array, string, string, string, string ) |
− | :public [[CEData_1_0-buildElementInfoStruct|buildElementInfoStruct]] ( array ) | + | :public [[CEData_1_0-buildElementInfoStruct|buildElementInfoStruct]] ( <div id='library-api'>array ) |
− | ::Builds an ElementInfo structure given a ceData array:public [[CEData_1_0-compareCEDataArray|compareCEDataArray]] ( array, array ) | + | ::Builds an ElementInfo structure given a ceData array:public [[CEData_1_0-compareCEDataArray|compareCEDataArray]] ( <div id='library-api'>array, array ) |
− | :public [[CEData_1_0-containsFieldType|containsFieldType]] ( numeric, string ) | + | :public [[CEData_1_0-containsFieldType|containsFieldType]] ( <div id='library-api'>numeric, string ) |
− | :::public [[CEData_1_0-defaultFieldStruct|defaultFieldStruct]] ( string ) | + | :::public [[CEData_1_0-defaultFieldStruct|defaultFieldStruct]] ( <div id='library-api'>string ) |
− | :public [[CEData_1_0-deleteByElementName|deleteByElementName]] ( string ) | + | :public [[CEData_1_0-deleteByElementName|deleteByElementName]] ( <div id='library-api'>string ) |
− | ::Delete the Custom Element records from the data_fieldvalue table given a Custom Element name:public [[CEData_1_0-deleteCacheInstances|deleteCacheInstances]] ( string ) | + | ::Delete the Custom Element records from the data_fieldvalue table given a Custom Element name:public [[CEData_1_0-deleteCacheInstances|deleteCacheInstances]] ( <div id='library-api'>string ) |
− | :public [[CEData_1_0-deleteCE|deleteCE]] ( string ) | + | :public [[CEData_1_0-deleteCE|deleteCE]] ( <div id='library-api'>string ) |
− | :public [[CEData_1_0-diffCEDataArray|diffCEDataArray]] ( array, array ) | + | :public [[CEData_1_0-diffCEDataArray|diffCEDataArray]] ( <div id='library-api'>array, array ) |
− | :public [[CEData_1_0-elementExists|elementExists]] ( string ) | + | :public [[CEData_1_0-elementExists|elementExists]] ( <div id='library-api'>string ) |
− | ::Determines whether or not an element exists:public [[CEData_1_0-getAllCustomElements|getAllCustomElements]] ( | + | ::Determines whether or not an element exists:public [[CEData_1_0-getAllCustomElements|getAllCustomElements]] ( <div id='library-api'> ) |
− | ::Returns all the Custom Elements for the site.:public [[CEData_1_0-getCEData|getCEData]] ( string, string, any, string, string, string ) | + | ::Returns all the Custom Elements for the site.:public [[CEData_1_0-getCEData|getCEData]] ( <div id='library-api'>string, string, any, string, string, string ) |
− | ::Returns array of structs for all data matching the Custom Element.:public [[CEData_1_0-getCEDataByFieldID|getCEDataByFieldID]] ( numeric ) | + | ::Returns array of structs for all data matching the Custom Element.:public [[CEData_1_0-getCEDataByFieldID|getCEDataByFieldID]] ( <div id='library-api'>numeric ) |
− | ::Returns Custom Element Data records for a given FieldID:public [[CEData_1_0-getCEDataField|getCEDataField]] ( numeric, numeric, string ) | + | ::Returns Custom Element Data records for a given FieldID:public [[CEData_1_0-getCEDataField|getCEDataField]] ( <div id='library-api'>numeric, numeric, string ) |
− | ::Returns the single field data value for the custom element record.:public [[CEData_1_0-getCEDataFieldUUID|getCEDataFieldUUID]] ( numeric, string, string ) | + | ::Returns the single field data value for the custom element record.:public [[CEData_1_0-getCEDataFieldUUID|getCEDataFieldUUID]] ( <div id='library-api'>numeric, string, string ) |
− | ::Returns the single field data value by the custom element UUID data value.:public [[CEData_1_0-getCEFieldValues|getCEFieldValues]] ( string, string ) | + | ::Returns the single field data value by the custom element UUID data value.:public [[CEData_1_0-getCEFieldValues|getCEFieldValues]] ( <div id='library-api'>string, string ) |
− | ::Returns all values for a particular field in a particular custom element.:public [[CEData_1_0-getCEForCategory|getCEForCategory]] ( string ) | + | ::Returns all values for a particular field in a particular custom element.:public [[CEData_1_0-getCEForCategory|getCEForCategory]] ( <div id='library-api'>string ) |
− | ::Returns a query of the CE's name and form ID that are in the Category argument.:public [[CEData_1_0-getCENameByFormID|getCENameByFormID]] ( numeric ) | + | ::Returns a query of the CE's name and form ID that are in the Category argument.:public [[CEData_1_0-getCENameByFormID|getCENameByFormID]] ( <div id='library-api'>numeric ) |
− | :public [[CEData_1_0-getCountForElementField|getCountForElementField]] ( string, string, any ) | + | :public [[CEData_1_0-getCountForElementField|getCountForElementField]] ( <div id='library-api'>string, string, any ) |
− | :::public [[CEData_1_0-getDataFieldValueByPageID|getDataFieldValueByPageID]] ( Numeric, Numeric, boolean, numeric ) | + | :::public [[CEData_1_0-getDataFieldValueByPageID|getDataFieldValueByPageID]] ( <div id='library-api'>Numeric, Numeric, boolean, numeric ) |
− | :public [[CEData_1_0-getElementFieldID|getElementFieldID]] ( numeric, string ) | + | :public [[CEData_1_0-getElementFieldID|getElementFieldID]] ( <div id='library-api'>numeric, string ) |
− | :public [[CEData_1_0-getElementFieldsByFormID|getElementFieldsByFormID]] ( Numeric ) | + | :public [[CEData_1_0-getElementFieldsByFormID|getElementFieldsByFormID]] ( <div id='library-api'>Numeric ) |
− | :public [[CEData_1_0-getElementInfoByPageID|getElementInfoByPageID]] ( Numeric, Numeric, boolean ) | + | :public [[CEData_1_0-getElementInfoByPageID|getElementInfoByPageID]] ( <div id='library-api'>Numeric, Numeric, boolean ) |
− | :public [[CEData_1_0-getElementInfoVersionsByPageID|getElementInfoVersionsByPageID]] ( Numeric, Numeric, Numeric ) | + | :public [[CEData_1_0-getElementInfoVersionsByPageID|getElementInfoVersionsByPageID]] ( <div id='library-api'>Numeric, Numeric, Numeric ) |
− | :public [[CEData_1_0-getElementVersionsForPageID|getElementVersionsForPageID]] ( Numeric, Numeric ) | + | :public [[CEData_1_0-getElementVersionsForPageID|getElementVersionsForPageID]] ( <div id='library-api'>Numeric, Numeric ) |
− | :public [[CEData_1_0-getFieldIdsByType|getFieldIdsByType]] ( string ) | + | :public [[CEData_1_0-getFieldIdsByType|getFieldIdsByType]] ( <div id='library-api'>string ) |
− | ::Returns a list of fieldID's for a given Field Type:public [[CEData_1_0-getFormIDByCEName|getFormIDByCEName]] ( string ) | + | ::Returns a list of fieldID's for a given Field Type:public [[CEData_1_0-getFormIDByCEName|getFormIDByCEName]] ( <div id='library-api'>string ) |
− | :public [[CEData_1_0-getFormIDFromPageID|getFormIDFromPageID]] ( Numeric ) | + | :public [[CEData_1_0-getFormIDFromPageID|getFormIDFromPageID]] ( <div id='library-api'>Numeric ) |
− | ::Returns the Form ID for the Page ID.:public [[CEData_1_0-getPageIDForElement|getPageIDForElement]] ( numeric, string, any, string, string, string ) | + | ::Returns the Form ID for the Page ID.:public [[CEData_1_0-getPageIDForElement|getPageIDForElement]] ( <div id='library-api'>numeric, string, any, string, string, string ) |
− | ::Returns Page ID Query in Data_FieldValue matching Form ID:public [[CEData_1_0-invalidateElementCache|invalidateElementCache]] ( numeric, numeric ) | + | ::Returns Page ID Query in Data_FieldValue matching Form ID:public [[CEData_1_0-invalidateElementCache|invalidateElementCache]] ( <div id='library-api'>numeric, numeric ) |
− | :public [[CEData_1_0-sortArrayByIDList|sortArrayByIDList]] ( array, string, string ) | + | :public [[CEData_1_0-sortArrayByIDList|sortArrayByIDList]] ( <div id='library-api'>array, string, string ) |
</div> | </div> |
Revision as of 19:58, 8 April 2010
Attention: Do not change any text in the description, properties, and functions sections.
Return to Library (API)
Description
Custom Element Data functions for the ADF Library
Properties
- dependency = csSecurity_1_0
- version = 1_0_0
- wikiTitle = CEData_1_0
- type = singleton
Functions
- public arrayOfCEDataSort ( array, string, string, string, string )
- public buildElementInfoStruct (
array )- Builds an ElementInfo structure given a ceData array:public compareCEDataArray ( array, array )
- public containsFieldType (
numeric, string )- public defaultFieldStruct ( string )
- public deleteByElementName (
string )- Delete the Custom Element records from the data_fieldvalue table given a Custom Element name:public deleteCacheInstances ( string )
- public deleteCE (
string )- public diffCEDataArray (
array, array )- public elementExists (
string )- Determines whether or not an element exists:public getAllCustomElements ( )
- Returns all the Custom Elements for the site.:public getCEData (
string, string, any, string, string, string )- Returns array of structs for all data matching the Custom Element.:public getCEDataByFieldID (
numeric )- Returns Custom Element Data records for a given FieldID:public getCEDataField (
numeric, numeric, string )- Returns the single field data value for the custom element record.:public getCEDataFieldUUID (
numeric, string, string )- Returns the single field data value by the custom element UUID data value.:public getCEFieldValues (
string, string )- Returns all values for a particular field in a particular custom element.:public getCEForCategory (
string )- Returns a query of the CE's name and form ID that are in the Category argument.:public getCENameByFormID (
numeric )- public getCountForElementField (
string, string, any )- public getDataFieldValueByPageID ( Numeric, Numeric, boolean, numeric )
- public getElementFieldID (
numeric, string )- public getElementFieldsByFormID (
Numeric )- public getElementInfoByPageID (
Numeric, Numeric, boolean )- public getElementInfoVersionsByPageID (
Numeric, Numeric, Numeric )- public getElementVersionsForPageID (
Numeric, Numeric )- public getFieldIdsByType (
string )- Returns a list of fieldID's for a given Field Type:public getFormIDByCEName ( string )
- public getFormIDFromPageID (
Numeric )- Returns the Form ID for the Page ID.:public getPageIDForElement ( numeric, string, any, string, string, string )
- Returns Page ID Query in Data_FieldValue matching Form ID:public invalidateElementCache (
numeric, numeric )- public sortArrayByIDList (
array, string, string ) - Returns Page ID Query in Data_FieldValue matching Form ID:public invalidateElementCache (
- public getFormIDFromPageID (
- public getElementFieldID (
- public getDataFieldValueByPageID (
- Returns all the Custom Elements for the site.:public getCEData (
- public deleteCE (
- public deleteByElementName (
- public defaultFieldStruct (
- public containsFieldType (
- public buildElementInfoStruct (