com.clusterra.pmbok.document.application.template

Interface TemplateService

All Known Implementing Classes:

TemplateServiceImpl

public interface TemplateService

Method Summary

Modifier and Type	Method and Description
SectionTemplate	addHistorySection(TemplateId templateId, java.lang.String name)
SectionTemplate	addReferenceSection(TemplateId templateId, java.lang.String name)
SectionTemplate	addTermSection(TemplateId templateId, java.lang.String name)
SectionTemplate	addTextSection(TemplateId templateId, java.lang.String name)
SectionTemplate	addTitleSection(TemplateId templateId, java.lang.String name)
SectionTemplate	addTocSection(TemplateId templateId, java.lang.String name)
Template	createTemplate(java.lang.Integer majorVersion, java.lang.Integer minorVersion, java.lang.String name)
void	deleteTemplate(TemplateId templateId)
java.util.List<Template>	findAllTemplates()
org.springframework.data.domain.Page<Template>	findBy(org.springframework.data.domain.Pageable pageable, java.lang.String searchBy)
Template	findBy(TemplateId templateId)
SectionTemplate	findSectionTemplateBy(SectionTemplateId sectionTemplateId)
java.util.List<SectionTemplate>	findSectionTemplates(TemplateId templateId)
java.util.Set<SectionType>	findSectionTypesUsedBy(TemplateId templateId)
void	removeSection(TemplateId templateId, SectionTemplateId sectionTemplateId)
SectionTemplate	updateSectionName(TemplateId templateId, SectionTemplateId sectionTemplateId, java.lang.String name)
SectionTemplate	updateSectionOrder(TemplateId templateId, SectionTemplateId sectionTemplateId, java.lang.Integer orderIndex)
Template	updateTemplateName(TemplateId templateId, java.lang.String name)

Method Detail

createTemplate

Template createTemplate(java.lang.Integer majorVersion,
                        java.lang.Integer minorVersion,
                        java.lang.String name)
                 throws com.clusterra.iam.core.application.tracker.NotAuthenticatedException,
                        TemplateAlreadyExistsException

Throws:

com.clusterra.iam.core.application.tracker.NotAuthenticatedException

TemplateAlreadyExistsException

updateTemplateName

Template updateTemplateName(TemplateId templateId,
                            java.lang.String name)
                     throws TemplateNotFoundException

Throws:

TemplateNotFoundException

deleteTemplate

void deleteTemplate(TemplateId templateId)
             throws TemplateNotFoundException

Throws:

TemplateNotFoundException

addHistorySection

SectionTemplate addHistorySection(TemplateId templateId,
                                  java.lang.String name)
                           throws TemplateNotFoundException,
                                  SectionTemplateAlreadyExistsException

Throws:

TemplateNotFoundException

SectionTemplateAlreadyExistsException

addReferenceSection

SectionTemplate addReferenceSection(TemplateId templateId,
                                    java.lang.String name)
                             throws TemplateNotFoundException,
                                    SectionTemplateAlreadyExistsException

Throws:

TemplateNotFoundException

SectionTemplateAlreadyExistsException

addTermSection

SectionTemplate addTermSection(TemplateId templateId,
                               java.lang.String name)
                        throws TemplateNotFoundException,
                               SectionTemplateAlreadyExistsException

Throws:

TemplateNotFoundException

SectionTemplateAlreadyExistsException

addTextSection

SectionTemplate addTextSection(TemplateId templateId,
                               java.lang.String name)
                        throws TemplateNotFoundException

Throws:

TemplateNotFoundException

addTitleSection

SectionTemplate addTitleSection(TemplateId templateId,
                                java.lang.String name)
                         throws TemplateNotFoundException

Throws:

TemplateNotFoundException

addTocSection

SectionTemplate addTocSection(TemplateId templateId,
                              java.lang.String name)
                       throws TemplateNotFoundException

Throws:

TemplateNotFoundException

removeSection

void removeSection(TemplateId templateId,
                   SectionTemplateId sectionTemplateId)
            throws TemplateNotFoundException,
                   SectionTemplateNotFoundException

Throws:

TemplateNotFoundException

SectionTemplateNotFoundException

updateSectionOrder

SectionTemplate updateSectionOrder(TemplateId templateId,
                                   SectionTemplateId sectionTemplateId,
                                   java.lang.Integer orderIndex)
                            throws SectionTemplateNotFoundException,
                                   TemplateNotFoundException

Throws:

SectionTemplateNotFoundException

TemplateNotFoundException

updateSectionName

SectionTemplate updateSectionName(TemplateId templateId,
                                  SectionTemplateId sectionTemplateId,
                                  java.lang.String name)
                           throws SectionTemplateNotFoundException,
                                  TemplateNotFoundException

Throws:

SectionTemplateNotFoundException

TemplateNotFoundException

findAllTemplates

java.util.List<Template> findAllTemplates()
                                   throws com.clusterra.iam.core.application.tracker.NotAuthenticatedException

Throws:

com.clusterra.iam.core.application.tracker.NotAuthenticatedException

findBy

org.springframework.data.domain.Page<Template> findBy(org.springframework.data.domain.Pageable pageable,
                                                      java.lang.String searchBy)
                                               throws com.clusterra.iam.core.application.tracker.NotAuthenticatedException

Throws:

com.clusterra.iam.core.application.tracker.NotAuthenticatedException

findSectionTemplates

java.util.List<SectionTemplate> findSectionTemplates(TemplateId templateId)
                                              throws TemplateNotFoundException

Throws:

TemplateNotFoundException

findSectionTemplateBy

SectionTemplate findSectionTemplateBy(SectionTemplateId sectionTemplateId)
                               throws SectionTemplateNotFoundException

Throws:

SectionTemplateNotFoundException

findSectionTypesUsedBy

java.util.Set<SectionType> findSectionTypesUsedBy(TemplateId templateId)
                                           throws TemplateNotFoundException

Throws:

TemplateNotFoundException

findBy

Template findBy(TemplateId templateId)
         throws TemplateNotFoundException

Throws:

TemplateNotFoundException