Click or drag to resize
HierarchyHelper Class
Object hierarchy manipulation methods.
Inheritance Hierarchy

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public class HierarchyHelper

The HierarchyHelper type exposes the following members.

Constructors
  NameDescription
Protected methodHierarchyHelper(ExportObjectSettings)
Default constructor for inheritance
Protected methodHierarchyHelper(ExportObjectSettings, GeneralizedInfo)
Creates new instance of CMSHierarchyHelper which can be used to serialize given object.
Top
Methods
  NameDescription
Protected methodStatic memberAddTranslation
Adds given ID into the translation table to correct list according to objectType
Protected methodStatic memberAppendNode
Appends hierarchy node to the result.
Protected methodStatic memberCacheExportResult
Puts the result of the export to the cache (including TranslationHelper if present).
Protected methodStatic memberCallEndCollection(TraverseObjectSettings, String)
Calls given delegate with required parameters if delegate is not null.
Protected methodStatic memberCallEndCollection(TraverseObjectSettings, String, Boolean)
Calls given delegate with required parameters if delegate is not null.
Protected methodStatic memberCallItemCallback
Calls item callback if exists.
Protected methodStatic memberCallObjectCallback
Calls object callback if exists.
Protected methodStatic memberCallStartCollection(TraverseObjectSettings, String)
Calls given delegate with required parameters if delegate is not null.
Protected methodStatic memberCallStartCollection(TraverseObjectSettings, String, Boolean)
Calls given delegate with required parameters if delegate is not null.
Protected methodDataAvailable
Returns true if the data can be exported
Protected methodStatic memberExportCategoryObjects
Exports categories data to given StringBuilder object.
Public methodExportObject
Returns XML representation of given instance of info object.
Public methodStatic memberExportObject(ExportObjectSettings, BaseInfo)
Returns XML representation of given instance of info object.
Protected methodExportObjectData
Exports the object data
Protected methodStatic memberGetCompositeID
Returns object ID even if it is composed out of multiple columns.
Protected methodStatic memberGetListOfColumns
Returns list of supported columns/properties
Protected methodStatic memberGetMetadata
Returns metadata for given object according to export settings.
Protected methodGetMetadataSource
Gets the metadata source object
Protected methodStatic memberGetResultFromCache
Tries find exported data and TranslationHelper in cache.
Protected methodGetSyndicationItem
Gets the syndication item created from current object
Protected methodStatic memberLoadDataSetFromJSON
Recursively loads dataset from JSON deserialized object. Returns list of fields contained in the JSON data (for update object purposes).
Public methodStatic memberLoadObjectFromDataRow
Loads an GeneralizedInfo with values from given DataRow.
Public methodStatic memberLoadObjectFromDataSet(GeneralizedInfo, DataSet, Boolean, ListString, ListString)
Loads object data including collection from a given data set.
Protected methodStatic memberLoadObjectFromDataSet(GeneralizedInfo, DataSet, Boolean, Int32, ListString, ListString)
Loads object data including collection from a given data set.
Public methodStatic memberLoadObjectFromJSON
Loads objects data including collection from a given XML representation.
Public methodStatic memberLoadObjectFromXML
Loads objects data including collection from a given XML representation (root of the xml has to be ClassTableName of given object).
Protected methodProcessArraySeparatorMethod
Handles array separator of the collection export.
Protected methodProcessEndCollectionMethod
Handles end of the collection export.
Protected methodProcessIDMethod
Handles FK ID (can be used to fill translation helper for example).
Protected methodProcessItemMethod
Handles FK ID (can be used to fill translation helper for example).
Protected methodProcessObjectMethod
Handles export to required format.
Protected methodProcessStartCollectionMethod
Handles start of the collection export.
Protected methodStatic memberProcessTranslations
Fills translation helper with data from hashtable and appends translations to the result if needed.
Protected methodStatic memberTraverseObjectCollection
Exports given child collection.
Public methodStatic memberTraverseObjectStructure
Goes through the object structure and calls given delegates.
Protected methodStatic memberWrapResult
Wraps final result into root if needed.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Protected propertyResultBuilder
Result builder
Protected propertySettings
Settings
Top
See Also