Qore FileDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
FileDataProvider::FileMoveDataProvider Class Reference

The File move data provider class. More...

#include <FileMoveDataProvider.qc.dox.h>

Inherits AbstractDataProvider.

Public Member Methods

string getName ()
 Returns the data provider name.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Public Attributes

const ProviderInfo
 Provider info.
 
const ProviderSummaryInfo
 Provider summary info.
 
const RequestType = new FileMoveRequestDataType()
 Request type.
 
const ResponseType = new FileTargetResponseDataType()
 Response type.
 

Private Member Methods

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response. More...
 
*AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any. More...
 
*AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message. More...
 

Detailed Description

The File move data provider class.

Member Function Documentation

◆ doRequestImpl()

auto FileDataProvider::FileMoveDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
private

Makes a request and returns the response.

Parameters
reqthe request info
request_optionsthe request options; will be processed by validateRequestOptions()
Returns
the response to the request
Exceptions
SAME-FILE-ERRORIf both paths point to the same file.
FILE-STAT-ERRORIf stat call for the source path fails.
PATH-EXISTS-ERRORIf destination path exists and overwrite flag is False

◆ getRequestTypeImpl()

*AbstractDataProviderType FileDataProvider::FileMoveDataProvider::getRequestTypeImpl ( )
private

Returns the description of a successful request message, if any.

Returns
the request type for this provider

◆ getResponseTypeImpl()

*AbstractDataProviderType FileDataProvider::FileMoveDataProvider::getResponseTypeImpl ( )
private

Returns the description of a response message, if this object represents a response message.

Returns
the response type for this response message