Файл: Компьютерная система управления документооборотом предприятия Черниговгазмонтаж.doc

ВУЗ: Не указан

Категория: Не указан

Дисциплина: Не указана

Добавлен: 19.03.2024

Просмотров: 210

Скачиваний: 0

ВНИМАНИЕ! Если данный файл нарушает Ваши авторские права, то обязательно сообщите нам.
    1. 1   ...   10   11   12   13   14   15   16   17   ...   20

Диаграмма пакетов


В данном подразделе показан результат объедение классов в пакеты. В таблице 3.9 представлено описание назначений пакетов.

Таблица 3.9 – Описание назначений пакетов «document»

Название пакета

Описание

document.config

Данный пакет содержит классы для работы с LDAP сервером и класс сообщений для LogFactory

document.domain

Данный пакет содержит классы сущностей и вспомогательные классы

document.service

Данный пакет содержит интерфейсы с описанием методов, которые необходимы для работы с БД

document.service.Impl

Данный пакет содержит классы, которые реализую интерфейсы пакета document.service

document.web.beans

Данный пакет содержит классы, которые используются на web-страницах(JSF-технология)

test.document

Данный пакет содержит классы, для проведения тестов системы с использованием jUnit 4

На рисунке 3.1 представлена диаграмма пакетов ИКС управления документооборотом предприятия «Черниговгазмонтаж».



Рисунок 3.1 – Диаграмма пакетов системы

    1. Протоколы классов


В данном подразделе содержится протоколы классов, сгруппированных по пакетам. В таблице 3.15 представлены протоколы классов пакета document.config

Таблица 3.10 – Протоколы классов пакета document.config

Название класса

Название метода или поля

Описание

MailSender

sendMail(User user)

Метод, для отправления письма определённому пользователю

MailThread

smtpServer

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

MailThread

to

Поле для указания получателя

MailThread

from

Поле для указания отправителя

MailThread

subject

Поле для указания темы письма

MailThread

login

Поле для указания логина от почты

MailThread

passwd

Поле для указания пароля от почты

MailThread

user

Поле текущего пользователя

MailThread

run()

Метод для отправки письма в потоке

MailThread

getSmtpServer()

Метод для получения поля smtpServer

MailThread

setPasswd(String passwd)

Метод для установки поля passwd

ServiceLDAP

ServiceLDAP()

Конструктор класса, в котором выполняется подключение к LDAP

ServiceLDAP

addUser(fields)

Метод, который добавляет пользователя в БД LDAP

ServiceLDAP

assignUser(fields)

Метод, который добавляет пользователя в группу с ролями

ServiceLDAP

getInitialContext

(fields)

Метод для подключения к LDAP

ServiceLDAP

deleteUser(String username)

Метод, который удаляет пользователя из БД LDAP

ServiceLDAP

removeUser(String username, String groupName)

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


В таблице 3.11 представлены протоколы классов пакета document.domain

Таблица 3.11 – Протоколы классов пакета document.domain

Название класса

Название метода или поля

Описание

DomainObject

id

Поле уникального идентификатора

DomainObject

defLocale

Поле локализации

DomainObject

DomainObject()

Конструктор класса

DomainObject

DomainObject(Long id)

Конструктор класса с указанием id

DomainObject

copyFieldsValuesFrom

(DomainObject obj)

Метод для копирования полей другого объекта

DomainObject

hashCode()

Метод формирования hesh-кода объекта

DomainObject

equals(Object obj)

Метод для сравнения с объектом

DomainObject

toString()

Метод для преобразования объекта в тип String

Document

id_document

Поле уникального идентификатора документа

Document

name

Поле названия документа

Document

Document ()

Конструктор класса без параметров

Document

Document (fields)

Конструктор класса с полями для инициализации

Document

creationdata

Поле даты создания документа

Document

owner

Поле создателя документа

Document

description

Поле описания документа

Document

Document ()

Конструктор класса без параметров

Document

Document (fields)

Конструктор класса с полями для инициализации

Document

userClient

Поле с указанием клиента

DocumentServices

DocumentServices()

Конструктор класса без параметров

DocumentServices

DocumentServices

(fields)

Конструктор класса с полями для инициализации

Template

id_template

Поле уникального идентификатора шаблона

Template

name

Поле с название шаблона

Template

description

Описание шаблона

Template

сreator

Пользователь – создатель шаблона

Template

creationdata

Поле даты создания шаблона

Template

Template ()

Конструктор класса без параметров

Template

Template (fields)

Конструктор класса с полями для инициализации

Documenttype

id_doctype

Поле уникального идентификатора

Documenttype

name

Поле с названием документа

Documenttype

doctype

Поле с типом документа

Documenttype

user

Поле с указанием пользователя

Documenttype

Documenttype ()

Конструктор класса без параметров

Documenttype

Documenttype (fields)

Конструктор класса с полями для инициализации

Library

id_library

Поле уникального идентификатора библиотеки

Library

name

Поле с названием библиотеки

Library

creationdata

Поле даты создания библиотеки

Library

owner

Поле создателя библиотеки

Library

description

Поле описания библиотеки

Library

Library ()

Конструктор класса без параметров

Library

Library (fields)

Конструктор класса с полями для инициализации

Folders

id_folders

Поле уникального идентификатора каталога

Folders

name

Поле с название каталога

Folders

creationdata

Поле даты создания каталога

Folders

owner

Поле создателя каталога

Folders

description

Поле описания каталога

Folders

Folders

Конструктор класса без параметров

Folders

Folders(fields)

Конструктор класса с полями для инициализации

Role

id_role

Поле уникального идентификатора роли

Role

rolename

Поле с названием роли

Role

user

Поле с указанием пользователя

Role

Role()

Конструктор класса без параметров

Role

Role (fields)

Конструктор класса с полями для инициализации

Version

id_version

Поле уникального идентификатора версии документа

Version

name

Поле с именем версии

Version

Version ()

Конструктор класса без параметров

Version

Version (fields)

Конструктор класса с полями для инициализации

User

id_user

Поле уникального идентификатора пользователя

User

login

Поле с логином

User

passwd

Поле с паролем

User

info

Поле с профилем

User

role

Поле с ролью пользователя

User

User()

Конструктор класса без параметров

User

User(fields)

Конструктор класса с полями для инициализации


В таблице 3.12 представлены протоколы классов пакета document.service

Таблица 3.12 – Протоколы классов пакета document.service

Название класса

Название метода или поля

Описание

IUserService

findUser (String fio)

Описание метода поиска пользователя по его логину

IUserService

listUsers ()

Описание метода получения списка всех пользователей

IUserService

registerUser (Integer id_user)

Описание метода регистрации пользователя в системе

IUserService

removeUser (Integer id_user)

Описание метода удаления пользователя из системы

ILibraryService

newLibrary (Integer id_library, String name)

Описание метода создания библиотеки

ILibraryService

removeLibrary (Integer id_library)

Описание метода удаления библиотеки

ILibraryService

listFolders (Integer id_library)

Описание метода получения списка каталогов

ILibraryService

addFolder (Integer id_library, String name)

Описание метода для добавления каталога

ILibraryService

removeFolder (Integer id_library, String name)

Описание метода для удаления каталога

ILibraryService

addUser (Integer id_library, Integer id_user)

Описание метода добавления пользователя в список пользователей библиотеки

ILibraryService

removeUser (Integer id_library, Integer id_user)

Описание метода для удаления пользователя из списка пользователей библиотеки

ILibraryService

listUsers(Integer id_library, Integer id_user)

Описание метода для получения всех пользователей библиотеки

ILibraryService

getLibraryAttribute (Integer id_library)

Описание метода для получения атрибута библиотеки

ILibraryService

setLibraryAttribute(Integer id_library)

Описание метода установления атрибутов библиотеки

IFolderService

newFolder(Integer id_user, String name)

Описание метода установления атрибутов библиотеки

IFolderService

removeFolder(Integer id_folder)

Описание метода установления атрибутов библиотеки

IFolderService

getFolderAttribute (Integer id_folder)

Описание метода установления атрибутов библиотеки

IDocumentService

findDocuments(Integer id_document)

Описание метода поиска документа

IDocumentService

newDocuments (Integer id_user, String name)

Описание метода создания документа

IDocumentService

retrieveLastDocumentsVersion (Integer id_document)

Описание метода для получения последней версии документа

IDocumentService

retrieveDocumentsVersion(Integer id_document)

Описание метода для получения указанной версии документа

IDocumentService

getDocumentsTemplateId (Integer id_document)

Описание метода получения шаблона документа

IDocumentService

listDocumentsVersions (Integer id_document)

Описание метода для получения списка версий

IDocumentService

createNewVersion (Integer id_document)

Описание метода для создания новой версии документа

IGenericService

delEntity(id)

Описание метода удаления объекта по id

IGenericService

delEntity(entity)

Описание метода удаления объекта c БД

IGenericService

delAllEntities()

Описание метода удаления коллекции объектов

IGenericService

getEntityById()

Описание метода получения объекта по id

IGenericService

getAllEntites()

Описание метода получения всех объектов

IGenericService

getAllEntitiesCount()

Описание метода получения количества объектов

IGenericService

getEntitiesByIds()

Описание метода получения объектов по нескольким id

IGenericService

save(entity)

Описание метода сохранения объекта в БД


В таблице 3.13 представлены протоколы классов пакета document.service.Impl

Таблица 3.13 – Протоколы классов пакета document.service.Impl

Название класса

Название метода или поля

Описание

UserService

findUser (String fio)

Метод поиска пользователя по его логину

UserService

listUsers ()

Метод получения списка всех пользователей

UserService

registerUser (Integer id_user)

Метод регистрации пользователя в системе

UserService

removeUser (Integer id_user)

Метод удаления пользователя из системы

LibraryService

newLibrary (Integer id_library, String name)

Метод создания библиотеки

LibraryService

removeLibrary (Integer id_library)

Метод удаления библиотеки

LibraryService

listFolders (Integer id_library)

Метод получения списка каталогов

LibraryService

addFolder (Integer id_library, String name)

Метод для добавления каталога

LibraryService

removeFolder (Integer id_library, String name)

Метод для удаления каталога

LibraryService

addUser (Integer id_library, Integer id_user)

Метод добавления пользователя в список пользователей библиотеки

LibraryService

removeUser (Integer id_library, Integer id_user)

Метод для удаления пользователя из списка пользователей библиотеки

LibraryService

listUsers(Integer id_library, Integer id_user)

Метод для получения всех пользователей библиотеки

LibraryService

getLibraryAttribute (Integer id_library)

Метод для получения атрибута библиотеки

LibraryService

setLibraryAttribute(Integer id_library)

Метод установления атрибутов библиотеки

FolderService

newFolder(Integer id_folder, String name)

Метод создания нового каталога

FolderService

removeFolder(Integer id_folder)

Метод удаления каталога

FolderService

getFolderAttribute (Integer id_folder)

Метод получения атрибутов каталога

DocumentService

findDocuments(Integer id_document)

Метод поиска документа

DocumentService

newDocuments (Integer id_document, String name)

Метод создания документа

DocumentService

retrieveLastDocumentsVersion (Integer id_document)

Метод для получения последней версии документа

DocumentService

retrieveDocumentsVersion(Integer id_document)

Метод для получения указанной версии документа

DocumentService

getDocumentsTemplateId (Integer id_document)

Метод получения шаблона документа

DocumentService

listDocumentsVersions (Integer id_document)

Метод для получения списка версий

DocumentService

createNewVersion (Integer id_document)

Метод для создания новой версии документа

GenericService

delEntity(id_document)

Метод удаления объекта по id

GenericService

delEntity(entity)

Метод удаления объекта c БД

GenericService

delAllEntities()

Метод удаления коллекции объектов

GenericService

getEntityById()

Метод получения объекта по id

GenericService

getAllEntites()

Метод получения всех объектов

GenericService

getAllEntitiesCount()

Метод получения количества объектов

GenericService

getEntitiesByIds()

Метод получения объектов по нескольким id

GenericService

save(entity)

Метод сохранения объекта в БД