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

All Known Subinterfaces:
ParentPublisherRequest
All Known Implementing Classes:
DocumentRequest, ForEachRequest, GroupRequest, PublisherRequest

public interface PublisherContext


Field Summary
static long NO_VERSION
           
 
Method Summary
 long getBranchId()
           
 org.outerj.daisy.repository.Document getDocument()
           
 long getDocumentId()
           
 long getLanguageId()
           
 java.util.Locale getLocale()
           
 org.apache.avalon.framework.logger.Logger getLogger()
           
 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.
 

Field Detail

NO_VERSION

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

getLocale

public java.util.Locale getLocale()

getDocumentId

public long getDocumentId()

getBranchId

public long getBranchId()

getLanguageId

public long getLanguageId()

getVersionId

public 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

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

getDocument

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

getVersion

public 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

public java.text.DateFormat getTimestampFormat()

getRepository

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

getLogger

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


Copyright © -2005 . All Rights Reserved.