org.outerj.daisy.publisher.serverimpl.requestmodel
Interface PublisherContext

All Known Implementing Classes:
PublisherContextImpl, RootPublisherContext

public interface PublisherContext


Field Summary
static long NO_VERSION
           
 
Method Summary
 long getBranchId()
           
 ContentProcessor getContentProcessor()
          Returns null if not available.
 org.outerj.daisy.repository.Document getDocument()
           
 long getDocumentId()
           
 long getLanguageId()
           
 java.util.Locale getLocale()
           
 org.apache.avalon.framework.logger.Logger getLogger()
           
 PreparedDocuments getPreparedDocuments()
          Returns null if not available.
 PublisherImpl getPublisher()
           
 org.outerj.daisy.repository.Repository getRepository()
           
 java.text.DateFormat getTimestampFormat()
           
 org.outerj.daisy.repository.VariantKey getVariantKey()
           
 org.outerj.daisy.repository.Version getVersion()
          If a live version was requested but the document doesn't have a live version, this method returns null.
 long getVersionId()
          If a live version was requested but the document doesn't have a live version, this method returns NO_VERSION.
 PublisherVersionMode getVersionMode()
           
 boolean hasDocument()
          Returns true if the getDocument and getVersion methods can safely be called.
 boolean searchRecursivePrepDocs(long documentId, long branchId, long languageId, java.lang.String pubReqSetName)
           
 

Field Detail

NO_VERSION

static final long NO_VERSION
See Also:
Constant Field Values
Method Detail

getLocale

java.util.Locale getLocale()

getDocumentId

long getDocumentId()

getBranchId

long getBranchId()

getLanguageId

long getLanguageId()

getVersionId

long getVersionId()
                  throws org.outerj.daisy.repository.RepositoryException
If a live version was requested but the document doesn't have a live version, this method returns NO_VERSION. Otherwise, the actual version number is returned.

Throws:
org.outerj.daisy.repository.RepositoryException

getVariantKey

org.outerj.daisy.repository.VariantKey getVariantKey()

getDocument

org.outerj.daisy.repository.Document getDocument()
                                                 throws org.outerj.daisy.repository.RepositoryException
Throws:
org.outerj.daisy.repository.RepositoryException

hasDocument

boolean hasDocument()
Returns true if the getDocument and getVersion methods can safely be called. (though getVersion might return null)


getVersion

org.outerj.daisy.repository.Version getVersion()
                                               throws org.outerj.daisy.repository.RepositoryException
If a live version was requested but the document doesn't have a live version, this method returns null.

Throws:
org.outerj.daisy.repository.RepositoryException

getTimestampFormat

java.text.DateFormat getTimestampFormat()

getRepository

org.outerj.daisy.repository.Repository getRepository()

getLogger

org.apache.avalon.framework.logger.Logger getLogger()

getPublisher

PublisherImpl getPublisher()

getPreparedDocuments

PreparedDocuments getPreparedDocuments()
Returns null if not available.


getContentProcessor

ContentProcessor getContentProcessor()
Returns null if not available.


searchRecursivePrepDocs

boolean searchRecursivePrepDocs(long documentId,
                                long branchId,
                                long languageId,
                                java.lang.String pubReqSetName)

getVersionMode

PublisherVersionMode getVersionMode()


Copyright © -2012 . All Rights Reserved.