C# Class Microsoft.Protocols.TestSuites.MS_OUTSPS.TestSuiteBase

Inheritance: Microsoft.Protocols.TestTools.TestClassBase
Mostra file Open project: OfficeDev/Interop-TestSuites

Protected Methods

Method Description
AddFolderIntoList ( string listId, string folderItemName ) : string

A method used to add a folder into specified document library.
AddItemsToList ( string list, int itemCount ) : List

A method is used to add list items by specified number items to specified list. This method update the column value specified by ListFieldText property in the PTF configuration file, and the value of this column is specified by random generated string.
AddListToSUT ( TemplateType listTemplate ) : string

A method used to Create a list by configured list name and specified list template.
AddListToSUT ( string listName, TemplateType listTemplate ) : string

A method used to create a list by specified list name and template type.
AppenddeleteExceptionsElement ( string>.Dictionary originalRecurrenceSetting ) : string>.Dictionary

A method used to append "deleteExceptions" element on a value of "RecurrenceData" field. This element must be present if and only if protocol client update "EndDate", "EventDate", "RecurrenceData", "UID", "XMLTZone" fields for an recurrence appointment item and expect protocol SUT trigger the exception deletion.
CleanUpAddedList ( ) : void

A method used to Clean up added lists. Any lists added by Test Case Helper would be deleted.
CreateUpdateListItems ( List methodCollection, string>.List fieldNameValuePairs, OnErrorEnum errorhandleType ) : UpdateListItemsUpdates

A method used to construct UpdateListItemsUpdates instance using the specified parameters.
DeleteListItems ( string list, List deleteIDList, OnErrorEnum errorEnum ) : void

Delete the specified items in the specified list.
GenerateRandomNumber ( int minValue, int maxValue ) : string

This method is used to random generate an integer in the specified range.
GenerateRandomString ( int size ) : string

This method is used to generate random string in the range A-Z with the specified string size.
GenerateUniqueAttachmentContents ( ) : byte[]

A method used to generate unique contents for attachment.
GenerateUniqueAttachmentContents ( int attachmentStringLength ) : byte[]

A method used to generate unique contents for attachment.
GenerateViewFields ( bool property, List fieldNames ) : CamlViewFields

A method used to construct CamlViewFields instance using the specified parameters.
GetAttachmentFullUrl ( string listId, string itemId, string attachmentFileName ) : string

A method used to get full URL of an attachment
GetAttachmentUrlFromResponse ( GetAttachmentCollectionResponseGetAttachmentCollectionResult responseOfGetAttachmentColection, string attachmentName ) : string

A method used to get attachment Url from response of GetAttachmentCollection operation
GetCustomPacificTimeZoneXmlSetting ( ) : TimeZoneXML

A method used to get TimeZoneXML setting instance of Pacific time(UTC-8:00). The daylight saving setting is that: UTC-7:00 start at "3th month/second week/Sunday/2:00 AM" and end at "11th month/first week/Sunday/2:00 AM"
GetDailyRecurrenceSettingWithwindowEnd ( string eventTitle, System.DateTime eventDate, string dayFrequencyValue, double durationOfRecurrence ) : string>.Dictionary

Generate a daily recurrence setting with specified dayFrequency, specified title and duration.
GetElementValue ( XmlNode elements, string name ) : string

A method used to get the value of Element from an XmlElement array by specified name.
GetExceptionDeletionSettingWithEventUpdate ( string>.Dictionary originalRecurrenceSetting, System.DateTime updatedEventDate ) : string>.Dictionary

A method used to get fields' setting which trigger the exception items deletion.
GetExceptionsItemSettingForRecurrenceEvent ( System.DateTime exceptionItemEventDate, System.DateTime recurrenceID, string exceptionTitle, string masterSeriesItemID, string>.Dictionary recurrenceEventSetting ) : string>.Dictionary

A method used to get fields' setting of exception item of an existing recurrence item.
GetGeneralFormatTimeString ( System.DateTime sourceDateTime ) : string

A method used to get a general format time string with zero seconds from specified DateTime type. The format is look like this: "2012-12-21 23:59:00"
GetGeneralRecurrenceEventFieldsSetting ( string eventTitle, System.DateTime eventDate, System.DateTime endDate, string recurrenceXmlString ) : string>.Dictionary

A method used to get fields setting of recurrence event.
GetListItemIdsFromUpdateListItemsResponse ( UpdateListItemsResponseUpdateListItemsResult updateListItemResponse, int expectedUpdatedListItem ) : List

A method used to get list item id collection from the operation of UpdateListItems operation. If the [expectedUpdatedListItem] parameter specified value and the response does not contain expected list items' id record, method will throw Assert exception.
GetListItemsChangesFromSUT ( string listId ) : System.Xml.XmlNode[]

A method used to get list items changes from protocol SUT, it will use "GetListItemChangesSinceToken" operation as the first choice. If the protocol SUT does not support the "GetListItemChangesSinceToken" operation, this method will use "GetListItemChanges" operation. Support GetListItemChangesSinceToken" operation is determined by "R106802Enabled" property on product option behaviors configuration file. The method will set an empty "ViewFields" element in request of SOAP operation, in order to show all fields' value of a list. This method will set "EnumRecurrencePatternXMLVersion.v3" in request, so that it could receive recurrence XML for certain types of recurrences appointment items.
GetListItemsChangesFromSUT ( string listId, CamlViewFields viewfieds ) : System.Xml.XmlNode[]

A method used to get list items changes from protocol SUT, it will use "GetListItemChangesSinceToken" operation as the first choice. If the protocol SUT does not support the "GetListItemChangesSinceToken" operation, this method will use "GetListItemChanges" operation. Support GetListItemChangesSinceToken" operation is determined by "R106802Enabled" property on product option behaviors configuration file. This method will set "EnumRecurrencePatternXMLVersion.v3" in request, so that it could receive recurrence XML for certain types of recurrences appointment items. If there are no any list items get by this method, it will throw Assert exception.
GetMessageDataForAddDiscussionBoardItem ( ) : byte[]

A method is used to get a valid format message data for AddDiscussionBoardItem operation. This method will generate a unique title, unique Thread-index and unique Message-ID for the message data of a DiscussionBoard item.
GetRecurrenceXMLString ( RecurrenceXML recurrenceXMLData ) : string

A method used to get a recurrence XML string, which is used to setting the recurrence appointment item on event list.
GetStatusCodeFromWebException ( WebException webException ) : HttpStatusCode

A method used to get the status code from WebException instance.
GetTimeZoneXMLString ( TimeZoneXML timeZoneXMLData ) : string

A method used to get a TimeZoneXML XML string, which is used to setting the recurrence appointment item on event list.
GetUTCFormatTimeString ( System.DateTime sourceDateTime ) : string

A method used to get a UTC format time string from specified DateTime type.
GetUniqueAttachmentName ( ) : string

A method is used to get a Unique attachment Name
GetUniqueContentTypeName ( ) : string

A method is used to get a Unique ContentType Name
GetUniqueFieldName ( ) : string

A method is used to get a Unique field Name
GetUniqueFolderName ( ) : string

A method is used to get a Unique folder Name
GetUniqueListItemName ( ) : string

A method is used to get a Unique List item Name
GetUniqueListItemTitle ( string prefixOfListItem ) : string

A method is used to get a unique name of list item title.
GetUniqueListName ( string listTemplateType ) : string

A method is used to get a Unique List Name
GetUniqueMetaInfoFieldPropertyName ( ) : string

A method is used to get a Unique MetaInfoField Property Name
GetUniqueUploadFileName ( ) : string

A method is used to get a unique name of file which is used to upload into document library.
GetUpdatedRecurrenceSetting ( string>.Dictionary originalRecurrenceSetting, string fieldName, string fieldValue ) : string>.Dictionary

A method used to update the fields' setting by specified value.
GetZrowItemIndexByFileRef ( XmlNode zrowItems, string fileRefEndWithValue ) : int

A method used to try to get the index of zrow items array by specified end with value for fileRef field. If there are no any match zrow items found in zrow items array, this method will throw Assert exception.
GetZrowItemIndexByListItemId ( XmlNode zrowItems, string listItemId ) : int

A method used to get the index of zrow items array by specified list item id. If there are no any match zrow items found in zrow items array, this method will throw Assert exception.
GetZrowItems ( XmlNode elementsCollection ) : System.Xml.XmlNode[]

A method used to get z:row elements from a elements collection
TryGetListItemsChangesFromSUT ( string listId, CamlViewFields viewfieds ) : System.Xml.XmlNode[]

A method used to get list items changes from protocol SUT, it will use "GetListItemChangesSinceToken" operation as the first choice. If the protocol SUT does not support the "GetListItemChangesSinceToken" operation, this method will use "GetListItemChanges" operation. Support GetListItemChangesSinceToken" operation is determined by "R106802Enabled" property on product option behaviors configuration file. This method will set "EnumRecurrencePatternXMLVersion.v3" in request, so that it could receive recurrence XML for certain types of recurrences appointment items.
TryGetZrowItemIndexByListItemId ( XmlNode zrowItems, string listItemId ) : int

A method used to get the index of zrow items array by specified list item id. If there are no any match zrow items found in zrow items array, this method will return -1.
TryGetZrowItems ( XmlNode elementsCollection ) : System.Xml.XmlNode[]

A method used to get z:row elements from a elements collection, if there are no any zrow items return, this method will return a 0 length array.
VerifyComplexTypesSchema ( string complexTypeFieldValue, Type typeOfComplexType ) : bool

A method used to verify complex types in MS-OUTSPS, only support RecurrenceXML, TimeZoneXML, AttachProps 3 types.If there are any validation errors, method will throw method will throw a XmlSchemaValidationException exception.
VerifyContainExpectedListItemById ( string listItemIdValue, XmlNode zrowCollection ) : bool

A method used to verify whether the zrow collection contain an expected list item whose id equal to specified value.
VerifyContainResultItem ( UpdateListItemsResponseUpdateListItemsResult responseOfUpdateListItems, int expectedItemNumber ) : void

A method used to verify the response of UpdateListItems operation whether contain "Result" item under "Results" element. If the response does not contain any "Result" items, this method will throw Assert exception.
VerifyContainZrowDataStructure ( GetListItemChangesResponseGetListItemChangesResult listitemChangesRes ) : void

A method used to verify the response of GetListItemChanges operation whether contain at least one rs:data structure item under "listitems" element. If the response does not contain any rs:data item under "listitems" element, this method will throw Assert exception.
VerifyContainZrowDataStructure ( GetListItemChangesSinceTokenResponseGetListItemChangesSinceTokenResult listitemChangesRes ) : void

A method used to verify the response of GetListItemChangesSinceToken operation whether contain zrow data structure under "listitems" element. If the response does not contain the structure, this method will throw Assert exception.
VerifyEqualOrLargerThanSpecifiedVersionString ( string currentVersion, string specifiedVersion ) : bool

A method used to verify whether a version string is equal or larger than specified version string. Only support the version string whose sub versions values all are integer format.
VerifyResponseOfUpdateListItem ( UpdateListItemsResponseUpdateListItemsResult updateResult ) : void

A method is used to verify the result for UpdateListItem operation. If not all the update operation succeed, this method will throw Assert exception.
VerifySimpleTypeSchema ( XmlNode zrowItems ) : bool

A method used to verify simple types defined in MS-OUTSPS for each zrow items. The "Priority" field's schema definition is only valid for zrow item which indicate the Appointment list item's data. If there are any schema validation errors, method will throw a XmlSchemaValidationException exception.

Private Methods

Method Description
AddFieldsToList ( string listId, List fieldNames, List fieldTypes ) : void

A method used to add specified fields to the specified list. If any error occurs, this will fail the test case.
ClassCleanup ( ) : void
ClassInitialize ( Microsoft.VisualStudio.TestTools.UnitTesting.TestContext testContext ) : void
CompareTwoVersionString ( List versionValuesOfCurrentVersion, List versionValusOfSpecified ) : bool

A method used to verify whether a version string is larger than specified version string. Only support the version string whose sub versions values all are integer format.
CreateAddListFieldsRequest ( List fieldNames, List fieldTypes, bool isRequired, string viewName ) : UpdateListFieldsRequest

This method is used to construct UpdateListFieldsRequest instance for UpdateList operation's add fields parameter.
SetDiscussionItemMessageProperty ( string discussionMessageString, string propertyName, string expectedValue ) : string

A method used to set the property value of a message data which is used for Discussion Board item. and the message data must follow this rule:The message MUST be in MIME [RFC2045] format and then Base64 [RFC4648] encoded. Message headers [RFC2822] MUST contain the following text properties. More detail are described in [MS-LISTSWS] section 3.1.4.2.2.1
TestCaseCleanup ( ) : void
TestCaseInitialize ( ) : void

Method Details

AddFolderIntoList() protected method

A method used to add a folder into specified document library.
protected AddFolderIntoList ( string listId, string folderItemName ) : string
listId string A parameter represents the id of a list where the folder is added.
folderItemName string A parameter represents the name of folder item which is added to specified list.
return string

AddItemsToList() protected method

A method is used to add list items by specified number items to specified list. This method update the column value specified by ListFieldText property in the PTF configuration file, and the value of this column is specified by random generated string.
protected AddItemsToList ( string list, int itemCount ) : List
list string A parameter represents list GUID or list title
itemCount int A parameter represents how many items would be added into the list
return List

AddListToSUT() protected method

A method used to Create a list by configured list name and specified list template.
protected AddListToSUT ( TemplateType listTemplate ) : string
listTemplate TemplateType A parameter represents the template type of list template
return string

AddListToSUT() protected method

A method used to create a list by specified list name and template type.
protected AddListToSUT ( string listName, TemplateType listTemplate ) : string
listName string A parameter represents the list name which is used in add list process.
listTemplate TemplateType A parameter represents the list template which the new list used.
return string

AppenddeleteExceptionsElement() protected method

A method used to append "deleteExceptions" element on a value of "RecurrenceData" field. This element must be present if and only if protocol client update "EndDate", "EventDate", "RecurrenceData", "UID", "XMLTZone" fields for an recurrence appointment item and expect protocol SUT trigger the exception deletion.
protected AppenddeleteExceptionsElement ( string>.Dictionary originalRecurrenceSetting ) : string>.Dictionary
originalRecurrenceSetting string>.Dictionary A parameter represents the fields' setting which expected to append the "deleteExceptions" element on "RecurrenceData" field.
return string>.Dictionary

CleanUpAddedList() protected method

A method used to Clean up added lists. Any lists added by Test Case Helper would be deleted.
protected CleanUpAddedList ( ) : void
return void

CreateUpdateListItems() protected method

A method used to construct UpdateListItemsUpdates instance using the specified parameters.
protected CreateUpdateListItems ( List methodCollection, string>.List fieldNameValuePairs, OnErrorEnum errorhandleType ) : UpdateListItemsUpdates
methodCollection List A list of MethodCmdEnum to specify the operations.
fieldNameValuePairs string>.List A list of items values.
errorhandleType OnErrorEnum Specify the OnError of the Batch element's value.
return UpdateListItemsUpdates

DeleteListItems() protected method

Delete the specified items in the specified list.
protected DeleteListItems ( string list, List deleteIDList, OnErrorEnum errorEnum ) : void
list string A parameter represents the list title or list id.
deleteIDList List Specify the delete items id.
errorEnum OnErrorEnum Specify how to affect the following sequence when one delete item method fails.
return void

GenerateRandomNumber() protected method

This method is used to random generate an integer in the specified range.
protected GenerateRandomNumber ( int minValue, int maxValue ) : string
minValue int The inclusive lower bound of the random number returned.
maxValue int The exclusive upper bound of the random number returned.
return string

GenerateRandomString() protected method

This method is used to generate random string in the range A-Z with the specified string size.
protected GenerateRandomString ( int size ) : string
size int A parameter represents the generated string size.
return string

GenerateUniqueAttachmentContents() protected method

A method used to generate unique contents for attachment.
protected GenerateUniqueAttachmentContents ( ) : byte[]
return byte[]

GenerateUniqueAttachmentContents() protected method

A method used to generate unique contents for attachment.
protected GenerateUniqueAttachmentContents ( int attachmentStringLength ) : byte[]
attachmentStringLength int A parameter represents the length of the string content in attachment.
return byte[]

GenerateViewFields() protected method

A method used to construct CamlViewFields instance using the specified parameters.
protected GenerateViewFields ( bool property, List fieldNames ) : CamlViewFields
property bool A Boolean value indicate whether the properties attribute value is TRUE/FALSE
fieldNames List Specified the CamlViewFields instance's fields.
return Microsoft.Protocols.TestSuites.Common.CamlViewFields

GetAttachmentFullUrl() protected method

A method used to get full URL of an attachment
protected GetAttachmentFullUrl ( string listId, string itemId, string attachmentFileName ) : string
listId string A parameter represents current list
itemId string A parameter represents the list item where the method would search attachment
attachmentFileName string A parameter represents the attachment fie name which is used to key work
return string

GetAttachmentUrlFromResponse() protected method

A method used to get attachment Url from response of GetAttachmentCollection operation
protected GetAttachmentUrlFromResponse ( GetAttachmentCollectionResponseGetAttachmentCollectionResult responseOfGetAttachmentColection, string attachmentName ) : string
responseOfGetAttachmentColection GetAttachmentCollectionResponseGetAttachmentCollectionResult A parameter represents the response of GetAttachmentCollection operation which should contain expected attachment url.
attachmentName string A parameter represents the name of attachment which is used to find out the url from the response of GetAttachmentCollection operation.
return string

GetCustomPacificTimeZoneXmlSetting() protected method

A method used to get TimeZoneXML setting instance of Pacific time(UTC-8:00). The daylight saving setting is that: UTC-7:00 start at "3th month/second week/Sunday/2:00 AM" and end at "11th month/first week/Sunday/2:00 AM"
protected GetCustomPacificTimeZoneXmlSetting ( ) : TimeZoneXML
return TimeZoneXML

GetDailyRecurrenceSettingWithwindowEnd() protected method

Generate a daily recurrence setting with specified dayFrequency, specified title and duration.
protected GetDailyRecurrenceSettingWithwindowEnd ( string eventTitle, System.DateTime eventDate, string dayFrequencyValue, double durationOfRecurrence ) : string>.Dictionary
eventTitle string A parameter represents the title of event.
eventDate System.DateTime A parameter represents the event date of event. The end date of the event is computed from this parameter by this formula: eventDate + 1 hour.
dayFrequencyValue string A parameter represents the value of daily recurrent frequency.
durationOfRecurrence double A parameter represents the duration of the recurrence event
return string>.Dictionary

GetElementValue() protected method

A method used to get the value of Element from an XmlElement array by specified name.
protected GetElementValue ( XmlNode elements, string name ) : string
elements System.Xml.XmlNode A parameter represents the source elements where the method finds the value.
name string A parameter represents the specified element name which is used to find element's value.
return string

GetExceptionDeletionSettingWithEventUpdate() protected method

A method used to get fields' setting which trigger the exception items deletion.
protected GetExceptionDeletionSettingWithEventUpdate ( string>.Dictionary originalRecurrenceSetting, System.DateTime updatedEventDate ) : string>.Dictionary
originalRecurrenceSetting string>.Dictionary A parameter represents the fields' setting which is existing recurrence appointment item on SUT.
updatedEventDate System.DateTime A parameter represents the updated value of EventDate field.
return string>.Dictionary

GetExceptionsItemSettingForRecurrenceEvent() protected method

A method used to get fields' setting of exception item of an existing recurrence item.
protected GetExceptionsItemSettingForRecurrenceEvent ( System.DateTime exceptionItemEventDate, System.DateTime recurrenceID, string exceptionTitle, string masterSeriesItemID, string>.Dictionary recurrenceEventSetting ) : string>.Dictionary
exceptionItemEventDate System.DateTime A parameter represents the event date of the exception item.
recurrenceID System.DateTime A parameter represents the RecurrenceID field value of this exception item. The RecurrenceID must be equal to the starting date and time of one instance of a recurrence.
exceptionTitle string A parameter represents the title of the exception item.
masterSeriesItemID string A parameter represents the MasterSeriesItemID field value of this exception item. The RecurrenceID must be equal to the list item id of the recurring item that the exception belongs to.
recurrenceEventSetting string>.Dictionary A parameter represents the fields' setting of an existing recurrence item which the exception item belong to.
return string>.Dictionary

GetGeneralFormatTimeString() protected method

A method used to get a general format time string with zero seconds from specified DateTime type. The format is look like this: "2012-12-21 23:59:00"
protected GetGeneralFormatTimeString ( System.DateTime sourceDateTime ) : string
sourceDateTime System.DateTime A parameter represents the DateTime type instance which will be converted to a "2012-12-21 HH:mm:00" format string.
return string

GetGeneralRecurrenceEventFieldsSetting() protected method

A method used to get fields setting of recurrence event.
protected GetGeneralRecurrenceEventFieldsSetting ( string eventTitle, System.DateTime eventDate, System.DateTime endDate, string recurrenceXmlString ) : string>.Dictionary
eventTitle string A parameter represents the title of event.
eventDate System.DateTime A parameter represents the event date of event.
endDate System.DateTime A parameter represents the end date of event.
recurrenceXmlString string A parameter represents the xml string of recurrence setting.
return string>.Dictionary

GetListItemIdsFromUpdateListItemsResponse() protected method

A method used to get list item id collection from the operation of UpdateListItems operation. If the [expectedUpdatedListItem] parameter specified value and the response does not contain expected list items' id record, method will throw Assert exception.
protected GetListItemIdsFromUpdateListItemsResponse ( UpdateListItemsResponseUpdateListItemsResult updateListItemResponse, int expectedUpdatedListItem ) : List
updateListItemResponse UpdateListItemsResponseUpdateListItemsResult A parameter represents the response of UpdateListItems operation.
expectedUpdatedListItem int A parameter represents the expected number of updated list items. The method will perform a check: if the actual number of updated list items does not equal to this value, this method will throw a Assert Exception. Specified this value to null means the method does not perform the check process.
return List

GetListItemsChangesFromSUT() protected method

A method used to get list items changes from protocol SUT, it will use "GetListItemChangesSinceToken" operation as the first choice. If the protocol SUT does not support the "GetListItemChangesSinceToken" operation, this method will use "GetListItemChanges" operation. Support GetListItemChangesSinceToken" operation is determined by "R106802Enabled" property on product option behaviors configuration file. The method will set an empty "ViewFields" element in request of SOAP operation, in order to show all fields' value of a list. This method will set "EnumRecurrencePatternXMLVersion.v3" in request, so that it could receive recurrence XML for certain types of recurrences appointment items.
protected GetListItemsChangesFromSUT ( string listId ) : System.Xml.XmlNode[]
listId string A parameter represents the id of the list, which contain list items' changes.
return System.Xml.XmlNode[]

GetListItemsChangesFromSUT() protected method

A method used to get list items changes from protocol SUT, it will use "GetListItemChangesSinceToken" operation as the first choice. If the protocol SUT does not support the "GetListItemChangesSinceToken" operation, this method will use "GetListItemChanges" operation. Support GetListItemChangesSinceToken" operation is determined by "R106802Enabled" property on product option behaviors configuration file. This method will set "EnumRecurrencePatternXMLVersion.v3" in request, so that it could receive recurrence XML for certain types of recurrences appointment items. If there are no any list items get by this method, it will throw Assert exception.
protected GetListItemsChangesFromSUT ( string listId, CamlViewFields viewfieds ) : System.Xml.XmlNode[]
listId string A parameter represents the id of the list, which contain list items' changes.
viewfieds Microsoft.Protocols.TestSuites.Common.CamlViewFields A parameter represents the CamlViewFields instance which will be set into the request of SOAP operation, if this value is null, this method will set a "ViewFields" element in request of SOAP operation.
return System.Xml.XmlNode[]

GetMessageDataForAddDiscussionBoardItem() protected method

A method is used to get a valid format message data for AddDiscussionBoardItem operation. This method will generate a unique title, unique Thread-index and unique Message-ID for the message data of a DiscussionBoard item.
protected GetMessageDataForAddDiscussionBoardItem ( ) : byte[]
return byte[]

GetRecurrenceXMLString() protected method

A method used to get a recurrence XML string, which is used to setting the recurrence appointment item on event list.
protected GetRecurrenceXMLString ( RecurrenceXML recurrenceXMLData ) : string
recurrenceXMLData RecurrenceXML A parameter represents the RecurrenceXML type instance which include the setting the settings of recurrence appointment.
return string

GetStatusCodeFromWebException() protected method

A method used to get the status code from WebException instance.
protected GetStatusCodeFromWebException ( WebException webException ) : HttpStatusCode
webException System.Net.WebException A parameter represents the WebException instance which contains the status code.
return HttpStatusCode

GetTimeZoneXMLString() protected method

A method used to get a TimeZoneXML XML string, which is used to setting the recurrence appointment item on event list.
protected GetTimeZoneXMLString ( TimeZoneXML timeZoneXMLData ) : string
timeZoneXMLData TimeZoneXML A parameter represents the TimeZoneXML type instance which include the setting the settings of recurrence appointment.
return string

GetUTCFormatTimeString() protected method

A method used to get a UTC format time string from specified DateTime type.
protected GetUTCFormatTimeString ( System.DateTime sourceDateTime ) : string
sourceDateTime System.DateTime A parameter represents the DateTime type instance which will be converted to a UTC format string.
return string

GetUniqueAttachmentName() protected method

A method is used to get a Unique attachment Name
protected GetUniqueAttachmentName ( ) : string
return string

GetUniqueContentTypeName() protected method

A method is used to get a Unique ContentType Name
protected GetUniqueContentTypeName ( ) : string
return string

GetUniqueFieldName() protected method

A method is used to get a Unique field Name
protected GetUniqueFieldName ( ) : string
return string

GetUniqueFolderName() protected method

A method is used to get a Unique folder Name
protected GetUniqueFolderName ( ) : string
return string

GetUniqueListItemName() protected method

A method is used to get a Unique List item Name
protected GetUniqueListItemName ( ) : string
return string

GetUniqueListItemTitle() protected method

A method is used to get a unique name of list item title.
protected GetUniqueListItemTitle ( string prefixOfListItem ) : string
prefixOfListItem string A parameter represents the prefix of the list item. It will present as '[prefixOfListItem]Item' in the unique name.
return string

GetUniqueListName() protected method

A method is used to get a Unique List Name
protected GetUniqueListName ( string listTemplateType ) : string
listTemplateType string A parameter represents the type of the list.
return string

GetUniqueMetaInfoFieldPropertyName() protected method

A method is used to get a Unique MetaInfoField Property Name
protected GetUniqueMetaInfoFieldPropertyName ( ) : string
return string

GetUniqueUploadFileName() protected method

A method is used to get a unique name of file which is used to upload into document library.
protected GetUniqueUploadFileName ( ) : string
return string

GetUpdatedRecurrenceSetting() protected method

A method used to update the fields' setting by specified value.
protected GetUpdatedRecurrenceSetting ( string>.Dictionary originalRecurrenceSetting, string fieldName, string fieldValue ) : string>.Dictionary
originalRecurrenceSetting string>.Dictionary A parameter represents the fields' setting expected to update.
fieldName string A parameter represents the target field's name which the method will update.
fieldValue string A parameter represents the updated value.
return string>.Dictionary

GetZrowItemIndexByFileRef() protected method

A method used to try to get the index of zrow items array by specified end with value for fileRef field. If there are no any match zrow items found in zrow items array, this method will throw Assert exception.
protected GetZrowItemIndexByFileRef ( XmlNode zrowItems, string fileRefEndWithValue ) : int
zrowItems System.Xml.XmlNode A parameter represents the zrow items array.
fileRefEndWithValue string A parameter represent the value which the fileRef field should end with.For a document library item, the fileRef field value should end with the list item's actual name.
return int

GetZrowItemIndexByListItemId() protected method

A method used to get the index of zrow items array by specified list item id. If there are no any match zrow items found in zrow items array, this method will throw Assert exception.
protected GetZrowItemIndexByListItemId ( XmlNode zrowItems, string listItemId ) : int
zrowItems System.Xml.XmlNode A parameter represents the zrow items array.
listItemId string A parameter represents the list item id, which indicates a list item. each zrow item means a list item in protocol SUT.
return int

GetZrowItems() protected method

A method used to get z:row elements from a elements collection
protected GetZrowItems ( XmlNode elementsCollection ) : System.Xml.XmlNode[]
elementsCollection System.Xml.XmlNode A parameter represents a elements collection which contains z:row elements
return System.Xml.XmlNode[]

TryGetListItemsChangesFromSUT() protected method

A method used to get list items changes from protocol SUT, it will use "GetListItemChangesSinceToken" operation as the first choice. If the protocol SUT does not support the "GetListItemChangesSinceToken" operation, this method will use "GetListItemChanges" operation. Support GetListItemChangesSinceToken" operation is determined by "R106802Enabled" property on product option behaviors configuration file. This method will set "EnumRecurrencePatternXMLVersion.v3" in request, so that it could receive recurrence XML for certain types of recurrences appointment items.
protected TryGetListItemsChangesFromSUT ( string listId, CamlViewFields viewfieds ) : System.Xml.XmlNode[]
listId string A parameter represents the id of the list, which contain list items' changes.
viewfieds Microsoft.Protocols.TestSuites.Common.CamlViewFields A parameter represents the CamlViewFields instance which will be set into the request of SOAP operation, if this value is null, this method will set a "ViewFields" element in request of SOAP operation.
return System.Xml.XmlNode[]

TryGetZrowItemIndexByListItemId() protected method

A method used to get the index of zrow items array by specified list item id. If there are no any match zrow items found in zrow items array, this method will return -1.
protected TryGetZrowItemIndexByListItemId ( XmlNode zrowItems, string listItemId ) : int
zrowItems System.Xml.XmlNode A parameter represents the zrow items array.
listItemId string A parameter represents the list item id, which indicates a list item. each zrow item means a list item in protocol SUT.
return int

TryGetZrowItems() protected method

A method used to get z:row elements from a elements collection, if there are no any zrow items return, this method will return a 0 length array.
protected TryGetZrowItems ( XmlNode elementsCollection ) : System.Xml.XmlNode[]
elementsCollection System.Xml.XmlNode A parameter represents a elements collection which contains z:row elements
return System.Xml.XmlNode[]

VerifyComplexTypesSchema() protected method

A method used to verify complex types in MS-OUTSPS, only support RecurrenceXML, TimeZoneXML, AttachProps 3 types.If there are any validation errors, method will throw method will throw a XmlSchemaValidationException exception.
protected VerifyComplexTypesSchema ( string complexTypeFieldValue, Type typeOfComplexType ) : bool
complexTypeFieldValue string A parameter represents the value of complex type.
typeOfComplexType System.Type A parameter represents the type of the value specified by complexTypeFieldValue parameter.
return bool

VerifyContainExpectedListItemById() protected method

A method used to verify whether the zrow collection contain an expected list item whose id equal to specified value.
protected VerifyContainExpectedListItemById ( string listItemIdValue, XmlNode zrowCollection ) : bool
listItemIdValue string A parameter represents the expected list item id value.
zrowCollection System.Xml.XmlNode A parameter represents the zrow collection which contain list items.
return bool

VerifyContainResultItem() protected method

A method used to verify the response of UpdateListItems operation whether contain "Result" item under "Results" element. If the response does not contain any "Result" items, this method will throw Assert exception.
protected VerifyContainResultItem ( UpdateListItemsResponseUpdateListItemsResult responseOfUpdateListItems, int expectedItemNumber ) : void
responseOfUpdateListItems UpdateListItemsResponseUpdateListItemsResult A parameter represents the response of UpdateListItems operation which expected to contain "Result" item under "Results" element.
expectedItemNumber int A parameter represents the how many items the response of UpdateListItems operation expected to contain. If does not specified the expectedItemNumber value, method will not perform the expected items' number verification.
return void

VerifyContainZrowDataStructure() protected method

A method used to verify the response of GetListItemChanges operation whether contain at least one rs:data structure item under "listitems" element. If the response does not contain any rs:data item under "listitems" element, this method will throw Assert exception.
protected VerifyContainZrowDataStructure ( GetListItemChangesResponseGetListItemChangesResult listitemChangesRes ) : void
listitemChangesRes GetListItemChangesResponseGetListItemChangesResult A parameter represents the response of GetListItemChangesSinceToken operation which expected to contain zrow data structure under "listitems" element.
return void

VerifyContainZrowDataStructure() protected method

A method used to verify the response of GetListItemChangesSinceToken operation whether contain zrow data structure under "listitems" element. If the response does not contain the structure, this method will throw Assert exception.
protected VerifyContainZrowDataStructure ( GetListItemChangesSinceTokenResponseGetListItemChangesSinceTokenResult listitemChangesRes ) : void
listitemChangesRes GetListItemChangesSinceTokenResponseGetListItemChangesSinceTokenResult A parameter represents the response of GetListItemChangesSinceToken operation which expected to contain zrow data structure under "listitems" element.
return void

VerifyEqualOrLargerThanSpecifiedVersionString() protected method

A method used to verify whether a version string is equal or larger than specified version string. Only support the version string whose sub versions values all are integer format.
protected VerifyEqualOrLargerThanSpecifiedVersionString ( string currentVersion, string specifiedVersion ) : bool
currentVersion string A parameter represents the version value which is compare to specified version value.
specifiedVersion string A parameter represents the version value which is used as comparing standard.
return bool

VerifyResponseOfUpdateListItem() protected method

A method is used to verify the result for UpdateListItem operation. If not all the update operation succeed, this method will throw Assert exception.
protected VerifyResponseOfUpdateListItem ( UpdateListItemsResponseUpdateListItemsResult updateResult ) : void
updateResult UpdateListItemsResponseUpdateListItemsResult The response of the UpdateListItem operation.
return void

VerifySimpleTypeSchema() protected method

A method used to verify simple types defined in MS-OUTSPS for each zrow items. The "Priority" field's schema definition is only valid for zrow item which indicate the Appointment list item's data. If there are any schema validation errors, method will throw a XmlSchemaValidationException exception.
protected VerifySimpleTypeSchema ( XmlNode zrowItems ) : bool
zrowItems System.Xml.XmlNode A parameter represents the zrow items' collection which are used to perform schema check.
return bool