lumis.portal.documentation

Interface IDocumentationTemplate

All Known Implementing Classes:

StandardDocumentationTemplate

public interface IDocumentationTemplate

Responsible for applying style and generating the documentation artifacts based on the documentation information passed to it.

Since:

9.0.0

Version:

$Revision: 19136 $ $Date: 2016-06-02 21:14:45 +0000 (Thu, 02 Jun 2016) $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDocumentationTemplate.DocumentationSection Identifies a block of documentation.
static class	IDocumentationTemplate.DocumentationSectionEntry A documentation section entry.

Method Summary

Modifier and Type	Method and Description
IDocumentationTemplate.DocumentationSection	addDocumentationSection(String sectionId, boolean isServiceSection, Map<String,String> properties) Adds a new section to the documentation.
void	addServiceImage(String filePath, String legend) Used to notify the template that the given image should be viewed in the list of images of the service.
void	copyStaticFiles(String rootPath) copies static files from the given path to the destination documentation directory.
boolean	doesFileExist(String filePath) Returns true if the file exists in the documentation directory.
void	endServiceAndInterfacesDocumentation(String serviceId) Identifies that service and interface documentation generation is complete.
void	endServiceDocumentation(String serviceId) Notifies the template that documentation of a new service ended.
void	endServiceInterfaceDocumentation(String serviceInterfaceId) Notifies that the documentation generation of service interface is complete.
void	endServiceInterfacesDocumentation(String serviceId) Notifies the template that documentation of service interfaces has ended.
IDocumentationTemplate.DocumentationSection	getDocumentationSection(String sectionId, boolean isServiceSection)
void	saveFile(InputStream stream, String filePath) Notifies the template that a new file was generated and should be saved in the given path within the documentation directory.
void	setServiceDetailedDescription(String serviceDetailedDescription) HTML description of the service.
void	setServiceImage(String serviceImage) Notifies the path to the service image and may be used for rendering documentation.
void	setServiceInterfaceDetailedDescription(String documentationGetServiceDetailedDescription) Detailed description is assumed to be HTML format.
void	setServiceInterfaceName(String documentationGetServiceInterfaceName)
void	setServiceInterfaceSummary(String documentationGetServiceInterfaceSummary) Summary is assumed to be simple text and not HTML.
void	setServiceName(String serviceName) Identifies the service name that may be used for generation.
void	setServiceSummary(String serviceSummary) Specifies the service summary to be displayed appropriately.
void	startServiceAndInterfacesDocumentation(String serviceId) Notifies the template that documentation of a new service and its interfaces has started.
void	startServiceDocumentation(String serviceId) Notifies the template that documentation of a new service started.
void	startServiceInterfaceDocumentation(String serviceInterfaceId) Notifies that the documentation generation of service interface is starting.
void	startServiceInterfacesDocumentation(String serviceId) Notifies the template that documentation of service interfaces has started.

Method Detail

copyStaticFiles

void copyStaticFiles(String rootPath)
              throws PortalException

copies static files from the given path to the destination documentation directory.

Parameters:

rootPath - origin path.

Throws:

PortalException

Since:

9.0.0

startServiceAndInterfacesDocumentation

void startServiceAndInterfacesDocumentation(String serviceId)
                                     throws PortalException

Notifies the template that documentation of a new service and its interfaces has started. This method may be used for initialization purposes.

Parameters:

serviceId -

Throws:

PortalException

Since:

9.0.0

startServiceDocumentation

void startServiceDocumentation(String serviceId)
                        throws PortalException

Notifies the template that documentation of a new service started. This method may be used for initialization purposes.

Parameters:

serviceId -

transaction -

Throws:

PortalException

Since:

9.0.0

endServiceDocumentation

void endServiceDocumentation(String serviceId)
                      throws PortalException

Notifies the template that documentation of a new service ended. The interfaces however have not yet been documented.

Parameters:

serviceId -

transaction -

Throws:

PortalException

Since:

9.0.0

setServiceName

void setServiceName(String serviceName)
             throws PortalException

Identifies the service name that may be used for generation.

Parameters:

serviceName -

Throws:

PortalException

Since:

9.0.0

setServiceSummary

void setServiceSummary(String serviceSummary)
                throws PortalException

Specifies the service summary to be displayed appropriately. Summary is assumed to be text and not HTML.

Parameters:

serviceSummary -

Throws:

PortalException

Since:

9.0.0

setServiceDetailedDescription

void setServiceDetailedDescription(String serviceDetailedDescription)
                            throws PortalException

HTML description of the service.

Parameters:

serviceDetailedDescription -

Throws:

PortalException

Since:

9.0.0

startServiceInterfacesDocumentation

void startServiceInterfacesDocumentation(String serviceId)
                                  throws PortalException

Notifies the template that documentation of service interfaces has started. This method may be used for initialization purposes.

Parameters:

serviceId -

transaction -

Throws:

PortalException

Since:

9.0.0

endServiceInterfacesDocumentation

void endServiceInterfacesDocumentation(String serviceId)
                                throws PortalException

Notifies the template that documentation of service interfaces has ended. May use this method for cleanup purposes.

Parameters:

serviceId -

transaction -

Throws:

PortalException

Since:

9.0.0

endServiceAndInterfacesDocumentation

void endServiceAndInterfacesDocumentation(String serviceId)
                                   throws PortalException

Identifies that service and interface documentation generation is complete. The template may now finalize generation of documentation files.

Parameters:

serviceId -

transaction -

Throws:

PortalException

Since:

9.0.0

setServiceInterfaceName

void setServiceInterfaceName(String documentationGetServiceInterfaceName)
                      throws PortalException

Throws:

PortalException

setServiceInterfaceSummary

void setServiceInterfaceSummary(String documentationGetServiceInterfaceSummary)
                         throws PortalException

Summary is assumed to be simple text and not HTML.

Parameters:

documentationGetServiceInterfaceSummary -

Throws:

PortalException

Since:

9.0.0

setServiceInterfaceDetailedDescription

void setServiceInterfaceDetailedDescription(String documentationGetServiceDetailedDescription)
                                     throws PortalException

Detailed description is assumed to be HTML format.

Parameters:

documentationGetServiceDetailedDescription -

Throws:

PortalException

Since:

9.0.0

startServiceInterfaceDocumentation

void startServiceInterfaceDocumentation(String serviceInterfaceId)
                                 throws PortalException

Notifies that the documentation generation of service interface is starting.

Parameters:

serviceInterfaceId -

transaction -

Throws:

PortalException

Since:

9.0.0

endServiceInterfaceDocumentation

void endServiceInterfaceDocumentation(String serviceInterfaceId)
                               throws PortalException

Notifies that the documentation generation of service interface is complete.

Parameters:

serviceInterfaceId -

transaction -

Throws:

PortalException

Since:

9.0.0

saveFile

void saveFile(InputStream stream,
              String filePath)
       throws PortalException

Notifies the template that a new file was generated and should be saved in the given path within the documentation directory.

Parameters:

stream - input stream to the new file.

filePath - the destination path where the file should be saved in the documentation directory.

Throws:

PortalException

Since:

9.0.0

setServiceImage

void setServiceImage(String serviceImage)
              throws PortalException

Notifies the path to the service image and may be used for rendering documentation.

Parameters:

serviceImage -

Throws:

PortalException

Since:

9.0.0

addServiceImage

void addServiceImage(String filePath,
                     String legend)
              throws PortalException

Used to notify the template that the given image should be viewed in the list of images of the service.

Parameters:

filePath - relative path to the image.

legend - text that should be used to label the image.

Throws:

PortalException

Since:

9.0.0

addDocumentationSection

IDocumentationTemplate.DocumentationSection addDocumentationSection(String sectionId,
                                                                    boolean isServiceSection,
                                                                    Map<String,String> properties)
                                                             throws PortalException

Adds a new section to the documentation.

Parameters:

sectionId - identifier for the section.

isServiceSection - identifies if is a service section.

properties - proprties of the section that will be made available to the xls for rendering.

Returns:

Throws:

PortalException

Since:

9.0.0

getDocumentationSection

IDocumentationTemplate.DocumentationSection getDocumentationSection(String sectionId,
                                                                    boolean isServiceSection)
                                                             throws PortalException

Throws:

PortalException

doesFileExist

boolean doesFileExist(String filePath)
               throws PortalException

Returns true if the file exists in the documentation directory.

Parameters:

filePath -

Returns:

Throws:

PortalException

Since:

9.0.0