Difference between revisions of "CSData 1 0"
From ADF Docs
| (2 intermediate revisions by 2 users not shown) | |||
| Line 15: | Line 15: | ||
== Functions == | == Functions == | ||
| − | :[[CSData_1_0-buildCSPageName|buildCSPageName]] | + | <div id='library-api'> |
| − | + | :[[CSData_1_0-buildCSPageName|buildCSPageName]] ( string contentTitle ) | |
| − | + | :[[CSData_1_0-copyUploadFileToSubsite|copyUploadFileToSubsite]] ( numeric inSubSiteID, numeric inFilePageID, string inFileName ) | |
| − | :[[CSData_1_0-copyUploadFileToSubsite|copyUploadFileToSubsite]] | ||
::Copies the uploaded file from the _cs_uploads to the subsite upload folder. | ::Copies the uploaded file from the _cs_uploads to the subsite upload folder. | ||
| − | + | :[[CSData_1_0-CSFile|CSFile]] ( string action, string output, numeric mode, string source, string destination, string file, string filefield, string newfilename, string nameconflict, string directory, string filter, string direxists, string addnewline ) | |
| − | + | :[[CSData_1_0-decipherCPIMAGE|decipherCPIMAGE]] ( string cpimage ) | |
| − | :[[CSData_1_0-CSFile|CSFile]] | ||
| − | |||
| − | |||
| − | :[[CSData_1_0-decipherCPIMAGE|decipherCPIMAGE]] | ||
::Returns the proper structure for an image based on the 'CPIMAGE:' text provided by CEData() calls | ::Returns the proper structure for an image based on the 'CPIMAGE:' text provided by CEData() calls | ||
| − | + | :[[CSData_1_0-findUploadFileExistsInSubsite|findUploadFileExistsInSubsite]] ( numeric inSubSiteID, string inFileName ) | |
| − | |||
| − | :[[CSData_1_0-findUploadFileExistsInSubsite|findUploadFileExistsInSubsite]] | ||
::Function returns T/F is file exists in subsite upload folder | ::Function returns T/F is file exists in subsite upload folder | ||
| − | + | :[[CSData_1_0-formatSubsiteURL|formatSubsiteURL]] ( string subsiteURL ) | |
| − | |||
| − | :[[CSData_1_0-formatSubsiteURL|formatSubsiteURL]] | ||
::Allows the subsiteURL to have a proper format | ::Allows the subsiteURL to have a proper format | ||
| − | + | :[[CSData_1_0-getCommonSpotSites|getCommonSpotSites]] ( ) | |
| − | |||
| − | :[[CSData_1_0-getCommonSpotSites|getCommonSpotSites]] | ||
::Returns the CommonSpot sites for the server. | ::Returns the CommonSpot sites for the server. | ||
| − | + | :[[CSData_1_0-getContactData|getContactData]] ( numeric userID ) | |
| − | |||
| − | :[[CSData_1_0-getContactData|getContactData]] | ||
::Retrieves CommonSpot user data when given a user ID. | ::Retrieves CommonSpot user data when given a user ID. | ||
| − | + | :[[CSData_1_0-getCSPageByIndexTitle|getCSPageByIndexTitle]] ( string csPageTitle ) | |
| − | + | :[[CSData_1_0-getCSPageByName|getCSPageByName]] ( string csPageName, numeric csSubsiteID ) | |
| − | :[[CSData_1_0-getCSPageByIndexTitle|getCSPageByIndexTitle]] | + | :[[CSData_1_0-getCSPageDataByURL|getCSPageDataByURL]] ( string csPageURL ) |
| − | |||
| − | |||
| − | :[[CSData_1_0-getCSPageByName|getCSPageByName]] | ||
| − | |||
| − | |||
| − | :[[CSData_1_0-getCSPageDataByURL|getCSPageDataByURL]] | ||
::Returns a query containing the page ID and page title of the page URL provided | ::Returns a query containing the page ID and page title of the page URL provided | ||
| − | + | :[[CSData_1_0-getCSPageURL|getCSPageURL]] ( numeric pageID ) | |
| − | + | :[[CSData_1_0-getCustomMetadata|getCustomMetadata]] ( numeric pageID, numeric categoryID, numeric subsiteID, string inheritedTemplateList ) | |
| − | :[[CSData_1_0-getCSPageURL|getCSPageURL]] | + | :[[CSData_1_0-getDefaultRenderHandlerHTML|getDefaultRenderHandlerHTML]] ( string elementName, Array dataArray ) |
| − | |||
| − | |||
| − | :[[CSData_1_0-getCustomMetadata|getCustomMetadata]] | ||
| − | |||
| − | |||
| − | :[[CSData_1_0-getDefaultRenderHandlerHTML|getDefaultRenderHandlerHTML]] | ||
::Returns the HTML for the default render handler with the passed in element name. | ::Returns the HTML for the default render handler with the passed in element name. | ||
| − | + | :[[CSData_1_0-getDefaultRenderHandlerPath|getDefaultRenderHandlerPath]] ( string elementName ) | |
| − | |||
| − | :[[CSData_1_0-getDefaultRenderHandlerPath|getDefaultRenderHandlerPath]] | ||
::Returns the Path for the Default Render Handler for an Element. | ::Returns the Path for the Default Render Handler for an Element. | ||
| − | + | :[[CSData_1_0-getDocIcon|getDocIcon]] ( string MIMEType ) | |
| − | |||
| − | :[[CSData_1_0-getDocIcon|getDocIcon]] | ||
::Returns the document Icon based on the MIME type | ::Returns the document Icon based on the MIME type | ||
| − | + | :[[CSData_1_0-getFullCurrentPageURL|getFullCurrentPageURL]] ( ) | |
| − | |||
| − | :[[CSData_1_0-getFullCurrentPageURL|getFullCurrentPageURL]] | ||
::Returns the full page url for the current page using CS request variables. | ::Returns the full page url for the current page using CS request variables. | ||
| − | + | :[[CSData_1_0-getImagePageURL|getImagePageURL]] ( numeric pageid ) | |
| − | + | :[[CSData_1_0-getLanguageCounterPart|getLanguageCounterPart]] ( numeric pageID ) | |
| − | :[[CSData_1_0-getImagePageURL|getImagePageURL]] | ||
| − | |||
| − | |||
| − | :[[CSData_1_0-getLanguageCounterPart|getLanguageCounterPart]] | ||
::Returns a metadata structure for this pages lanugage counterpart | ::Returns a metadata structure for this pages lanugage counterpart | ||
| − | + | :[[CSData_1_0-getLanguageName|getLanguageName]] ( numeric langID ) | |
| − | |||
| − | :[[CSData_1_0-getLanguageName|getLanguageName]] | ||
::Given a languageID retrieve the language name | ::Given a languageID retrieve the language name | ||
| − | + | :[[CSData_1_0-getPageDataArray|getPageDataArray]] ( string pageIDList ) | |
| − | + | ::Returns an array of a page data based on a list of pageID's | |
| − | :[[CSData_1_0-getPageMetadata|getPageMetadata]] | + | :[[CSData_1_0-getPageMetadata|getPageMetadata]] ( numeric pageID, numeric categoryID, numeric subsiteID, string inheritedTemplateList ) |
::Return the standard and custom metadata for a page. | ::Return the standard and custom metadata for a page. | ||
| − | + | :[[CSData_1_0-getPagesBySubsiteID|getPagesBySubsiteID]] ( numeric subsiteID, boolean recurse, boolean includeDocs, boolean includeExternalURLs ) | |
| − | + | :[[CSData_1_0-getParentSubsiteFromURL|getParentSubsiteFromURL]] ( string subsiteURL ) | |
| − | :[[CSData_1_0-getPagesBySubsiteID|getPagesBySubsiteID]] | ||
| − | |||
| − | |||
| − | :[[CSData_1_0-getParentSubsiteFromURL|getParentSubsiteFromURL]] | ||
::Returns the parentSubsiteID given a subsiteURL | ::Returns the parentSubsiteID given a subsiteURL | ||
| − | + | :[[CSData_1_0-getSiteTemplates|getSiteTemplates]] ( ) | |
| − | + | :[[CSData_1_0-getStandardMetadata|getStandardMetadata]] ( numeric csPageID ) | |
| − | :[[CSData_1_0-getSiteTemplates|getSiteTemplates]] | + | :[[CSData_1_0-getSubsiteID|getSubsiteID]] ( string subsiteURL ) |
| − | + | :[[CSData_1_0-getSubsiteIDByPageID|getSubsiteIDByPageID]] ( numeric pageid ) | |
| − | |||
| − | |||
| − | :[[CSData_1_0-getStandardMetadata|getStandardMetadata]] | ||
| − | |||
| − | |||
| − | :[[CSData_1_0-getSubsiteID|getSubsiteID]] | ||
| − | |||
| − | |||
| − | :[[CSData_1_0-getSubsiteIDByPageID|getSubsiteIDByPageID]] | ||
::Returns the Subsite ID for the Page ID. | ::Returns the Subsite ID for the Page ID. | ||
| − | + | :[[CSData_1_0-getSubsiteQueryByID|getSubsiteQueryByID]] ( numeric subsiteID ) | |
| − | |||
| − | :[[CSData_1_0-getSubsiteQueryByID|getSubsiteQueryByID]] | ||
::Returns a Query for the subsite information | ::Returns a Query for the subsite information | ||
| − | + | :[[CSData_1_0-getSubsiteStruct|getSubsiteStruct]] ( ) | |
| − | + | :[[CSData_1_0-getTemplateByID|getTemplateByID]] ( numeric templateID ) | |
| − | :[[CSData_1_0-getSubsiteStruct|getSubsiteStruct]] | + | :[[CSData_1_0-getTopLevelParentSubsiteID|getTopLevelParentSubsiteID]] ( numeric childsubsiteid ) |
| − | |||
| − | |||
| − | :[[CSData_1_0-getTemplateByID|getTemplateByID]] | ||
| − | |||
| − | |||
| − | |||
| − | :[[CSData_1_0-getTopLevelParentSubsiteID|getTopLevelParentSubsiteID]] | ||
::Returns the Subsite ID for the Page ID. | ::Returns the Subsite ID for the Page ID. | ||
| − | + | :[[CSData_1_0-getUploadedDocPageURL|getUploadedDocPageURL]] ( numeric pageID, numeric subsiteID ) | |
| − | |||
| − | :[[CSData_1_0-getUploadedDocPageURL|getUploadedDocPageURL]] | ||
::Returns the CS page url for the uploaded document. | ::Returns the CS page url for the uploaded document. | ||
| − | + | :[[CSData_1_0-getUploadedDocPublicName|getUploadedDocPublicName]] ( numeric inCSPageID ) | |
| − | |||
| − | :[[CSData_1_0-getUploadedDocPublicName|getUploadedDocPublicName]] | ||
::Returns the public file name for the uploaded document | ::Returns the public file name for the uploaded document | ||
| − | + | :[[CSData_1_0-getUploadedFilePageID|getUploadedFilePageID]] ( numeric inSubSiteID, string inFileName ) | |
| − | |||
| − | :[[CSData_1_0-getUploadedFilePageID|getUploadedFilePageID]] | ||
::Returns Page ID for the subsite id and uploaded filename. | ::Returns Page ID for the subsite id and uploaded filename. | ||
| − | + | :[[CSData_1_0-isCSPageActive|isCSPageActive]] ( numeric pageID ) | |
| − | |||
| − | :[[CSData_1_0-isCSPageActive|isCSPageActive]] | ||
::Returns T/F for the active status of the page id. | ::Returns T/F for the active status of the page id. | ||
| − | + | :[[CSData_1_0-makeCSSafe|makeCSSafe]] ( string stringToFix, Boolean makeLowerCase ) | |
| − | + | :[[CSData_1_0-pageExists|pageExists]] ( numeric subsiteID, string pageTitle, string pageName ) | |
| − | :[[CSData_1_0-makeCSSafe|makeCSSafe]] | + | :[[CSData_1_0-pagesContainingRH|pagesContainingRH]] ( string modulePath ) |
| − | : | + | :[[CSData_1_0-pagesContainingScript|pagesContainingScript]] ( string templateURL ) |
| − | + | :[[CSData_1_0-serializedFormStringToStruct|serializedFormStringToStruct]] ( string serializedString ) | |
| − | |||
| − | :[[CSData_1_0-pagesContainingRH|pagesContainingRH]] | ||
| − | |||
| − | |||
| − | |||
| − | :[[CSData_1_0-pagesContainingScript|pagesContainingScript]] | ||
| − | |||
| − | |||
| − | |||
| − | :[[CSData_1_0-serializedFormStringToStruct|serializedFormStringToStruct]] | ||
::Returns a structure of the element fields containing the serialized form data. | ::Returns a structure of the element fields containing the serialized form data. | ||
| − | + | :[[CSData_1_0-validateADFBeanObject|validateADFBeanObject]] ( String beanName ) | |
| − | |||
| − | :[[CSData_1_0-validateADFBeanObject|validateADFBeanObject]] | ||
::Search the Application spaces on the site for the for the bean object. | ::Search the Application spaces on the site for the for the bean object. | ||
| + | </div> | ||
Latest revision as of 14:33, 24 November 2010
Attention: Do not change any text in the description, properties, and functions sections.
Return to Library (API)
Description
CommonSpot Data Utils functions for the ADF Library
Properties
- dependency = data_1_0
- version = 1_0_0
- wikiTitle = CSData_1_0
- type = singleton
Functions
- buildCSPageName ( string contentTitle )
- copyUploadFileToSubsite ( numeric inSubSiteID, numeric inFilePageID, string inFileName )
- Copies the uploaded file from the _cs_uploads to the subsite upload folder.
- CSFile ( string action, string output, numeric mode, string source, string destination, string file, string filefield, string newfilename, string nameconflict, string directory, string filter, string direxists, string addnewline )
- decipherCPIMAGE ( string cpimage )
- Returns the proper structure for an image based on the 'CPIMAGE:' text provided by CEData() calls
- findUploadFileExistsInSubsite ( numeric inSubSiteID, string inFileName )
- Function returns T/F is file exists in subsite upload folder
- formatSubsiteURL ( string subsiteURL )
- Allows the subsiteURL to have a proper format
- getCommonSpotSites ( )
- Returns the CommonSpot sites for the server.
- getContactData ( numeric userID )
- Retrieves CommonSpot user data when given a user ID.
- getCSPageByIndexTitle ( string csPageTitle )
- getCSPageByName ( string csPageName, numeric csSubsiteID )
- getCSPageDataByURL ( string csPageURL )
- Returns a query containing the page ID and page title of the page URL provided
- getCSPageURL ( numeric pageID )
- getCustomMetadata ( numeric pageID, numeric categoryID, numeric subsiteID, string inheritedTemplateList )
- getDefaultRenderHandlerHTML ( string elementName, Array dataArray )
- Returns the HTML for the default render handler with the passed in element name.
- getDefaultRenderHandlerPath ( string elementName )
- Returns the Path for the Default Render Handler for an Element.
- getDocIcon ( string MIMEType )
- Returns the document Icon based on the MIME type
- getFullCurrentPageURL ( )
- Returns the full page url for the current page using CS request variables.
- getImagePageURL ( numeric pageid )
- getLanguageCounterPart ( numeric pageID )
- Returns a metadata structure for this pages lanugage counterpart
- getLanguageName ( numeric langID )
- Given a languageID retrieve the language name
- getPageDataArray ( string pageIDList )
- Returns an array of a page data based on a list of pageID's
- getPageMetadata ( numeric pageID, numeric categoryID, numeric subsiteID, string inheritedTemplateList )
- Return the standard and custom metadata for a page.
- getPagesBySubsiteID ( numeric subsiteID, boolean recurse, boolean includeDocs, boolean includeExternalURLs )
- getParentSubsiteFromURL ( string subsiteURL )
- Returns the parentSubsiteID given a subsiteURL
- getSiteTemplates ( )
- getStandardMetadata ( numeric csPageID )
- getSubsiteID ( string subsiteURL )
- getSubsiteIDByPageID ( numeric pageid )
- Returns the Subsite ID for the Page ID.
- getSubsiteQueryByID ( numeric subsiteID )
- Returns a Query for the subsite information
- getSubsiteStruct ( )
- getTemplateByID ( numeric templateID )
- getTopLevelParentSubsiteID ( numeric childsubsiteid )
- Returns the Subsite ID for the Page ID.
- getUploadedDocPageURL ( numeric pageID, numeric subsiteID )
- Returns the CS page url for the uploaded document.
- getUploadedDocPublicName ( numeric inCSPageID )
- Returns the public file name for the uploaded document
- getUploadedFilePageID ( numeric inSubSiteID, string inFileName )
- Returns Page ID for the subsite id and uploaded filename.
- isCSPageActive ( numeric pageID )
- Returns T/F for the active status of the page id.
- makeCSSafe ( string stringToFix, Boolean makeLowerCase )
- pageExists ( numeric subsiteID, string pageTitle, string pageName )
- pagesContainingRH ( string modulePath )
- pagesContainingScript ( string templateURL )
- serializedFormStringToStruct ( string serializedString )
- Returns a structure of the element fields containing the serialized form data.
- validateADFBeanObject ( String beanName )
- Search the Application spaces on the site for the for the bean object.
