Package com.ptc.qualitymanagement.udi

Interface UDIAttributePopulatorService

All Known Implementing Classes:

AbstractUDIAttributePopulator, StandardFDAUDIAttributePopulator, StandardUdiSuperSet2AttributePopulator, StandardUdiSuperSetAttributePopulator

public interface UDIAttributePopulatorService

Defines the three paths used to pre-populate a UDI Submission during creation.

Implementations will be registered as service with the selector equal to the class name of the UDI Submission object it populates.

Supported API: true

Extendable: false

See Also:

• AbstractUDIAttributePopulator
• StandardUdiSuperSetAttributePopulator
• StandardUdiSuperSet2AttributePopulator

Method Summary

Modifier and Type	Method	Description
UDISubmission	createUDISubmission()	Create a properly initialized instance of the correct type of UDI Submission object.
List<String>	getOrderedAttributes(UDISubmission submission)	Gets the list of ordered attributes based on the order of the human readable report.
default WTPart	getPart()	Function to get the value of the part variable.
void	initializeFollowUp(UDISubmission submission)	Update the UDI Submission after it has been populated with values from the previous iteration.
Collection<UDISubmissionDetailsIfc>	populateFromAttributes(UDISubmission submission, Map<String,Object> attributes)	Populate the submission with the values found in the attributes map.
Collection<UDISubmissionDetailsIfc>	populateFromSouce(UDISubmission submission, Map attributes)	Populate the submission with attributes found in source systems.
Collection<UDISubmissionDetailsIfc>	populateFromTemplate(UDISubmission submission, UDISubmission template)	Populate the submission with the default values provided by the template.
UDISubmissionInfoBean	populateOneToManyAttributesFromSource(UDISubmission submission, UDISubmissionInfoBean infoBean, Map.Entry<UDISubmission,Collection<UDISubmissionDetailsIfc>> sourceData)	Add all the OneTomany objects in UDISubmissioInfoBean with different value for refreshed UDISubmission(Bulk Update).
UDISubmissionInfoBean	populateSimpleAttributesForBulkUpdate(UDISubmission submission, UDISubmissionInfoBean bean, UDISubmission vir_Submission, List<String> availableAttributes)	Add all the Simple attributes value in UDISubmissionInfoBean with different value for refreshed UDISubmission(Bulk Update).
void	refreshFromSource(UDISubmission submission)	Update the UDI Submission with values from the template and source systems Supported API: true
default void	setPart(WTPart part)	Function to set the value of the part variable.

Method Details

createUDISubmission

UDISubmission createUDISubmission()
                           throws WTException

Create a properly initialized instance of the correct type of UDI Submission object.

Throws:

WTException -

Supported API: true

populateFromTemplate

Collection<UDISubmissionDetailsIfc> populateFromTemplate(UDISubmission submission,
 UDISubmission template)
                                                  throws WTException,
WTPropertyVetoException

Populate the submission with the default values provided by the template.

Supported API: true

Parameters:

submission -

template -

Returns:

The detail child objects created.

Throws:

WTException

WTPropertyVetoException

populateFromSouce

Collection<UDISubmissionDetailsIfc> populateFromSouce(UDISubmission submission,
 Map attributes)
                                               throws WTPropertyVetoException,
WTException

Populate the submission with attributes found in source systems.

The default implementation will find UDI Attribute values throughout the Windchill installation based upon the submittedForReference Part.

It is expected that customizations will extend the default implementations and override this method with calls to external systems where UDI data is stored.

Supported API: true

Parameters:

submission -

attributes -

Returns:

The detail child objects created.

Throws:

WTPropertyVetoException

WTException

populateFromAttributes

Collection<UDISubmissionDetailsIfc> populateFromAttributes(UDISubmission submission,
 Map<String,Object> attributes)
                                                    throws WTException,
WTPropertyVetoException

Populate the submission with the values found in the attributes map.

This method is used to populate the values into a UDI submission during Excel import.

The values in the attributes map must be of the correct datatype matching the attribute in the submission object. No conversion is performed by this method.

Supported API: true

Parameters:

submission -

attributes -

Returns:

The detail child objects created.

Throws:

WTException

WTPropertyVetoException

initializeFollowUp

void initializeFollowUp(UDISubmission submission)
                 throws WTPropertyVetoException,
WTException

Update the UDI Submission after it has been populated with values from the previous iteration.

Supported API: true

Parameters:

submission -

Throws:

WTPropertyVetoException

WTException

refreshFromSource

void refreshFromSource(UDISubmission submission)
                throws WTException,
WTPropertyVetoException

Update the UDI Submission with values from the template and source systems

Supported API: true

Parameters:

submission -

Throws:

WTException

WTPropertyVetoException

populateSimpleAttributesForBulkUpdate

UDISubmissionInfoBean populateSimpleAttributesForBulkUpdate(UDISubmission submission,
 UDISubmissionInfoBean bean,
 UDISubmission vir_Submission,
 List<String> availableAttributes)
                                                     throws WTException,
WTPropertyVetoException

Add all the Simple attributes value in UDISubmissionInfoBean with different value for refreshed UDISubmission(Bulk Update).

Supported API: true

Parameters:

submission -

bean -

vir_Submission -

availableAttributes -

Returns:

Throws:

WTException

WTPropertyVetoException

populateOneToManyAttributesFromSource

UDISubmissionInfoBean populateOneToManyAttributesFromSource(UDISubmission submission,
 UDISubmissionInfoBean infoBean,
 Map.Entry<UDISubmission,Collection<UDISubmissionDetailsIfc>> sourceData)
                                                     throws WTPropertyVetoException,
WTException

Add all the OneTomany objects in UDISubmissioInfoBean with different value for refreshed UDISubmission(Bulk Update).

Supported API: true

Parameters:

submission -

infoBean -

sourceData -

Returns:

Throws:

WTPropertyVetoException

WTException

getOrderedAttributes

List<String> getOrderedAttributes(UDISubmission submission)
                           throws WTException

Gets the list of ordered attributes based on the order of the human readable report.

Supported API: true

Returns:

Throws:

WTException

getPart

default WTPart getPart()

Function to get the value of the part variable.

Supported API: true

Returns:

value of the part variable.

setPart

default void setPart(WTPart part)

Function to set the value of the part variable.

Supported API: true