Qore FileDataProvider Module Reference 2.0
All Classes Namespaces Functions Variables Modules Pages
FileDataProvider::FileMkdirDataProvider Class Reference

The File mkdir data provider class. More...

#include <FileMkdirDataProvider.qc.dox.h>

Inheritance diagram for FileDataProvider::FileMkdirDataProvider:
[legend]

Public Member Methods

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (*string root, *bool lock, *bool readonly)
 Creates the object from the arguments.
 
string getName ()
 Returns the data provider name.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 
- Public Member Methods inherited from FileDataProvider::FileDataProviderBase
 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (*string root, *bool lock, *bool readonly)
 Creates the object from the arguments.
 

Public Attributes

const ProviderInfo = ...
 Provider info.
 
const ProviderSummaryInfo = ...
 Provider summary info.
 
const RequestType = new FileMkdirRequestDataType()
 Request type.
 
const ResponseType = FilePathDataType
 Response type.
 
- Public Attributes inherited from FileDataProvider::FileDataProviderBase
const ConstructorOptions = ...
 Constructor options.
 

Private Member Methods

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response.
 
*AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any.
 
*AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message.
 
- Private Member Methods inherited from FileDataProvider::FileDataProviderBase
 checkPath (string path)
 Check the given path when "lock" and "root" are set.
 
 checkReadOnly (string op)
 Checks if the readonly flag is set.
 

Additional Inherited Members

- Private Attributes inherited from FileDataProvider::FileDataProviderBase
bool lock
 Lock down access to the root?
 
bool readonly
 Read only flag.
 
*string root
 Any anchoring dir for filesystem actions.
 

Detailed Description

The File mkdir data provider class.

Member Function Documentation

◆ doRequestImpl()

auto FileDataProvider::FileMkdirDataProvider::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

◆ getRequestTypeImpl()

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

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

Returns
the request type for this provider

◆ getResponseTypeImpl()

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

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

Returns
the response type for this response message