Package com.ptc.windchill.suma.axl

Class StandardAXLService

java.lang.Object

wt.services.StandardManager

com.ptc.windchill.suma.axl.StandardAXLService

All Implemented Interfaces:

com.ptc.windchill.suma.axl.AXLEventManager, com.ptc.windchill.suma.axl.AXLServerService, AXLService, Serializable, wt.fc._NetFactor, NetFactor, wt.services.Manager

public final class StandardAXLService
extends StandardManager
implements AXLService, com.ptc.windchill.suma.axl.AXLEventManager, com.ptc.windchill.suma.axl.AXLServerService

Use the newStandardAXLService static factory method(s), not the StandardAXLService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

See Also:

• AXLService
• AXLServerService
• 

Supported API: true

Extendable: false
• Serialized Form

Field Summary

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Method Summary

Modifier and Type	Method	Description
AXLEntry	addAML(AXLContext context, WTPart oemPart, VendorPart vendorPart, ManufacturerPart manufacturerPart, AXLPreference amlPreference)	Adds an AML entry under the following two circumstances: When vendor part is not specified (null), creates a new AML entry with the context, oem part, and manufacturer part.
AXLEntry	addAVL(AXLContext context, WTPart oemPart, ManufacturerPart manufacturerPart, VendorPart vendorPart, AXLPreference avlPreference)	Adds an AVL with the specified context, OEM part, and vendor part.
WTCollection	getAML(WTPart oem_part, AXLContext context)	Retrieves all AML entries for the specified OEM part under the specified sourcing context.
WTCollection	getAVL(WTPart oem_part, AXLContext context, com.ptc.windchill.suma.part.ManufacturerPartMaster mfr_part_master)	Retrieves all AVL entries for the specified OEM part , sourcing context, and manufacturer part master.
WTCollection	getManufacturerParts(AXLContext context, WTPart oemPart)	Returns all manufacturer parts for the specified context and OEM part.
WTCollection	getSupplierParts(AXLContext context, WTPart oemPart)	Returns all supplier parts for the specified context and OEM part.
WTCollection	getVendorParts(AXLContext context, WTPart oemPart)	Returns all vendor parts for the specified context and OEM part.
WTCollection	getVendorParts(AXLContext context, WTPart oemPart, ManufacturerPart manufacturerPart)	Returns all vendor parts that are related to the specified context, OEM part, and manufacturer part.
WTCollection	getVendorParts(AXLEntry aml)	Returns all vendor parts for the combination of sourcing context, oem part, and manufacturer part as defined in the AML.
void	removeAML(AXLContext context, WTPart oemPart, ManufacturerPart manufacturerPart)	Removes all AXL that are related to the specified OEM part, manufacturer part and context.
void	removeAVL(AXLContext context, WTPart oemPart, VendorPart vendorPart)	Removes a vendor part from the AXL for the specified OEM part and context.
void	removeAXL(WTSet entries)	Removes a set of AXL entries.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

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

Method Details

addAML

public AXLEntry addAML(AXLContext context,
 WTPart oemPart,
 VendorPart vendorPart,
 ManufacturerPart manufacturerPart,
 AXLPreference amlPreference)
                throws WTException

Adds an AML entry under the following two circumstances:

1. When vendor part is not specified (null), creates a new AML entry with the context, oem part, and manufacturer part.
2. When vendor part is specified (not null), adds manufacture part to an existing AVL entry that has the context, OEM part, and vendor part.

Supported API: true

Supported API: true

Specified by:

addAML in interface AXLService

Parameters:

context - an AXL context

oemPart - an OEM part

vendorPart - an optional vendor part. If the vendor part is specified, an AVL with the context, OEM part, and vendor part must exist.

manufacturerPart - a manufacturer part that is being added

amlPreference - a manufacturer part preference

Throws:

WTException - If there is another entry with the context, OEM part, and manufacturer part.

If the vendor part is specified but an attempt to find an existing entry with the context, OEM part, and vendor part has failed.

addAVL

public AXLEntry addAVL(AXLContext context,
 WTPart oemPart,
 ManufacturerPart manufacturerPart,
 VendorPart vendorPart,
 AXLPreference avlPreference)
                throws WTException

Adds an AVL with the specified context, OEM part, and vendor part. The behavior of this method depends upon the optional manufacturer part argument:

1. When no manufacturer part is specified (null), creates a new AML with the context, OEM part, and manufacturer part.
2. When a manufacturer part is specified, either creates a new AXL with the context, OEM part, manufacturer part, and vendor part or modifies an existing AML by adding the vendor part depending on whether AXLs exist with the context, OEM part, and manufacturer part.

Supported API: true

Supported API: true

Specified by:

addAVL in interface AXLService

Parameters:

context - an AXLContext

oemPart - an OEM part

manufacturerPart - a manufacturer part to which the vendor part is being added.

vendorPart - a vendor part to be added

avlPreference - an AVL preference

Throws:

WTException - If another entry with the context, OEM part, and vendor part exists.

If the optional manufacturer part is specified but an attempt to find AMLs with the context, OEM part, and manufacturer part has failed.

removeAML

public void removeAML(AXLContext context,
 WTPart oemPart,
 ManufacturerPart manufacturerPart)
               throws WTException

Removes all AXL that are related to the specified OEM part, manufacturer part and context.

Supported API: true

Supported API: true

Specified by:

removeAML in interface AXLService

Parameters:

context - an AXL context.

oemPart - an OEM part

manufacturerPart - the manufacturer part being removed from AML

Throws:

WTException

removeAVL

public void removeAVL(AXLContext context,
 WTPart oemPart,
 VendorPart vendorPart)
               throws WTException

Removes a vendor part from the AXL for the specified OEM part and context. Checks if the matching entry contains a manufacturer part. If it does, also check if this is the only entry that mathces the OEM part and the manufacturer part - if it is, update the record otherwise remove the record.

Supported API: true

Supported API: true

Specified by:

removeAVL in interface AXLService

Parameters:

context - an AXL context.

oemPart - an OEM part

vendorPart - the vendor part to be removed from AVL

Throws:

WTException

removeAXL

public void removeAXL(WTSet entries)
               throws WTException

Removes a set of AXL entries. Note that the set of entries must belong to the same OEM part under the same context.

Supported API: true

Supported API: true

Specified by:

removeAXL in interface AXLService

Parameters:

entries - A collection of AXLEntry

Throws:

WTException

getAML

public WTCollection getAML(WTPart oem_part,
 AXLContext context)
                    throws WTException

Retrieves all AML entries for the specified OEM part under the specified sourcing context. This API removes duplication - for example, if there are multiple entries for the same manufacturer part, only one entry related to that manufacturer part will be returned.

Supported API: true

Supported API: true

Specified by:

getAML in interface AXLService

Parameters:

oem_part - an OEM part

context - a sourcing context

Returns:

WTCollection

Throws:

WTException

getAVL

public WTCollection getAVL(WTPart oem_part,
 AXLContext context,
 com.ptc.windchill.suma.part.ManufacturerPartMaster mfr_part_master)
                    throws WTException

Retrieves all AVL entries for the specified OEM part , sourcing context, and manufacturer part master.

Supported API: true

Supported API: true

Specified by:

getAVL in interface AXLService

Parameters:

oem_part - an OEM part

context - a sourcing context

mfr_part_master - a manufacturer part master

Returns:

WTCollection

Throws:

WTException

getManufacturerParts

public WTCollection getManufacturerParts(AXLContext context,
 WTPart oemPart)
                                  throws WTException

Returns all manufacturer parts for the specified context and OEM part. If context is null, returns all related manufacturer parts regardless of sourcing context.

Supported API: true

Supported API: true

Specified by:

getManufacturerParts in interface AXLService

Parameters:

context - an AXL context

oemPart - an OEM part

Returns:

WTCollection a collection of manufacturer parts

Throws:

WTException

getVendorParts

public WTCollection getVendorParts(AXLContext context,
 WTPart oemPart)
                            throws WTException

Returns all vendor parts for the specified context and OEM part. If context is null, returns all related vendor parts regardless of sourcing context.

Supported API: true

Supported API: true

Specified by:

getVendorParts in interface AXLService

Parameters:

context - an AXL context

oemPart - an OEM part

Returns:

WTCollection a collection of vendor parts

Throws:

WTException

getVendorParts

public WTCollection getVendorParts(AXLContext context,
 WTPart oemPart,
 ManufacturerPart manufacturerPart)
                            throws WTException

Returns all vendor parts that are related to the specified context, OEM part, and manufacturer part. If context is null, returns all related vendor parts regardless of sourcing context.

Supported API: true

Supported API: true

Specified by:

getVendorParts in interface AXLService

Parameters:

context - an AXL context

oemPart - an OEM part

manufacturerPart - a manufacturer part

Returns:

a collection of vendor parts that meet the search criteria

Throws:

WTException

getVendorParts

public WTCollection getVendorParts(AXLEntry aml)
                            throws WTException

Returns all vendor parts for the combination of sourcing context, oem part, and manufacturer part as defined in the AML.

Supported API: true

Supported API: true

Specified by:

getVendorParts in interface AXLService

Parameters:

aml -

Returns:

WTCollection

Throws:

WTException

getSupplierParts

public WTCollection getSupplierParts(AXLContext context,
 WTPart oemPart)
                              throws WTException

Returns all supplier parts for the specified context and OEM part.

Supported API: true

Supported API: true

Specified by:

getSupplierParts in interface AXLService

Parameters:

context - an AXL context

oemPart - an OEM part

Returns:

a collection of related manufacturer parts and vendor parts

Throws:

WTException