C# Class Microsoft.Protocols.TestSuites.SharedAdapter.DataElementUtils

This class is used to build data element list or parse the data element list.

Show file Open project: OfficeDev/Interop-TestSuites Class Usage Examples

Public Properties

Property	Type	Description
CellSecondExGuid	System.Guid
RootExGuid	System.Guid
SchemaGuid	System.Guid

Public Methods

Method	Description
AnalyzeStorageIndexDataElement ( List dataElements, ExGuid storageIndexExGuid, ExGuid &manifestMappingGuid, ExGuid>.Dictionary &cellIDMappings, ExGuid>.Dictionary &revisionIDMappings ) : bool	This method is used to analyze the storage index data element to get all the mappings.
BuildDataElements ( byte fileContent, ExGuid &storageIndexExGuid ) : List	This method is used to build a list of data elements to represent a file.
CreateCellMainifestDataElement ( ExGuid revisionId, ExGuid>.Dictionary &cellIDMapping ) : DataElement	This method is used to create the cell manifest data element.
CreateObjectGroupDataElement ( byte fileContent, ExGuid &rootNodeExGuid, List &objectDataExGuidList ) : List	This method is used to create object group data/blob element list.
CreateRevisionManifestDataElement ( ExGuid rootObjectExGuid, ExGuid baseRevisionID, List refferenceObjectDataExGuidList, ExGuid>.Dictionary &revisionMapping, ExGuid &currentRevisionID ) : DataElement	This method is used to create the revision manifest data element.
CreateStorageIndexDataElement ( ExGuid manifestExGuid, ExGuid>.Dictionary cellIDMappings, ExGuid>.Dictionary revisionIDMappings ) : DataElement	This method is used to create the storage index data element.
CreateStorageManifestDataElement ( ExGuid>.Dictionary cellIDMapping ) : DataElement	This method is used to create the storage manifest data element.
GetCellManifestDataElementData ( List dataElements, StorageManifestDataElementData manifestDataElementData, ExGuid>.Dictionary cellIDMappings ) : CellManifestDataElementData	This method is used to get cell manifest data element from a list of data element.
GetDataObjectDataElementData ( List dataElements, ExGuid storageIndexExGuid, ExGuid &rootExGuid ) : List	This method is used to get the list of object group data element from a list of data element.
GetDataObjectDataElementData ( List dataElements, RevisionManifestDataElementData revisionData, ExGuid &rootExGuid ) : List	This method is used to get a list of object group data element from a list of data element.
GetRevisionManifestDataElementData ( List dataElements, CellManifestDataElementData cellData, ExGuid>.Dictionary revisionIDMappings ) : RevisionManifestDataElementData	This method is used to get revision manifest data element from a list of data element.
GetStorageManifestDataElementData ( List dataElements, ExGuid manifestMapping ) : StorageManifestDataElementData	This method is used to get storage manifest data element from a list of data element.
TryAnalyzeWhetherConfirmSchema ( List dataElements, ExGuid storageIndexExGuid ) : bool	This method is used to analyze whether the data elements are confirmed to the schema defined in MS-FSSHTTPD.
TryAnalyzeWhetherFullDataElementList ( List dataElements, ExGuid storageIndexExGuid ) : bool	This method is used to try to analyze the returned whether data elements are complete.

Method Details

AnalyzeStorageIndexDataElement() public static method

This method is used to analyze the storage index data element to get all the mappings.

public static AnalyzeStorageIndexDataElement ( List dataElements, ExGuid storageIndexExGuid, ExGuid &manifestMappingGuid, ExGuid>.Dictionary &cellIDMappings, ExGuid>.Dictionary &revisionIDMappings ) : bool
dataElements	List	Specify the data element list.
storageIndexExGuid	ExGuid	Specify the storage index extended GUID.
manifestMappingGuid	ExGuid	Output parameter to represent the storage manifest mapping GUID.
cellIDMappings	ExGuid>.Dictionary	Output parameter to represent the mapping of cell id.
revisionIDMappings	ExGuid>.Dictionary	Output parameter to represent the revision id.
return	bool

BuildDataElements() public static method

This method is used to build a list of data elements to represent a file.

public static BuildDataElements ( byte fileContent, ExGuid &storageIndexExGuid ) : List
fileContent	byte	Specify the file content byte array.
storageIndexExGuid	ExGuid	Output parameter to represent the storage index GUID.
return	List

CreateCellMainifestDataElement() public static method

This method is used to create the cell manifest data element.

public static CreateCellMainifestDataElement ( ExGuid revisionId, ExGuid>.Dictionary &cellIDMapping ) : DataElement
revisionId	ExGuid	Specify the revision GUID.
cellIDMapping	ExGuid>.Dictionary	Input/output parameter to represent the mapping of cell manifest.
return	DataElement

CreateObjectGroupDataElement() public static method

This method is used to create object group data/blob element list.

public static CreateObjectGroupDataElement ( byte fileContent, ExGuid &rootNodeExGuid, List &objectDataExGuidList ) : List
fileContent	byte	Specify the file content in byte array format.
rootNodeExGuid	ExGuid	Output parameter to represent the root node extended GUID.
objectDataExGuidList	List	Input/Output parameter to represent the list of extended GUID for the data object data.
return	List

CreateRevisionManifestDataElement() public static method

This method is used to create the revision manifest data element.

public static CreateRevisionManifestDataElement ( ExGuid rootObjectExGuid, ExGuid baseRevisionID, List refferenceObjectDataExGuidList, ExGuid>.Dictionary &revisionMapping, ExGuid &currentRevisionID ) : DataElement
rootObjectExGuid	ExGuid	Specify the root node object extended GUID.
baseRevisionID	ExGuid	Specify the base revision Id.
refferenceObjectDataExGuidList	List	Specify the reference object data extended list.
revisionMapping	ExGuid>.Dictionary	Input/output parameter to represent the mapping of revision manifest.
currentRevisionID	ExGuid	Output parameter to represent the revision GUID.
return	DataElement

CreateStorageIndexDataElement() public static method

This method is used to create the storage index data element.

public static CreateStorageIndexDataElement ( ExGuid manifestExGuid, ExGuid>.Dictionary cellIDMappings, ExGuid>.Dictionary revisionIDMappings ) : DataElement
manifestExGuid	ExGuid	Specify the storage manifest data element extended GUID.
cellIDMappings	ExGuid>.Dictionary	Specify the mapping of cell manifest.
revisionIDMappings	ExGuid>.Dictionary	Specify the mapping of revision manifest.
return	DataElement

CreateStorageManifestDataElement() public static method

This method is used to create the storage manifest data element.

public static CreateStorageManifestDataElement ( ExGuid>.Dictionary cellIDMapping ) : DataElement
cellIDMapping	ExGuid>.Dictionary	Specify the mapping of cell manifest.
return	DataElement

GetCellManifestDataElementData() public static method

This method is used to get cell manifest data element from a list of data element.

public static GetCellManifestDataElementData ( List dataElements, StorageManifestDataElementData manifestDataElementData, ExGuid>.Dictionary cellIDMappings ) : CellManifestDataElementData
dataElements	List	Specify the data element list.
manifestDataElementData	StorageManifestDataElementData	Specify the manifest data element.
cellIDMappings	ExGuid>.Dictionary	Specify mapping of cell id.
return	CellManifestDataElementData

GetDataObjectDataElementData() public static method

This method is used to get the list of object group data element from a list of data element.

public static GetDataObjectDataElementData ( List dataElements, ExGuid storageIndexExGuid, ExGuid &rootExGuid ) : List
dataElements	List	Specify the data element list.
storageIndexExGuid	ExGuid	Specify the storage index extended GUID.
rootExGuid	ExGuid	Output parameter to represent the root node object.
return	List

GetDataObjectDataElementData() public static method

This method is used to get a list of object group data element from a list of data element.

public static GetDataObjectDataElementData ( List dataElements, RevisionManifestDataElementData revisionData, ExGuid &rootExGuid ) : List
dataElements	List	Specify the data element list.
revisionData	RevisionManifestDataElementData	Specify the revision data.
rootExGuid	ExGuid	Specify the root node object extended GUID.
return	List

GetRevisionManifestDataElementData() public static method

This method is used to get revision manifest data element from a list of data element.

public static GetRevisionManifestDataElementData ( List dataElements, CellManifestDataElementData cellData, ExGuid>.Dictionary revisionIDMappings ) : RevisionManifestDataElementData
dataElements	List	Specify the data element list.
cellData	CellManifestDataElementData	Specify the cell data element.
revisionIDMappings	ExGuid>.Dictionary	Specify mapping of revision id.
return	RevisionManifestDataElementData

GetStorageManifestDataElementData() public static method

This method is used to get storage manifest data element from a list of data element.

public static GetStorageManifestDataElementData ( List dataElements, ExGuid manifestMapping ) : StorageManifestDataElementData
dataElements	List	Specify the data element list.
manifestMapping	ExGuid	Specify the manifest mapping GUID.
return	StorageManifestDataElementData

TryAnalyzeWhetherConfirmSchema() public static method

This method is used to analyze whether the data elements are confirmed to the schema defined in MS-FSSHTTPD.

public static TryAnalyzeWhetherConfirmSchema ( List dataElements, ExGuid storageIndexExGuid ) : bool
dataElements	List	Specify the data elements list.
storageIndexExGuid	ExGuid	Specify the storage index extended GUID.
return	bool

TryAnalyzeWhetherFullDataElementList() public static method

This method is used to try to analyze the returned whether data elements are complete.

public static TryAnalyzeWhetherFullDataElementList ( List dataElements, ExGuid storageIndexExGuid ) : bool
dataElements	List	Specify the data elements list.
storageIndexExGuid	ExGuid	Specify the storage index extended GUID.
return	bool

Property Details

CellSecondExGuid public static property

The constant value of cell second extended GUID.

public static Guid,System CellSecondExGuid
return	System.Guid

RootExGuid public static property

The constant value of root extended GUID.

public static Guid,System RootExGuid
return	System.Guid

SchemaGuid public static property

The constant value of schema GUID.

public static Guid,System SchemaGuid
return	System.Guid