de.hybris.platform.print.comet

Interface PublicationController

All Known Implementing Classes:

DefaultPublicationController

public interface PublicationController

A simplified Interface to the Werk II Comet/Print Webservice.

Method Summary

Modifier and Type	Method and Description
CometBinary	getBinaryFile(String fileId) Returns a media that contains the requested file
CallProcessor	getCometCallProcessor(String method) Returns the CallProcessor that is registered for the given method
ElementlistProcessor	getElementListProcessor(String method) Returns the ElementlistProcessor that is registered for the given method
ListProcessor	getListProcessor(String method) Returns the ListProcessor that is registered for the given method
String	getMessage(int messageCode) Returns a (localized) (error)message for the given error code
void	getNextHotfolder(String program, int status, int id) Returns the next hotfolder that AutoComet shall observe for AutoCometJobs
AutoCometJob	getNextJob(String program, int status) Returns the next AutoCometJob
CometProduct[]	getProductList(Map<String,CometCondition> parameters) Returns an Array of list entries that will be displayed in the Comet product tree.
void	putBinaryFile(String fileId, CometBinary file) Stores the content of the given file
void	setCallProcessors(Collection<CallProcessor> processors)
void	setDone(int id, int status, Date starttime, Date endtime, int exitValue) Reports the end of the execution of an AutoCometJob
void	setElementlistProcessors(Collection<ElementlistProcessor> processors)
void	setListProcessors(Collection<ListProcessor> processors)
void	setProductListProcessors(Collection<ProductListProcessor> processors)
void	setStart(int id, Date starttime, int status) Reports the execution start of an AutoCometJob
void	setStatus(int id, int status) Sets the current status of an AutoCometJob

Method Detail

getProductList

CometProduct[] getProductList(Map<String,CometCondition> parameters)
                       throws CometException

Returns an Array of list entries that will be displayed in the Comet product tree.

Parameters:

parameters - The search/request parameters

Returns:

An Array of list entries that will be displayed in the Comet product tree.

Throws:

CometException - If an error occurs while retrieving the product list

getListProcessor

ListProcessor getListProcessor(String method)
                        throws UnknownProcessorException

Returns the ListProcessor that is registered for the given method

Parameters:

method - The name of the method for which to get an IListProcessor

Returns:

The related IListProcessor

Throws:

UnknownProcessorException

getElementListProcessor

ElementlistProcessor getElementListProcessor(String method)
                                      throws UnknownProcessorException

Returns the ElementlistProcessor that is registered for the given method

Parameters:

method - The name of the method for which to get an IElementlistProcessor

Returns:

The related IElementlistProcessor

Throws:

UnknownProcessorException

getCometCallProcessor

CallProcessor getCometCallProcessor(String method)
                             throws UnknownProcessorException

Returns the CallProcessor that is registered for the given method

Parameters:

method - The name of the method for which to get an ICallProcessor

Returns:

The related ICallProcessor

Throws:

UnknownProcessorException

getBinaryFile

CometBinary getBinaryFile(String fileId)
                   throws CometException

Returns a media that contains the requested file

Parameters:

fileId - The file name for which to get the content

Returns:

The content of the requested file

Throws:

CometException - If an error occurs while getting the file

putBinaryFile

void putBinaryFile(String fileId,
                   CometBinary file)
            throws CometException

Stores the content of the given file

Parameters:

fileId - The filename of related content

file - The content that shall be stored

Throws:

CometException - If an error occurs while storing the file

getMessage

String getMessage(int messageCode)
           throws CometException

Returns a (localized) (error)message for the given error code

Parameters:

messageCode - The code for which to get the respective message

Returns:

The (localized) message for the given error code

Throws:

CometException - If an error occurs while getting the message

getNextJob

AutoCometJob getNextJob(String program,
                        int status)
                 throws CometException

Returns the next AutoCometJob

Parameters:

program - Unused (TODO: what is this?)

status - Unused (TODO: what is this?)

Returns:

The next AutoCometJob

Throws:

CometException - If an error occurs while getting the next job

setStart

void setStart(int id,
              Date starttime,
              int status)
       throws CometException

Reports the execution start of an AutoCometJob

Parameters:

id - The ID of the AutoCometJob that's execution has started

starttime - The time, when the execution has started

status - The AutoCometJob's current status

Throws:

CometException - If an error occurs while starting an AutoCometJob

setStatus

void setStatus(int id,
               int status)
        throws CometException

Sets the current status of an AutoCometJob

Parameters:

id - The ID of the AutoCometJob that's status becomes reported

status - The AutoCometJob's current status

Throws:

CometException - If an error occurs while setting the status to an AutoCometJob

setDone

void setDone(int id,
             int status,
             Date starttime,
             Date endtime,
             int exitValue)
      throws CometException

Reports the end of the execution of an AutoCometJob

Parameters:

id - The ID of the AutoCometJob that's execution has ended

status - The AutoCometJob's current status

starttime - The time, when the execution has started

endtime - The time, when the execution has ended

exitValue - The result code

Throws:

CometException - If an error occurs while finalize an AutoCometJob

getNextHotfolder

void getNextHotfolder(String program,
                      int status,
                      int id)
               throws CometException

Returns the next hotfolder that AutoComet shall observe for AutoCometJobs

Parameters:

program - Unused (TODO: what is this?)

status - Unused (TODO: what is this?)

id - Unused (TODO: what is this?)

Throws:

CometException - If an error occurs while getting the next hot folder

setCallProcessors

void setCallProcessors(Collection<CallProcessor> processors)

setListProcessors

void setListProcessors(Collection<ListProcessor> processors)

setElementlistProcessors

void setElementlistProcessors(Collection<ElementlistProcessor> processors)

setProductListProcessors

void setProductListProcessors(Collection<ProductListProcessor> processors)