org.outerj.daisy.books.publisher
Interface BookPublisher

All Known Implementing Classes:

BookPublisherImpl

public interface BookPublisher

Field Summary

static java.lang.String

ROLE

Method Summary

PublicationTypeInfo[]	getAvailablePublicationTypes(java.lang.String daisyContextPath)
java.util.Map	getDefaultProperties(java.lang.String publicationTypeName, java.lang.String daisyContextPath)
PublishTaskInfo[]	getTaskOverview(java.util.Locale locale)
java.lang.String[]	getTaskState(java.lang.String taskId)
java.lang.String[]	publishBook(org.outerj.daisy.repository.Repository repository, org.outerj.daisy.repository.VariantKey bookDefinition, long dataBranchId, long dataLanguageId, java.lang.String dataVersion, java.util.Locale locale, java.lang.String bookInstanceName, java.lang.String bookInstanceLabel, java.lang.String daisyCocoonPath, java.lang.String daisyContextPath, PublicationSpec[] specs, BookAcl acl)

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

publishBook

java.lang.String[] publishBook(org.outerj.daisy.repository.Repository repository,
                               org.outerj.daisy.repository.VariantKey bookDefinition,
                               long dataBranchId,
                               long dataLanguageId,
                               java.lang.String dataVersion,
                               java.util.Locale locale,
                               java.lang.String bookInstanceName,
                               java.lang.String bookInstanceLabel,
                               java.lang.String daisyCocoonPath,
                               java.lang.String daisyContextPath,
                               PublicationSpec[] specs,
                               BookAcl acl)
                               throws java.lang.Exception

Returns:

an array containing two elements: the task ID and the (normalized) book instance name

Throws:

java.lang.Exception

getAvailablePublicationTypes

PublicationTypeInfo[] getAvailablePublicationTypes(java.lang.String daisyContextPath)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultProperties

java.util.Map getDefaultProperties(java.lang.String publicationTypeName,
                                   java.lang.String daisyContextPath)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getTaskState

java.lang.String[] getTaskState(java.lang.String taskId)

Returns:

null if the task with the given ID does not exist (or is finished, which is the same)

getTaskOverview

PublishTaskInfo[] getTaskOverview(java.util.Locale locale)

Returns:

a list of all running book publish tasks, of all users.