ADN Open CIS
Сообщество программистов Autodesk в СНГ

11/08/2014

Лёгкое программирование под Autodesk Vault Часть 29

Для работы с папками Autodesk Vault API предоставляет ряд методов, доступных в службах DocumentService и DocumentServiceExtensions.

Методы

Служба

Операция

Объект

Опция

Имя метода

Описание

Document
Service

Add

Folder

 

AddFolder

Создание новой папки в хранилище.

Delete

FolderHierarchy

 

DeleteFolder
Hierarchy

Удаление папки с дочерними папками.

FolderHierarchy
Unconditional

 

DeleteFolder
Hierarchy
Unconditional

Безусловное удаление папки и её дочерних папок.

Find

Folders

ByIds

FindFolders
ByIds

Получение объекта Folder на основании его ID.

ByPaths

FindFolders
ByPaths

Получение списка объектов File на основании путей к ним.

BySearchConditions

FindFolders
BySearch
Conditions

Выполняет поиск папок.

FileFolders

BySearchConditions

FindFile
FoldersBy
Search
Conditions

Выполняет поиск в хранилище объектов списка FileFolders.

Get

Folder

ById

GetFolderById

Получение объекта типа Folder на основании его ID.

ByPath

GetFolderByPath

Получение объекта Folder на основании пути.

Folders

ByFileMasterId

GetFolders
ByFileMasterId

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

ByFileMasterIds

GetFolders
ByFileMasterIds

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

ByIds

GetFolders
ByIds

Получение объекта Folder на основании его ID.

ByParentId

GetFolders
ByParentId

Получение подпапок папки хранилища.

ByParentIds

GetFolders
ByParentIds

Получение подпапок набора папок хранилища.

ByPaths

GetFolders
ByPaths

Получение списка объектов Folder на основании путей к ним.

FileFolders

ByLabelId

GetFile
FoldersBy
LabelId

Получение списка объектов FileFolder на основании ID метки.

LatestFiles

ByFolderId

GetLatestFiles
ByFolderId

Получение последних версий всех файлов в папке.

ByFolderIds

GetLatestFiles
ByFolderIds

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

FolderDelete
Restrictions

ById

GetFolder
Delete
Restrictions
ById

Получение всех ограничений на удаление для папки.

ByIds

GetFolder
Delete
Restrictions
ByIds

Получение всех ограничений на удаление для набора папок.

FolderIds

ByParentIds

GetFolderIds
ByParentIds

Получение ID подпапок набора папок.

FolderMove
Restrictions

 

GetFolder
Move
Restrictions

Получение всех ограничений на перемещение для папки.

FolderRename
Restrictions

 

GetFolder
Rename
Restrictions

Получение всех ограничений на переименование папки.

FolderRoot

 

GetFolderRoot

Получение корневой папки хранилища.

Move

Folder

 

MoveFolder

Перемещение папки из одного расположения под другую родительскую папку.

Update

FolderName

 

UpdateFolder
Name

Задает, либо изменяет имя папки.

Folder
UNCPath

 

UpdateFolder
UNCPath

Задает, либо изменяет UNC путь папки.

Document
Service
Extensions

Add

Folder
WithCategory

 

AddFolder
WithCategory

Создает новую папку и назначает ей категорию.

Реализации класса Folder

Стоит обратить особое внимание на то, что существует два класса Folder:

Folder (Autodesk.Connectivitiy.WebServices)

Базовый класс, состоит из следующих членов:

Полное имя

Описание

Cat

Категория папки.

Cloaked

Если значение ИСТИНА, вошедшего в систему пользователь не имеет права к просмотру папки. Единственные доступные данные о скрытой папке — это ID. Все остальные данные будет NULL или 0.

CreateDate

Дата и время создания папки.

CreateUserId

Идентификатор создавшего папку пользователя.

CreateUserName

Имя пользователя, который создал папку. Имя создавшего папку пользователя.

FullName

Полный путь в хранилище (например, «$ / Folder1»).

FullUncName

Полный путь UNC или NULL, если UNC путь не существует.

Id

Уникальный идентификатор папки.

IsLib

Отметка о том, является ли папка библиотечной.

LfCyc

Состояние жизненного цикла.

Locked

Отметка о том, может ли папка быть изменена вошедшим в систему пользователем.

Name

Имя папки (например, «Folder1»).

NumClds

Количество дочерних папок.

ParId

Идентификатор родительской папки. Значение —1 означает, что папка не имеет родителя.

Folder (Autodesk.DataManagement.Client.Framework.Vault.Currency.Entities)

Расширитель объекта Web Services Folder, который предоставляет различного рода улучшения при работе с объектами.

Имя

Описание

Category

Получает категорию, присвоенную этой папке. Это может быть пустым, так как не все продукты поддерживают категории.

CreateDate

Получает дату и время, что создания папки.

CreateUserId

Получает идентификатор пользователя, создавшего папку.

CreateUserName

Получает имя пользователя, который создал эту папку.

EntityClass

Получает класс сущностей, связанных с этой папкой.

EntityIterationId

Получает ID итерации этой папки. Поскольку папки не основаны на итерациях, это значение всегда будет равно EntityMasterId.

EntityMasterId

Получает главный Id этой папки. Папки не основаны на итерациях и MasterID всегда является единственным уникальным идентификатором для папки.

EntityName

Получает описательное имя для этой папки. Это всегда имя папки без полного пути.

FolderPath

Получает путь расположения этой папки. Если эта папка $/Folder1/Folder2, то путь будет $/Folder1 . В случае, когда эта папка является корневой ($), возвращается пустая строка.

FullName

Получает полный путь к хранилищу для этой папки (т.е.. «$ / Folder1»)

FullUncName

Получает полный UNC путь для этой папки, или нуль, если UNC путь не существует.

Id

Возвращает уникальный идентификатор для этой папки

IsCloaked

Проверяет, является ли папка скрытой. Скрытым является тот объект, который пользователь не имеет прав просматривать. Единственные возможные данные скрытой папки — это EntityMasterId. Все остальные данные будет NULL или 0.

IsLibraryFolder

Отметка о том, является ли папка библиотечной.

IsVaultRoot

Проверяет, является ли эта папка корневой папкой хранилища.

LinkInfo

Проверяет, является ли это ссылку на папку. Если значение не является NULL, то LinkInfo предоставляет информацию о ссылке на эту папку.

Locked

Проверяет, может ли эта папка может быть изменена вошедшим в систему пользователем.

NumberOfChildren

Получает число непосредственных дочерних папок.

Parent

Получает или задает родительскую папку. Важно отметить, что значение может быть нулевым. Папка всегда имеет родительский ID но полномасштабной объект не может быть загружен.

ParentId

Получает идентификатор родителя этой папки. Значение —1 означает, что эта папка не имеет родителя.

Преобразование типов Folder

Для преобразования из одного типа в другой используются следующие инструменты:

  • public Folder(Connection vltConn, Folder webServiceFolder)
  • public Folder operator implicit( Folder folder)

Преобразование типов File
Автор: Дмитрий Емельянов
Автор перевода: Дмитрий Емельянов

Обсуждение: http://adn-cis.org/forum/index.php?topic=903.0

Опубликовано 11.08.2014
Отредактировано 11.08.2014 в 17:18:55