com.trackstudio.kernel.manager
Class AttachmentManager

java.lang.Object
  extended by com.trackstudio.kernel.manager.KernelManager
      extended by com.trackstudio.kernel.manager.AttachmentManager

public class AttachmentManager
extends KernelManager

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


Field Summary
protected static java.lang.String className
           
protected static java.lang.String END_SIGN
           
protected static AttachmentManager instance
           
protected static org.apache.commons.logging.Log log
           
 
Fields inherited from class com.trackstudio.kernel.manager.KernelManager
hu
 
Constructor Summary
protected AttachmentManager()
          Конструктор по умолчанию
 
Method Summary
 java.util.ArrayList<java.lang.String> createAttachment(java.lang.String taskId, java.lang.String messageId, java.lang.String userId, java.util.List<AttachmentArray> attachments)
          Создает приложенные файлы для входных ID задачи, пользователя или сообщения и списка объектов AttachmentArray.
После этого производится обновление индекса приложенных файлов
 void deleteAttachment(java.lang.String attachmentId)
          Удаляет приложенный файл с указанным ID и производится обновление индекса
 void deleteAttachment(java.lang.String attachmentId, boolean reIndex)
          Удаляет приложенный файл с указанным ID и при необходимости производится обновление индекса
 java.util.List<AttachmentCacheItem> getAllAttachmentList()
          Возвращает все прилоежнные файлы
 byte[] getAttachment(java.lang.String taskId, java.lang.String userId, java.lang.String attId)
          Возвращает байтовый массив приложенного файла для указанной задачи
static java.lang.String getAttachmentDirPath(java.lang.String taskId, java.lang.String userId)
          Принимает на вход ID задачи или ID пользователя, для которых создается приложенный файл и возвращает путь до директории в которой может быть создан файл с учетом Upload-директории и специфики построения путей в TrackStudio
static java.io.File getAttachmentFile(java.lang.String taskId, java.lang.String userId, java.lang.String attId)
          Принимает на вход ID задачи или ID пользователя для которых создается приложенный файл и и имя прикладываемого файла и возвращает путь по которому может быть создан файл с учетом Upload-директории и специфики построения путей в TrackStudio
 java.lang.Boolean getAttachmentIsDeleted(java.lang.String attachmentId)
          Определяет присутствует файл на диске или удален
 java.util.List<AttachmentCacheItem> getAttachmentList(java.lang.String taskId, java.lang.String messageId, java.lang.String userId)
          Возвращает прилоежнные файлы для задачи, сообщения или пользователя
static AttachmentManager getInstance()
          Возвращает экземпляр текущего класса
static java.lang.String removeLocaleCharacters(java.lang.String str, boolean name)
          ПРинимает на вход строку, проверяет ее на наличие символов, которые могут быть некорректно опознаными различными файловыми системами, и заменяет их на симлов '-'
 void updateAttachment(java.lang.String attachmentId, SafeString name, SafeString description)
          Производится редактирование приложенного файла с attachmentId После этого производится обновление индекса приложенных файлов
 void updateFileAttachment(java.lang.String taskId, java.lang.String userId, java.lang.String attachId, AttachmentArray atta)
          Обновляет содержимое файла.
 
Methods inherited from class com.trackstudio.kernel.manager.KernelManager
getAcl, getAttachment, getBookmark, getCategory, getFilter, getFind, getIndex, getLicense, getLongText, getMailImport, getMessage, getPlugin, getPrstatus, getRegistration, getReport, getStep, getTask, getTemplate, getTSInfo, getUdf, getUser, getWorkflow
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static org.apache.commons.logging.Log log

className

protected static java.lang.String className

instance

protected static AttachmentManager instance

END_SIGN

protected static final java.lang.String END_SIGN
See Also:
Constant Field Values
Constructor Detail

AttachmentManager

protected AttachmentManager()
Конструктор по умолчанию

Method Detail

getInstance

public static AttachmentManager getInstance()
Возвращает экземпляр текущего класса

Returns:
Экземпляр AttachmentManager

removeLocaleCharacters

public static java.lang.String removeLocaleCharacters(java.lang.String str,
                                                      boolean name)
ПРинимает на вход строку, проверяет ее на наличие символов, которые могут быть некорректно опознаными различными файловыми системами, и заменяет их на симлов '-'

Parameters:
str - Входная строка
name - Проверяет валидность имени файла для WebDav не должен сожержать спец символы
Returns:
новая строка, содержащая только корректные для всех файловых систем символы

getAttachmentDirPath

public static java.lang.String getAttachmentDirPath(java.lang.String taskId,
                                                    java.lang.String userId)
Принимает на вход ID задачи или ID пользователя, для которых создается приложенный файл и возвращает путь до директории в которой может быть создан файл с учетом Upload-директории и специфики построения путей в TrackStudio

Parameters:
taskId - ID задачи
userId - ID пользователя
Returns:
возвращает путь до директории в которой может быть создан файл

getAttachmentFile

public static java.io.File getAttachmentFile(java.lang.String taskId,
                                             java.lang.String userId,
                                             java.lang.String attId)
Принимает на вход ID задачи или ID пользователя для которых создается приложенный файл и и имя прикладываемого файла и возвращает путь по которому может быть создан файл с учетом Upload-директории и специфики построения путей в TrackStudio

Parameters:
taskId - ID задачи
userId - ID пользователя
attId - ID аттачмента
Returns:
путь по которому может быть создан файл

createAttachment

public java.util.ArrayList<java.lang.String> createAttachment(java.lang.String taskId,
                                                              java.lang.String messageId,
                                                              java.lang.String userId,
                                                              java.util.List<AttachmentArray> attachments)
                                                       throws GranException
Создает приложенные файлы для входных ID задачи, пользователя или сообщения и списка объектов AttachmentArray.
После этого производится обновление индекса приложенных файлов

Parameters:
taskId - ID задачи
messageId - ID сообщения
userId - ID пользователя
attachments - Список AttachmentArray
Returns:
возвращает список ID приложенных файлов
Throws:
GranException - при необходимости
See Also:
AttachmentArray, Attachment

updateFileAttachment

public void updateFileAttachment(java.lang.String taskId,
                                 java.lang.String userId,
                                 java.lang.String attachId,
                                 AttachmentArray atta)
                          throws GranException
Обновляет содержимое файла. то есть полностью его перезаписывает.

Parameters:
taskId - task id
userId - user id
attachId - id file
atta - data file
Throws:
GranException - for need

updateAttachment

public void updateAttachment(java.lang.String attachmentId,
                             SafeString name,
                             SafeString description)
                      throws GranException
Производится редактирование приложенного файла с attachmentId После этого производится обновление индекса приложенных файлов

Parameters:
attachmentId - ID прилоежнного файла
name - Имя приложенного файла
description - Описание приложенного файла
Throws:
GranException - при необходимости
See Also:
Attachment, SafeString

getAttachment

public byte[] getAttachment(java.lang.String taskId,
                            java.lang.String userId,
                            java.lang.String attId)
                     throws GranException
Возвращает байтовый массив приложенного файла для указанной задачи

Parameters:
taskId - ID задачи
attId - id приложения
Returns:
возвращает содержимое файла в байтовом массиве
Throws:
GranException - при необходимости

deleteAttachment

public void deleteAttachment(java.lang.String attachmentId)
                      throws GranException
Удаляет приложенный файл с указанным ID и производится обновление индекса

Parameters:
attachmentId - ID файла
Throws:
GranException - при необходимости

deleteAttachment

public void deleteAttachment(java.lang.String attachmentId,
                             boolean reIndex)
                      throws GranException
Удаляет приложенный файл с указанным ID и при необходимости производится обновление индекса

Parameters:
attachmentId - ID файла
reIndex - нужно ли обновлять индекс
Throws:
GranException - при необходимости

getAllAttachmentList

public java.util.List<AttachmentCacheItem> getAllAttachmentList()
                                                         throws GranException
Возвращает все прилоежнные файлы

Returns:
Список всех приложенных файлов
Throws:
GranException - при необходимости
See Also:
AttachmentCacheItem

getAttachmentList

public java.util.List<AttachmentCacheItem> getAttachmentList(java.lang.String taskId,
                                                             java.lang.String messageId,
                                                             java.lang.String userId)
                                                      throws GranException
Возвращает прилоежнные файлы для задачи, сообщения или пользователя

Parameters:
taskId - ID задачи
messageId - ID сообщения
userId - ID пользователя
Returns:
Список прилоежнных файлов для задачи, сообщения или пользователя
Throws:
GranException - при необходимости
See Also:
AttachmentCacheItem

getAttachmentIsDeleted

public java.lang.Boolean getAttachmentIsDeleted(java.lang.String attachmentId)
                                         throws GranException
Определяет присутствует файл на диске или удален

Parameters:
attachmentId - ID файла
Returns:
Возвращает FALSE, если прилоежнный файл присутствует на диске и TRUE, если файл удален
Throws:
GranException - при необходимости


Copyright © 2002-2009 TrackStudio, Ltd. All Rights Reserved.