Difference between revisions of "CEData 1 0"
From ADF Docs
(→Functions) |
|||
Line 17: | Line 17: | ||
:public [[CEData_1_0-arrayOfCEDataSort|arrayOfCEDataSort]] ( array, string, string, string, string ) | :public [[CEData_1_0-arrayOfCEDataSort|arrayOfCEDataSort]] ( array, string, string, string, string ) | ||
:public [[CEData_1_0-buildElementInfoStruct|buildElementInfoStruct]] ( array ) | :public [[CEData_1_0-buildElementInfoStruct|buildElementInfoStruct]] ( array ) | ||
− | ::Builds an ElementInfo structure given a ceData array | + | ::Builds an ElementInfo structure given a ceData array:public [[CEData_1_0-compareCEDataArray|compareCEDataArray]] ( array, array ) |
− | :public [[CEData_1_0-compareCEDataArray|compareCEDataArray]] ( array, array ) | ||
:public [[CEData_1_0-containsFieldType|containsFieldType]] ( numeric, string ) | :public [[CEData_1_0-containsFieldType|containsFieldType]] ( numeric, string ) | ||
− | + | :::public [[CEData_1_0-defaultFieldStruct|defaultFieldStruct]] ( string ) | |
− | :public [[CEData_1_0-defaultFieldStruct|defaultFieldStruct]] ( string ) | ||
:public [[CEData_1_0-deleteByElementName|deleteByElementName]] ( string ) | :public [[CEData_1_0-deleteByElementName|deleteByElementName]] ( string ) | ||
− | ::Delete the Custom Element records from the data_fieldvalue table given a Custom Element name | + | ::Delete the Custom Element records from the data_fieldvalue table given a Custom Element name:public [[CEData_1_0-deleteCacheInstances|deleteCacheInstances]] ( string ) |
− | :public [[CEData_1_0-deleteCacheInstances|deleteCacheInstances]] ( string ) | ||
:public [[CEData_1_0-deleteCE|deleteCE]] ( string ) | :public [[CEData_1_0-deleteCE|deleteCE]] ( string ) | ||
:public [[CEData_1_0-diffCEDataArray|diffCEDataArray]] ( array, array ) | :public [[CEData_1_0-diffCEDataArray|diffCEDataArray]] ( array, array ) | ||
:public [[CEData_1_0-elementExists|elementExists]] ( string ) | :public [[CEData_1_0-elementExists|elementExists]] ( string ) | ||
− | ::Determines whether or not an element exists | + | ::Determines whether or not an element exists:public [[CEData_1_0-getAllCustomElements|getAllCustomElements]] ( ) |
− | :public [[CEData_1_0-getAllCustomElements|getAllCustomElements]] ( ) | + | ::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. | + | ::Returns array of structs for all data matching the Custom Element.:public [[CEData_1_0-getCEDataByFieldID|getCEDataByFieldID]] ( numeric ) |
− | :public [[CEData_1_0-getCEData|getCEData]] ( string, string, any, string, string, string ) | + | ::Returns Custom Element Data records for a given FieldID:public [[CEData_1_0-getCEDataField|getCEDataField]] ( numeric, numeric, string ) |
− | ::Returns array of structs for all data matching the Custom Element. | + | ::Returns the single field data value for the custom element record.:public [[CEData_1_0-getCEDataFieldUUID|getCEDataFieldUUID]] ( numeric, string, string ) |
− | :public [[CEData_1_0-getCEDataByFieldID|getCEDataByFieldID]] ( numeric ) | + | ::Returns the single field data value by the custom element UUID data value.:public [[CEData_1_0-getCEFieldValues|getCEFieldValues]] ( string, string ) |
− | ::Returns Custom Element Data records for a given FieldID | + | ::Returns all values for a particular field in a particular custom element.:public [[CEData_1_0-getCEForCategory|getCEForCategory]] ( string ) |
− | :public [[CEData_1_0-getCEDataField|getCEDataField]] ( numeric, numeric, 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 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 by the custom element UUID data value. | ||
− | :public [[CEData_1_0-getCEFieldValues|getCEFieldValues]] ( string, string ) | ||
− | ::Returns all values for a particular field in a particular custom element. | ||
− | :public [[CEData_1_0-getCEForCategory|getCEForCategory]] ( 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 ) | ||
− | |||
:public [[CEData_1_0-getCountForElementField|getCountForElementField]] ( string, string, any ) | :public [[CEData_1_0-getCountForElementField|getCountForElementField]] ( string, string, any ) | ||
− | :: | + | :::public [[CEData_1_0-getDataFieldValueByPageID|getDataFieldValueByPageID]] ( Numeric, Numeric, boolean, numeric ) |
− | :public [[CEData_1_0-getDataFieldValueByPageID|getDataFieldValueByPageID]] ( Numeric, Numeric, boolean, numeric ) | ||
− | |||
:public [[CEData_1_0-getElementFieldID|getElementFieldID]] ( numeric, string ) | :public [[CEData_1_0-getElementFieldID|getElementFieldID]] ( numeric, string ) | ||
− | |||
:public [[CEData_1_0-getElementFieldsByFormID|getElementFieldsByFormID]] ( Numeric ) | :public [[CEData_1_0-getElementFieldsByFormID|getElementFieldsByFormID]] ( Numeric ) | ||
− | |||
:public [[CEData_1_0-getElementInfoByPageID|getElementInfoByPageID]] ( Numeric, Numeric, boolean ) | :public [[CEData_1_0-getElementInfoByPageID|getElementInfoByPageID]] ( Numeric, Numeric, boolean ) | ||
− | |||
:public [[CEData_1_0-getElementInfoVersionsByPageID|getElementInfoVersionsByPageID]] ( Numeric, Numeric, Numeric ) | :public [[CEData_1_0-getElementInfoVersionsByPageID|getElementInfoVersionsByPageID]] ( Numeric, Numeric, Numeric ) | ||
− | |||
:public [[CEData_1_0-getElementVersionsForPageID|getElementVersionsForPageID]] ( Numeric, Numeric ) | :public [[CEData_1_0-getElementVersionsForPageID|getElementVersionsForPageID]] ( Numeric, Numeric ) | ||
− | |||
:public [[CEData_1_0-getFieldIdsByType|getFieldIdsByType]] ( string ) | :public [[CEData_1_0-getFieldIdsByType|getFieldIdsByType]] ( string ) | ||
− | ::Returns a list of fieldID's for a given Field Type | + | ::Returns a list of fieldID's for a given Field Type:public [[CEData_1_0-getFormIDByCEName|getFormIDByCEName]] ( string ) |
− | :public [[CEData_1_0-getFormIDByCEName|getFormIDByCEName]] ( string ) | ||
− | |||
:public [[CEData_1_0-getFormIDFromPageID|getFormIDFromPageID]] ( Numeric ) | :public [[CEData_1_0-getFormIDFromPageID|getFormIDFromPageID]] ( Numeric ) | ||
− | ::Returns the Form ID for the Page ID. | + | ::Returns the Form ID for the Page ID.:public [[CEData_1_0-getPageIDForElement|getPageIDForElement]] ( numeric, string, any, string, string, string ) |
− | :public [[CEData_1_0-getPageIDForElement|getPageIDForElement]] ( 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]] ( numeric, numeric ) | ||
− | |||
:public [[CEData_1_0-sortArrayByIDList|sortArrayByIDList]] ( array, string, string ) | :public [[CEData_1_0-sortArrayByIDList|sortArrayByIDList]] ( array, string, string ) | ||
− | |||
</div> | </div> |
Revision as of 19:51, 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 )