C# Class Microsoft.Protocols.TestSuites.MS_OFFICIALFILE.MS_OFFICIALFILEAdapter

MS-OFFICIALFILE protocol's adapter.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_OFFICIALFILEAdapter

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
GetFinalRoutingDestinationFolderUrl ( RecordsRepositoryProperty properties, string contentTypeName, string originalSaveLocation ) : DocumentRoutingResult	This operation is used to determine the storage location for the submission based on the rules in the repository and a suggested save location chosen by a user.
GetHoldsInfo ( ) : Microsoft.Protocols.TestSuites.MS_OFFICIALFILE.HoldInfo[]	This operation is called to retrieve information about the legal holds in a repository.
GetRecordRoutingCollection ( ) : string	This method is used to retrieve the recording routing collection information.
GetRecordingRouting ( string recordRouting ) : string	This method is used to retrieve the recording routing information.
GetServerInfo ( ) : ServerInfo	This operation is used to retrieves data about the type, version of the repository and whether the repository is configured for routing.
Initialize ( ITestSite testSite ) : void	Overrides IAdapter's Initialize(), to set testSite.DefaultProtocolDocShortName.
IntializeService ( InitialPara paras ) : void	Initialize the services of MS-OFFICIALFILE.
SubmitFile ( [ DataType = "base64Binary")]byte[]fileToSubmit, [ IsNullable = false)]RecordsRepositoryProperty[]properties, string recordRouting, string sourceUrl, string userName ) : SubmitFileResult	This operation is used to submit a file and its associated properties to the repository.

Private Methods

Method	Description
ParseGetServerInfoResult ( string serverInfo ) : ServerInfo	This method is used to parse the GetServerInfoResult from xml to class.
ParseSubmitFileResult ( string response ) : SubmitFileResult	This method is used to parse the SubmitFileResult from xml to class.
VerifyAndParseGetServerInfo ( string serverInfo ) : ServerInfo	Verify the requirements of GetServerInfo and parse the GetServerInfoResult from xml to class When the server returns a GetServerInfo response successfully.
VerifyAndParseSubmitFile ( string result ) : SubmitFileResult	Verify the requirements of SubmitFile in Adapter. When the server returns a SubmitFile response successfully, which includes web service output message and soap fault.
VerifyGetFinalRoutingDestinationFolderUrl ( ) : void	Verify the requirements of FinalRoutingDestinationFolderUrl in Adapter. When the server returns a GetFinalRoutingDestinationFolderUrl response successfully, which includes web service output message and soap fault.
VerifyGetHoldsInfo ( ) : void	Verify the requirements of GetHoldsInfo When the server returns a GetHoldsInfo response successfully, which includes web service output message and soap fault.
VerifyGetRoutingCollectionInfo ( ) : void	Verify the requirements of GetRoutingInfo When the server returns a GetRoutingInfo response successfully, which includes web service output message and soap fault.
VerifyGetRoutingInfo ( ) : void	Verify the requirements of GetRoutingInfo in Adapter When the server returns a GetRoutingInfo response successfully, which includes web service output message and soap fault.
VerifyTransportRelatedRequirments ( ) : void	Verify underlying transport protocol related requirements. These requirements can be captured directly when the server returns a SOAP response successfully, which includes web service output message and soap fault.

Method Details

GetFinalRoutingDestinationFolderUrl() public method

This operation is used to determine the storage location for the submission based on the rules in the repository and a suggested save location chosen by a user.

public GetFinalRoutingDestinationFolderUrl ( RecordsRepositoryProperty properties, string contentTypeName, string originalSaveLocation ) : DocumentRoutingResult
properties	RecordsRepositoryProperty	The properties of the file.
contentTypeName	string	The file type.
originalSaveLocation	string	The suggested save location chosen by a user.
return	DocumentRoutingResult

GetHoldsInfo() public method

This operation is called to retrieve information about the legal holds in a repository.

public GetHoldsInfo ( ) : Microsoft.Protocols.TestSuites.MS_OFFICIALFILE.HoldInfo[]
return	Microsoft.Protocols.TestSuites.MS_OFFICIALFILE.HoldInfo[]

GetRecordRoutingCollection() public method

This method is used to retrieve the recording routing collection information.

public GetRecordRoutingCollection ( ) : string
return	string

GetRecordingRouting() public method

This method is used to retrieve the recording routing information.

public GetRecordingRouting ( string recordRouting ) : string
recordRouting	string	The file type.
return	string

GetServerInfo() public method

This operation is used to retrieves data about the type, version of the repository and whether the repository is configured for routing.

public GetServerInfo ( ) : ServerInfo
return	ServerInfo

Initialize() public method

Overrides IAdapter's Initialize(), to set testSite.DefaultProtocolDocShortName.

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	Transfer ITestSite into adapter,Make adapter can use ITestSite's function.
return	void

IntializeService() public method

Initialize the services of MS-OFFICIALFILE.

public IntializeService ( InitialPara paras ) : void
paras	InitialPara	The TransportType object indicates which transport parameters are used.
return	void

SubmitFile() public method

This operation is used to submit a file and its associated properties to the repository.

public SubmitFile ( [ DataType = "base64Binary")]byte[]fileToSubmit, [ IsNullable = false)]RecordsRepositoryProperty[]properties, string recordRouting, string sourceUrl, string userName ) : SubmitFileResult
DataType	[
IsNullable	[
recordRouting	string	The file type.
sourceUrl	string	The source URL of the file.
userName	string	The name of the user submitting the file.
return	SubmitFileResult