lumis.content.documentation.generator

Class ContentServiceInterfaceDocumentationGenerator

java.lang.Object

lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

lumis.doui.documentation.generator.DouiServiceInterfaceDocumentationGenerator

lumis.content.documentation.generator.ContentServiceInterfaceDocumentationGenerator

All Implemented Interfaces:

IServiceInterfaceDocumentationGenerator

public class ContentServiceInterfaceDocumentationGenerator
extends DouiServiceInterfaceDocumentationGenerator

Since:

9.0.0

Version:

$Revision: 19135 $ $Date: 2016-06-02 21:12:21 +0000 (Thu, 02 Jun 2016) $

Nested Class Summary

Nested classes/interfaces inherited from class lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage

Field Summary

Fields inherited from class lumis.doui.documentation.generator.DouiServiceInterfaceDocumentationGenerator

appendToUrl, imageDescription, imageName, lastServiceInterfaceInstanceId, lastSIImage, referencedProcessActions, renderedFirstImage, xmlDoc, xPath

Fields inherited from class lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

docResource, reGenerateImages, serviceInterfaceImages

Constructor Summary

Constructors

Constructor and Description
ContentServiceInterfaceDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	documentationSetTemplateSectionFields(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, Node sourceNode, IDocumentationTemplate.DocumentationSection dataSection)
protected String	getDefaultServiceInterfaceDetailedDescription(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	getImageUrl(String filePath, ServiceInterfaceConfig serviceInterfaceConfig, String serviceInstanceId, Locale locale, IDocumentationTemplate template)

Methods inherited from class lumis.doui.documentation.generator.DouiServiceInterfaceDocumentationGenerator

addServiceImageToTemplate, createNewServiceInterfaceImageEntry, documentationSetTemplateSectionField, documentationSetTemplateSections, generateControlsDocumentation, generateDocumentationImagesForServiceInterface, generateImage, generateLinksDocumentation, getDouiServiceInterfaceInstanceDefinition, getLinksDocumentationSection, parseLocalizedString

Methods inherited from class lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

addServiceInstance, addToServiceInterfaceImages, documentationGetServiceInterfaceDescription, documentationGetServiceInterfaceName, documentationGetServiceInterfaceSummary, generateDocumentationForServiceInterface, generateDocumentationImageForServiceInterface

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentServiceInterfaceDocumentationGenerator

public ContentServiceInterfaceDocumentationGenerator()

Method Detail

documentationSetTemplateSectionFields

protected void documentationSetTemplateSectionFields(ServiceInterfaceConfig serviceInterfaceConfig,
                                                     IResource resource,
                                                     Locale locale,
                                                     Node sourceNode,
                                                     IDocumentationTemplate.DocumentationSection dataSection)
                                              throws PortalException

Overrides:

documentationSetTemplateSectionFields in class DouiServiceInterfaceDocumentationGenerator

Throws:

PortalException

getImageUrl

protected String getImageUrl(String filePath,
                             ServiceInterfaceConfig serviceInterfaceConfig,
                             String serviceInstanceId,
                             Locale locale,
                             IDocumentationTemplate template)
                      throws PortalException

Overrides:

getImageUrl in class DouiServiceInterfaceDocumentationGenerator

Throws:

PortalException

getDefaultServiceInterfaceDetailedDescription

protected String getDefaultServiceInterfaceDetailedDescription(ServiceInterfaceConfig serviceInterfaceConfig,
                                                               IResource resource,
                                                               Locale locale,
                                                               IDocumentationTemplate template)
                                                        throws ManagerException,
                                                               PortalException

Overrides:

getDefaultServiceInterfaceDetailedDescription in class GenericServiceInterfaceDocumentationGenerator

Throws:

ManagerException

PortalException