Flexberry ORM ODataService 5.2.0-beta01
Интерфейс NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider

Интерфейс для провайдеров файловых свойств объектов данных. Подробнее...

Граф наследования:NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider:
NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider

Открытые члены

FileDescription GetFileDescription (object fileProperty)
 Осуществляет получение метаданных с описанием файлового свойства объекта данных. Подробнее...
 
FileDescription GetFileDescription (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение метаданных с описанием файлового свойства объекта данных. Подробнее...
 
List< FileDescriptionGetFileDescriptions (DataObject dataObject)
 Осуществляет получение списка метаданных с описанием файловых свойств объекта данных, соответствующих типу FilePropertyType. Подробнее...
 
object GetFileProperty (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение файлового свойства объекта данных. Подробнее...
 
object GetFileProperty (string filePath)
 Осуществляет получение файлового свойства из файла, расположенного по заданному пути. Подробнее...
 
object GetFileProperty (FileDescription fileDescription)
 Осуществляет получение файлового свойства объекта данных, по его метаданным. Подробнее...
 
List< object > GetFileProperties (DataObject dataObject)
 Осуществляет получение списка файловых свойств объекта данных, соответствующих типу FilePropertyType. Подробнее...
 
string GetFileName (object fileProperty)
 Осуществляет получение имени файла для файлового свойства объекта данных. Подробнее...
 
string GetFileName (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение имени файла для файлового свойства объекта данных. Подробнее...
 
string GetFileMimeType (object fileProperty)
 Осуществляет получение MIME-типа для файлового свойства объекта данных. Подробнее...
 
string GetFileMimeType (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение MIME-типа для файлового свойства объекта данных. Подробнее...
 
long GetFileSize (object fileProperty)
 Осуществляет получение размера файла, связанного с объектом данных, в байтах. Подробнее...
 
long GetFileSize (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение MIME-типа для файлового свойства объекта данных. Подробнее...
 
Stream GetFileStream (object fileProperty)
 Осуществляет получение потока данных для файлового свойства объекта данных. Подробнее...
 
Stream GetFileStream (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение потока данных для файлового свойства объекта данных. Подробнее...
 
Stream GetFileStream (FileDescription fileDescription)
 Осуществляет получение потока данных для файлового свойства объекта данных. Подробнее...
 
void RemoveFile (FileDescription fileDescription)
 Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных. Подробнее...
 
void RemoveFile (object fileProperty)
 Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных. Подробнее...
 
void RemoveFile (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных. Подробнее...
 

Свойства

Type FilePropertyType [get]
 Получает тип файловых свойств объектов данных, обрабатываемых провайдером. Подробнее...
 
string UploadsDirectoryPath [get, set]
 Получает или задает путь к каталогу, в котором должны храниться файлы, загруженные на сервер при помощи провайдера. Подробнее...
 
string FileBaseUrl [get, set]
 Получат или задает базовую часть URL-а для ссылок на скачивание / удаление файлов. Подробнее...
 

Подробное описание

Интерфейс для провайдеров файловых свойств объектов данных.

Методы

FileDescription NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileDescription ( object  fileProperty)

Осуществляет получение метаданных с описанием файлового свойства объекта данных.

Аргументы
filePropertyФайловое свойство объекта данных, для которого требуется получить метаданные файла.
Возвращает
Метаданные с описанием файлового свойства объекта данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider.

FileDescription NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileDescription ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)

Осуществляет получение метаданных с описанием файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Метаданные с описанием файлового свойства объекта данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

List<FileDescription> NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileDescriptions ( DataObject  dataObject)

Осуществляет получение списка метаданных с описанием файловых свойств объекта данных, соответствующих типу FilePropertyType.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловые свойства.
Возвращает
Список метаданных с описанием файловых свойств объекта данных, соответствующих типу FilePropertyType.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileMimeType ( object  fileProperty)

Осуществляет получение MIME-типа для файлового свойства объекта данных.

Аргументы
filePropertyФайловое свойство объекта данных, для которого требуется получить MIME-тип.
Возвращает
MIME-тип файла, соответствующего заданному файловому свойству.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileMimeType ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)

Осуществляет получение MIME-типа для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить MIME-тип.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
MIME-тип файла, соответствующего заданному файловому свойству.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileName ( object  fileProperty)

Осуществляет получение имени файла для файлового свойства объекта данных.

Аргументы
filePropertyФайловое свойство объекта данных, для которого требуется получить имя файла.
Возвращает
Имя файла.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider, NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileName ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)

Осуществляет получение имени файла для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить имя.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Имя файла.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

List<object> NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileProperties ( DataObject  dataObject)

Осуществляет получение списка файловых свойств объекта данных, соответствующих типу FilePropertyType.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловые свойства.
Возвращает
Список файловых свойств объекта данных, соответствующих типу FilePropertyType.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

object NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileProperty ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)

Осуществляет получение файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Значение файлового свойства объекта данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

object NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileProperty ( string  filePath)

Осуществляет получение файлового свойства из файла, расположенного по заданному пути.

Аргументы
filePathПуть к файлу.
Возвращает
Значение файлового свойства объекта данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider, NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

object NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileProperty ( FileDescription  fileDescription)

Осуществляет получение файлового свойства объекта данных, по его метаданным.

При необходимости будет вычитан объект данных.

Аргументы
fileDescriptionМетаданные с описанием файлового свойства объекта данных.
Возвращает
Значение файлового свойства объекта данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

long NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileSize ( object  fileProperty)

Осуществляет получение размера файла, связанного с объектом данных, в байтах.

Аргументы
filePropertyФайловое свойство объекта данных, для которого требуется получить размер файла.
Возвращает
Размер файла в байтах.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider, NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

long NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileSize ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)

Осуществляет получение MIME-типа для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить MIME-тип.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
MIME-тип файла, соответствующего заданному файловому свойству.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

Stream NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileStream ( object  fileProperty)

Осуществляет получение потока данных для файлового свойства объекта данных.

Аргументы
filePropertyЗначение файлового свойства объекта данных, для которого требуется получить поток данных.
Возвращает
Поток данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider, NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

Stream NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileStream ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)

Осуществляет получение потока данных для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить поток данных.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Поток данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

Stream NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.GetFileStream ( FileDescription  fileDescription)

Осуществляет получение потока данных для файлового свойства объекта данных.

При необходимости будет вычитан объект данных.

Аргументы
fileDescriptionМетаданные с описанием файлового свойства объекта данных, для которого требуется получить поток данных.
Возвращает
Поток данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

void NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.RemoveFile ( FileDescription  fileDescription)

Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных.

Аргументы
fileDescriptionМетаданные удаляемого файла.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

void NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.RemoveFile ( object  fileProperty)

Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных.

Аргументы
filePropertyЗначение файлового свойства объекта данных, для которого требуется выполнить удаление.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

void NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.RemoveFile ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)

Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.

Полный список свойств

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.FileBaseUrl
getset

Получат или задает базовую часть URL-а для ссылок на скачивание / удаление файлов.

Type NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.FilePropertyType
get

Получает тип файловых свойств объектов данных, обрабатываемых провайдером.

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.UploadsDirectoryPath
getset

Получает или задает путь к каталогу, в котором должны храниться файлы, загруженные на сервер при помощи провайдера.