com.reqdesign.reqif.compliance.exchange_process

Class ProcessTemplate

java.lang.Object

com.reqdesign.reqif.compliance.exchange_process.ProcessTemplate

Direct Known Subclasses:

SRCProcessTemplate

public abstract class ProcessTemplate
extends java.lang.Object

This class describes the rules that can be checked to determine whether archives in an exchange process comply with a particular exchange process - basically workflow rules In the process of defining such rules, the following need to be considered... 1) Which attributes in the archive contribute to the process - there may be many more 2) Whether an attribute is read/write by the customer and/or the supplier 3) Permitted values for an attribute - dependent on state 4) Permitted transition states 5) many more...

Constructor Summary

Constructors

Constructor and Description
ProcessTemplate(ProcessDefinition processDefinition, Role referenceRole)

Method Summary

Modifier and Type	Method and Description
abstract void	checkCompliance(ReqIFArchive previous, ReqIFArchive priorCurrent, ReqIFArchive current, Role currentRole, java.util.function.Consumer<ComplianceMessage> complianceMessageConsumer)
ProcessDefinition	getProcessDefinition()
abstract ReferenceDefinitions	getReferenceDefinitions() the status definitions and values for the 1st reference archive in the process exchange
Role	getReferenceRole()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessTemplate

public ProcessTemplate(ProcessDefinition processDefinition,
                       Role referenceRole)

Method Detail

getReferenceDefinitions

public abstract ReferenceDefinitions getReferenceDefinitions()

the status definitions and values for the 1st reference archive in the process exchange

Returns:

non null reference to the ReferenceDefinitions collection in this ProcessTemplate object

checkCompliance

public abstract void checkCompliance(ReqIFArchive previous,
                                     ReqIFArchive priorCurrent,
                                     ReqIFArchive current,
                                     Role currentRole,
                                     java.util.function.Consumer<ComplianceMessage> complianceMessageConsumer)
                              throws ExchangeProcessComplianceException

Parameters:

previous - the archive previous to the current archive for comparison, can be null

priorCurrent - the 1st archive with the same role as current, prior to the current, can be null

current - the current archive to check for compliance by comparing it to the previous archive, not null

currentRole - the role of the current archive, either CUSTOMER or SUPPLIER, not null

complianceMessageConsumer - a consumer of ComplianceMessage objects, not null

Throws:

ExchangeProcessComplianceException - if an exception occurs during the compliance check

getProcessDefinition

public ProcessDefinition getProcessDefinition()

getReferenceRole

public Role getReferenceRole()