imthype::IJobOutput

#include <IJobOutput.h>

Inheritance diagram for imthype::IJobOutput:

Public Types
enum	ProcessingOutputType { POT_RESULT , POT_ARTIFACT }
Public Types inherited from imtbase::ICollectionInfo
enum	ChangeFlags {   CF_ADDED = 10000 , CF_ELEMENT_RENAMED , CF_ELEMENT_DESCRIPTION_CHANGED , CF_ELEMENT_STATE ,   CF_REMOVED , CF_RESTORED , CF_LAST }
enum	ElementInfoType { EIT_NAME , EIT_DESCRIPTION , EIT_ENABLED , EIT_USER = 1000 }
enum	MetaInfoType {   MIT_INSERTION_USER = idoc::IDocumentMetaInfo::MIT_USER + 10000 , MIT_INSERTION_TIME , MIT_LAST_OPERATION_USER , MIT_LAST_OPERATION_TIME ,   MIT_PREVIEW_THUMBNAIL , MIT_REVISION = idoc::IDocumentMetaInfo::MIT_USER + 20000 }

Public Member Functions
virtual void	SetProcessingReport (const ilog::IMessageContainer &processingLog, const QDateTime &startTime, const QDateTime &finishTime)=0
virtual ProcessingOutputType	GetOutputType (const QByteArray &outputObjectId) const =0
virtual void	SetOutputType (const QByteArray &outputObjectId, ProcessingOutputType outputType)=0
virtual const IJobExecutionLog *	GetExecutionLog () const =0
virtual void	SetExecutionLog (const IJobExecutionLog &executionLog)=0
virtual const ilog::IMessageContainer *	GetProcessorLog () const =0
virtual void	SetProcessorLog (const ilog::IMessageContainer &processorLog)=0
Public Member Functions inherited from imthype::IProcessingInfo
virtual ProcessingInfo	GetProcessingInfo () const =0
virtual const ilog::IMessageContainer &	GetProcessingLog () const =0
Public Member Functions inherited from imtbase::IReferenceCollection
virtual bool	InsertReference (const Id &objectId, const QByteArray &repositoryId=QByteArray())=0
virtual bool	RemoveReference (const Id &objectId)=0
virtual bool	RemoveAllReferences ()=0
Public Member Functions inherited from imtbase::IObjectCollectionInfo
virtual const iprm::IOptionsList *	GetObjectTypesInfo () const =0
virtual Id	GetObjectTypeId (const Id &objectId) const =0
virtual idoc::MetaInfoPtr	GetDataMetaInfo (const Id &objectId) const =0
Public Member Functions inherited from imtbase::ICollectionInfo
virtual int	GetElementsCount (const iprm::IParamsSet *selectionParamsPtr=nullptr, ilog::IMessageConsumer *logPtr=nullptr) const =0
virtual Ids	GetElementIds (int offset=0, int count=-1, const iprm::IParamsSet *selectionParamsPtr=nullptr, ilog::IMessageConsumer *logPtr=nullptr) const =0
virtual bool	GetSubsetInfo (ICollectionInfo &subsetInfo, int offset=0, int count=-1, const iprm::IParamsSet *selectionParamsPtr=nullptr, ilog::IMessageConsumer *logPtr=nullptr) const =0
virtual QVariant	GetElementInfo (const Id &elementId, int infoType, ilog::IMessageConsumer *logPtr=nullptr) const =0
virtual idoc::MetaInfoPtr	GetElementMetaInfo (const Id &elementId, ilog::IMessageConsumer *logPtr=nullptr) const =0
virtual bool	SetElementName (const Id &elementId, const QString &name, ilog::IMessageConsumer *logPtr=nullptr)=0
virtual bool	SetElementDescription (const Id &elementId, const QString &description, ilog::IMessageConsumer *logPtr=nullptr)=0
virtual bool	SetElementEnabled (const Id &elementId, bool isEnabled=true, ilog::IMessageConsumer *logPtr=nullptr)=0

Detailed Description

Common interface for a job output. The job output is a collection of object references categorized by their logical type. The interface provides access to the processing information, execution log, and processor log.

Definition at line 24 of file IJobOutput.h.

Member Enumeration Documentation

ProcessingOutputType

enum imthype::IJobOutput::ProcessingOutputType

Enumeration describing all possible types of processing output.

Enumerator
POT_RESULT	The output is the result of the job processing.
POT_ARTIFACT	The output is a processing artifact. This can be a job log, some additional output, intermediate results, reports, diagnostics stuff, etc.

Definition at line 30 of file IJobOutput.h.

Member Function Documentation

GetExecutionLog()

virtual const IJobExecutionLog * imthype::IJobOutput::GetExecutionLog ( ) const

pure virtual

Get the job execution log (system-level controller events).

Returns

Pointer to execution log, or nullptr if not set

GetOutputType()

virtual ProcessingOutputType imthype::IJobOutput::GetOutputType ( const QByteArray &  outputObjectId ) const

pure virtual

Get the type of processing output object.

GetProcessorLog()

virtual const ilog::IMessageContainer * imthype::IJobOutput::GetProcessorLog ( ) const

pure virtual

Get the processor log (worker processing output).

Returns

Pointer to processor log, or nullptr if not set

SetExecutionLog()

virtual void imthype::IJobOutput::SetExecutionLog ( const IJobExecutionLog &  executionLog )

pure virtual

Set the job execution log.

Parameters

executionLog

System-level execution log

SetOutputType()

virtual void imthype::IJobOutput::SetOutputType ( const QByteArray &  outputObjectId, ProcessingOutputType  outputType  )

pure virtual

Set the type of processing output for the given output object.

SetProcessingReport()

virtual void imthype::IJobOutput::SetProcessingReport ( const ilog::IMessageContainer &  processingLog, const QDateTime &  startTime, const QDateTime &  finishTime  )

pure virtual

Set processing report.

SetProcessorLog()

virtual void imthype::IJobOutput::SetProcessorLog ( const ilog::IMessageContainer &  processorLog )

pure virtual

Set the processor log.

Parameters

processorLog

Worker processing log