You are here

SkyVault 2.0 » For Developers » Developing Applications and Extensions » SkyVault API Reference » Surf Platform API reference » Surf root-scoped objects

sitedata

The sitedata object provides information about a site such as its configuration and root page.

The sitedata object provides the following properties. The property types include:

  • Framework properties
  • Properties that provide arrays of all objects of a given type
  • Properties that provide associative arrays (or maps) of all instances for a given object type. These maps are keyed by object ID
Type Description
rootPage Root page object for the web site/application.
siteConfiguration Configuration object for the web site/application.
objectTypeIds Return a string array of object type IDs.
chrome Provides an array of all Chrome objects.
components Provides an array of all Component objects.
componentTypes Provides an array of all ComponentType objects.
configurations Provides an array of all Configuration objects.
contentAssociations Provides an array of all ContentAssociation objects.
pages Returns an array of all Page objects.
pageTypes Provides an array of all PageType objects.
pageAssociations Provides an array of all PageAssociation objects.
templates Provides an array of all Template objects.
templateTypes Provides an array of all TemplateType objects.
themes Provides an array of all Theme objects.
chromeMap Provides an associative array of all Chrome objects.
componentsMap Provides an associative array of all Component objects.
componentTypesMap Provides an associative array of all ComponentType objects.
configurationsMap Provides an associative array of all Configuration objects.
contentAssociationsMap Provides an associative array of all ContentAssociation objects.
pagesMap Provides an associative array of all Page objects.
pageAssociationsMap Provides an associative array of all PageAssociation objects.
templatesMap Provides an associative array of all Template objects.
templateTypesMap Provides an associative array of all TemplateType objects.
themesMap Provides an associative array of all Theme objects.
  • getObjectTypeNamegetObjectTypeName(String objectTypeId) - this method returns the object type name, given the object type ID.
  • getObjectTypeDescriptiongetObjectTypeDescription(String objectTypeId) - this method returns the object type description, given the object type ID.
  • getObjectsgetObjects(String objectTypeId) - this method returns an array of objects of the given object type ID.
  • getObjectsMapgetObjectsMap(String objectTypeId) - this method returns a map of all instances of the given type. The map is keyed on object ID.
  • newObjectnewObject() - these methods return a newly created ScriptModelObject.
  • newChromenewChrome - this method creates and returns a new Chrome object instance.
  • newComponentnewComponent - these methods create and return a new Component object instance. The scope, region and sourceId parameters should be set before the object is persisted.
  • newComponentTypenewComponentType - this method returns a ScriptModelObject representing a new ComponentType instance of the specified type.
  • newConfigurationnewConfiguration - these methods create and return a new Configuration object instance.
  • newContentAssociationnewContentAssociation - this method creates and returns a new ContentAssociation object instance.
  • newPagenewPage - these methods create and return a new Page object instance.
  • newPageAssociationnewPageAssociation - this method creates and returns a new PageAssociation object instance.
  • newPageTypenewPageType - this method creates and returns a new Chrome object instance.
  • newTemplatenewTemplate - these methods create and return a new Template object instance.
  • newTemplateTypenewTemplateType - this method creates and returns a new TemplateType object instance.
  • newThemenewTheme(String objectId) - this method returns a newly created ScriptModelObject representing a new Theme.
  • newPresetnewPreset(String presetId, Scriptable tokens) - creates model objects based on a given preset id. The preset is looked up and processed by the PresetManager bean. The various objects found in the preset will be generated using the supplied name/value map of tokens.
  • findComponentsfindComponents(String scope, String regionId, String sourceId, String componentTypeId) - searches for Component instances within the Web Application that match the provided constraints. If a constraint is set to null, it is not considered as part of the search.
  • findWebScriptsfindWebScripts(String family) - returns an array of webscripts that match the goven family name.
  • findChildPageAssociationsfindChildPageAssociations(String sourceId, String destId) - searches for PageAssociation instances within the Web Application that are of association type 'child' and which match the specified constraints. If a constraint is set to null, it is not considered as part of the search.
  • findPageAssociationsfindPageAssociations(String sourceId, String destId, String associationType) - searches for PageAssociation instances within the Web Application that are of the specified association type and which match the specified constraints. If a constraint is set to null, it is not considered as part of the search.
  • findChildPagesfindChildPages(String sourceId) - searches for child pages of the given page.
  • findParentPagesfindParentPages(String pageId) - searches for parent pages of the given page.
  • findContentAssociationsfindContentAssociations(String sourceId, String sourceType, String destId, String assocType, String formatId) - searches for ContentAssociation instances within the Web Application that match the specified constraints. If a constraint is set to null, it is not considered as part of the search.
  • findComponentsMapfindComponentsMap(String scope, String regionId, String sourceId, String componentTypeId) - provides a map of ScriptModelObjects that wrap Component instances. The map is keyed by Component object id.
  • findPageAssociationsMapfindPageAssociationsMap(String sourceId, String destId, String associationType) - Provides a map of ScriptModelObjects that wrap PageAssociation instances. The map is keyed by PageAssociation object id.
  • findContentAssociationsMapfindContentAssociationsMap(String sourceId, String sourceType, String destId, String assocType, String formatId) - provides a map of ScriptModelObjects that wrap ContentAssociation instances. The map is keyed by ContentAssociation object id.
  • findTemplatesMapfindTemplatesMap(String pageId) - provides a map of ScriptModelObjects that wrap Template instances. The map is keyed by format id.
  • findConfigurationfindConfiguration(String pageId) - looks up Configuration instances and returns the first instance that is found for the matching constraints.
  • findTemplatefindTemplate() - these methods look up template instances and return the first instance that is found for the matching constraints.
  • removeTemplateremoveTemplate(String pageId, String formatId) - looks up the given Page and unbinds any Template instances that are bound to the page (keyed by formatId). If you would like to remove the default Template instance, set formatId to null.
  • bindComponentbindComponent() - these methods bind components.
  • unbindComponentunbindComponent() - these methods unbind components.
  • associateTemplateassociateTemplate() - these methods associate a template.
  • unassociateTemplateunassociateTemplate() - these methods unassociate a template.
  • associatePageassociatePage - associates a page.
  • unassociatePageunassociatePage - unassociates a page.
  • associateContentassociateContent - associates content.
  • unassociateContentunassociateContent - unassociates content.
  • associateContentTypeassociateContentType - associates content type.
  • unassociateContentTypeunassociateContentType - unassociates content type.
  • Helper methodsHelper methods - A collection of helper methods to support the SiteData object.
Parent topic: Surf root-scoped objects

© 2017 TBS-LLC. All Rights Reserved.