Difference between revisions of "CSData 1 0"

Revision as of 03:30, 24 March 2010 (view source) Api (talk | contribs) ← Older edit		Revision as of 03:30, 24 March 2010 (view source) Api (talk | contribs) Newer edit →
Line 6:		Line 6:
	:type = singleton		:type = singleton
−	== Functions ==	+	== Functions ==
		+	:[[CSData_1_0-buildCSPageName|buildCSPageName]]
−	Functions	+
		+	:[[CSData_1_0-copyUploadFileToSubsite|copyUploadFileToSubsite]]
		+	::Copies the uploaded file from the _cs_uploads to the subsite upload folder.
		+
		+
		+	:[[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
		+
		+
		+	:[[CSData_1_0-findUploadFileExistsInSubsite|findUploadFileExistsInSubsite]]
		+	::Function returns T/F is file exists in subsite upload folder
		+
		+
		+	:[[CSData_1_0-formatSubsiteURL|formatSubsiteURL]]
		+	::Allows the subsiteURL to have a proper format
		+
		+
		+	:[[CSData_1_0-getCommonSpotSites|getCommonSpotSites]]
		+	::Returns the CommonSpot sites for the server.
		+
		+
		+	:[[CSData_1_0-getContactData|getContactData]]
		+	::Retrieves CommonSpot user data when given a user ID.
		+
		+
		+	:[[CSData_1_0-getCSPageByIndexTitle|getCSPageByIndexTitle]]
		+
		+
		+	:[[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
		+
		+
		+	:[[CSData_1_0-getCSPageURL|getCSPageURL]]
		+
		+
		+	:[[CSData_1_0-getCustomMetadata|getCustomMetadata]]
		+
		+
		+	:[[CSData_1_0-getDefaultRenderHandlerHTML|getDefaultRenderHandlerHTML]]
		+	::Returns the HTML for the default render handler with the passed in element name.
		+
		+
		+	:[[CSData_1_0-getDefaultRenderHandlerPath|getDefaultRenderHandlerPath]]
		+	::Returns the Path for the Default Render Handler for an Element.
		+
		+
		+	:[[CSData_1_0-getDocIcon|getDocIcon]]
		+	::Returns the document Icon based on the MIME type
		+
		+
		+	:[[CSData_1_0-getFullCurrentPageURL|getFullCurrentPageURL]]
		+	::Returns the full page url for the current page using CS request variables.
		+
		+
		+	:[[CSData_1_0-getImagePageURL|getImagePageURL]]
		+
		+
		+	:[[CSData_1_0-getLanguageCounterPart|getLanguageCounterPart]]
		+	::Returns a metadata structure for this pages lanugage counterpart
		+
		+
		+	:[[CSData_1_0-getLanguageName|getLanguageName]]
		+	::Given a languageID retrieve the language name
		+
		+
		+	:[[CSData_1_0-getPageMetadata|getPageMetadata]]
		+	::Return the standard and custom metadata for a page.
		+
		+
		+	:[[CSData_1_0-getPagesBySubsiteID|getPagesBySubsiteID]]
		+
		+
		+	:[[CSData_1_0-getParentSubsiteFromURL|getParentSubsiteFromURL]]
		+	::Returns the parentSubsiteID given a subsiteURL
		+
		+
		+	:[[CSData_1_0-getSiteTemplates|getSiteTemplates]]
		+	::
		+
		+
		+	:[[CSData_1_0-getStandardMetadata|getStandardMetadata]]
		+
		+
		+	:[[CSData_1_0-getSubsiteID|getSubsiteID]]
		+
		+
		+	:[[CSData_1_0-getSubsiteIDByPageID|getSubsiteIDByPageID]]
		+	::Returns the Subsite ID for the Page ID.
		+
		+
		+	:[[CSData_1_0-getSubsiteQueryByID|getSubsiteQueryByID]]
		+	::Returns a Query for the subsite information
		+
		+
		+	:[[CSData_1_0-getSubsiteStruct|getSubsiteStruct]]
		+
		+
		+	:[[CSData_1_0-getTemplateByID|getTemplateByID]]
		+	::
		+
		+
		+	:[[CSData_1_0-getTopLevelParentSubsiteID|getTopLevelParentSubsiteID]]
		+	::Returns the Subsite ID for the Page ID.
		+
		+
		+	:[[CSData_1_0-getUploadedDocPageURL|getUploadedDocPageURL]]
		+	::Returns the CS page url for the uploaded document.
		+
		+
		+	:[[CSData_1_0-getUploadedDocPublicName|getUploadedDocPublicName]]
		+	::Returns the public file name for the uploaded document
		+
		+
		+	:[[CSData_1_0-getUploadedFilePageID|getUploadedFilePageID]]
		+	::Returns Page ID for the subsite id and uploaded filename.
		+
		+
		+	:[[CSData_1_0-isCSPageActive|isCSPageActive]]
		+	::Returns T/F for the active status of the page id.
		+
		+
		+	:[[CSData_1_0-makeCSSafe|makeCSSafe]]
		+	::
		+
		+
		+	:[[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.
		+
		+
		+	:[[CSData_1_0-validateADFBeanObject|validateADFBeanObject]]
		+	::Search the Application spaces on the site for the for the bean object.

---

Revision as of 03:30, 24 March 2010

Description

CommonSpot Data Utils functions for the ADF Library

Properties

version = 1_0_0

type = singleton

Functions

buildCSPageName

copyUploadFileToSubsite

Copies the uploaded file from the _cs_uploads to the subsite upload folder.

CSFile

decipherCPIMAGE

Returns the proper structure for an image based on the 'CPIMAGE:' text provided by CEData() calls

findUploadFileExistsInSubsite

Function returns T/F is file exists in subsite upload folder

formatSubsiteURL

Allows the subsiteURL to have a proper format

getCommonSpotSites

Returns the CommonSpot sites for the server.

getContactData

Retrieves CommonSpot user data when given a user ID.

getCSPageByIndexTitle

getCSPageByName

getCSPageDataByURL

Returns a query containing the page ID and page title of the page URL provided

getCSPageURL

getCustomMetadata

getDefaultRenderHandlerHTML

Returns the HTML for the default render handler with the passed in element name.

getDefaultRenderHandlerPath

Returns the Path for the Default Render Handler for an Element.

getDocIcon

Returns the document Icon based on the MIME type

getFullCurrentPageURL

Returns the full page url for the current page using CS request variables.

getImagePageURL

getLanguageCounterPart

Returns a metadata structure for this pages lanugage counterpart

getLanguageName

Given a languageID retrieve the language name

getPageMetadata

Return the standard and custom metadata for a page.

getPagesBySubsiteID

getParentSubsiteFromURL

Returns the parentSubsiteID given a subsiteURL

getSiteTemplates

getStandardMetadata

getSubsiteID

getSubsiteIDByPageID

Returns the Subsite ID for the Page ID.

getSubsiteQueryByID

Returns a Query for the subsite information

getSubsiteStruct

getTemplateByID

getTopLevelParentSubsiteID

Returns the Subsite ID for the Page ID.

getUploadedDocPageURL

Returns the CS page url for the uploaded document.

getUploadedDocPublicName

Returns the public file name for the uploaded document

getUploadedFilePageID

Returns Page ID for the subsite id and uploaded filename.

isCSPageActive

Returns T/F for the active status of the page id.

makeCSSafe

pagesContainingRH

pagesContainingScript

serializedFormStringToStruct

Returns a structure of the element fields containing the serialized form data.

validateADFBeanObject

Search the Application spaces on the site for the for the bean object.