com.ptc.windchill.esi.svc
Interface ESISvrService

All Known Implementing Classes:

StandardESIService

public interface ESISvrService

Defines the non-client methods that are available on the ESI service.

Supported API: true

Extendable: false

Method Summary

void	adjustTargetAssignments(String ufids, Group targetInfo) Given a concatenated set of UFIDs (for WTParts) and a Collection of ESITarget UFIDs, make (or remove) any required assignments.
ReleaseActivity[]	getActivities(String ufid) Given the UFID of an ESITransaction, returns an array of all of the ReleaseActivities associated with that ESITransaction.
IeCollection	getBOM(String objectID, boolean delta, boolean parts, boolean alternates, boolean substitutes, boolean referenceDesignators, boolean lineNumbers, String mulitLevel, boolean documents, String configSpec, String auth, String wcAdapter, String transactionID) getBOM RPC processor.
IeCollection	getECN(String objectID, boolean delta, boolean componentParts, boolean alternates, boolean substitutes, boolean referenceDesignators, boolean lineNumbers, String mulitLevel, boolean documents, String configSpec, String auth, String wcAdapter, String transactionID) getECN RPC processor.
Group	getHistory(String ufid, String groupOut) Returns a Group of mapped ReleaseActivity objects associated with the object identied by the argument.
IeCollection	getPart(String objectID, boolean alternates, boolean documents, String auth, String wcAdapter, String transactionID) GetPart RPC processor.
Group	getReleaseActivities(String ufid) Returns an Info*Engine Group of mapped ESI ReleaseActivity objects given the ufid of an ESITransaction object.
Group	getReleaseActivitiesMessage(String ufid) Return an Info*Engine Group of mapped ReleaseActivityMessage object given the ufid of a ReleaseActivity object.
Group	getTargetAssociations(String ufids, String groupName) Given a string of concatenated UFIDs, return the ESITarget objects that are associated with those objects.
WTKeyedMap	getTargets(WTCollection objects) Takes a WTCollection of persistables and returns a WTKeyedMap.
Group	getTargetsWithHistory(Collection objects) Returns an Info*Engine Group of mapped ESITargetHistory objects.
Collection	getTargetsWithHistory(Persistable object) Returns a Collection of ESITargetHistory objects.
Group	getTargetsWithHistory(String ufid) Returns an Info*Engine Group of mapped ESITargetHistory objects.
Group	getTransactionLogMessage(String ufid) Returns an Info*Engine Group of mapped ESITransactionMessage object given the ufid of an ESITransaction object.
Group	getTransactions(Group elements) Returns an Info*Engine Group of ESITransaction objects that are associated with the objects in the argument.
void	hideTransaction(String ufid) Hide an ESITransaction from the user interface.
ESITargetAssociation	latestExport(Persistable object, ESITarget target) Find the highest revision of an object that has been exported to an ESI target.
void	postEvent(String objectID, String transaction, boolean successful, String message) PostEvent RPC processor.
void	postResult(String objectID, String description, String txnID, boolean successful, boolean subtransaction, String targetSystem, String message, String timestamp, String action, String cls, String user) PostResult RPC processor.
void	recordExport(String objectID, String targetSystem, String releaseClass) RecordExport RPC processor.

Method Detail

postResult

public void postResult(String objectID,
                       String description,
                       String txnID,
                       boolean successful,
                       boolean subtransaction,
                       String targetSystem,
                       String message,
                       String timestamp,
                       String action,
                       String cls,
                       String user)
                throws WTException

PostResult RPC processor. Delegates all work to an instance of ESITransactionUtility.

Supported API: true

Parameters:

objectID - The identifier of the object being tracked.

description -

txnID - The ID of an existing transaction.

successful - Was the release a success?

subtransaction - Is this a transaction line item?

targetSystem - The name of the ESIOrganization where the object is being sent

message - An optional message

timestamp - The time when the activity was completed. Must be convertible to a java.sql.TimeStamp.

action - "added", "updated",or "deleted"

cls - The logical class of the object being tracked.

user - The user who creates the transaction.

Throws:

WTException

latestExport

public ESITargetAssociation latestExport(Persistable object,
                                         ESITarget target)
                                  throws WTException

Find the highest revision of an object that has been exported to an ESI target.

Supported API: true

Parameters:

object - The persistable whose release history is being interrogated.

target - The ESITarget of interest.

Returns:

ESITargetAssociation

Throws:

WTException

postEvent

public void postEvent(String objectID,
                      String transaction,
                      boolean successful,
                      String message)
               throws WTException

PostEvent RPC processor. Delegates all work to an instance of ESITransactionUtility.

Supported API: true

Parameters:

objectID - The id of the object whose event is being observed by Windchill event services.

transaction - the number of the transaction this event is related to.

successful - Was this transaction a success

message - a message that will be conveyed to the workflow which is waiting for this event.

Throws:

WTException

getPart

public IeCollection getPart(String objectID,
                            boolean alternates,
                            boolean documents,
                            String auth,
                            String wcAdapter,
                            String transactionID)
                     throws WTException

GetPart RPC processor. Defers all work to an instance of ESIPartUtility.

Supported API: true

Parameters:

objectID - The UFID of the part that is desired.

alternates - true or false. If true, will return alternates parts for the part in question.

documents - true or false. If true, will return the documents for the part in question. If alternates is true, will return the documents for the alternate parts.

auth - This parameter contains authentication information from I*E.

wcAdapter - This parameter contains the name of the Windchill adapter.

transactionID - The TransactionID for this ObjectID.

Returns:

IeCollection

Throws:

WTException

getBOM

public IeCollection getBOM(String objectID,
                           boolean delta,
                           boolean parts,
                           boolean alternates,
                           boolean substitutes,
                           boolean referenceDesignators,
                           boolean lineNumbers,
                           String mulitLevel,
                           boolean documents,
                           String configSpec,
                           String auth,
                           String wcAdapter,
                           String transactionID)
                    throws WTException

getBOM RPC processor. Delegates all work to an instance of BOMUtility.

Supported API: true

Parameters:

objectID - UFID for a WTPart.

delta - If "true", returns only the changes since the last successful export. Default is "true".

parts - If "true", returns all related parts info regardless the type of part. Default is "false".

alternates - If "true", returns alternate part info, default is "false". Only operative if "Parts" = "true".

substitutes - If "true", returns substitute data

referenceDesignators - If "true", returns Reference Designator data.

lineNumbers - If "true", returns line numbers info, no line numbers info otherwise.

mulitLevel - The number of levels of BOM, default is 1.

documents - If "true", returns associated documents info, default is "false".Only operative if "Parts" = "true".

configSpec - The Config Spec. value to use when navigating the BOM. See the Query-Tree Webject documentation for acceptable and default values.

auth - This parameter contains authentication information from I*E.

wcAdapter - This parameter contains the name of the Windchill adapter.

transactionID - The TransactionID of the ESITransaction that is related to this RPC request.

Returns:

IeCollection

Throws:

WTException

getECN

public IeCollection getECN(String objectID,
                           boolean delta,
                           boolean componentParts,
                           boolean alternates,
                           boolean substitutes,
                           boolean referenceDesignators,
                           boolean lineNumbers,
                           String mulitLevel,
                           boolean documents,
                           String configSpec,
                           String auth,
                           String wcAdapter,
                           String transactionID)
                    throws WTException

getECN RPC processor. Obtains a VdbBuilder from the VdbBuilder factory. Obtains a ChangeOrder2Renderer from the ChangeOrderRenderer factory. Provides the necessary data to the renderer from the arguments to this method. Invokes the render() method on the renderer. Returns the result of VdbBuilder asVDB().

Supported API: true

Parameters:

objectID - The UFID of a WTChangeOrder2.

delta - If true, return only the objects that have changed since the last release of the changeables on the ECN.

componentParts - if true, invoke getPart for each BOM component.

alternates - If true, return the alternate parts for BOMs, parts and component parts.

substitutes - If "true", returns substitute data

referenceDesignators - If "true", returns Reference Designator data.

lineNumbers - If "true", returns line numbers info, no line numbers info otherwise.

mulitLevel - The number of levels of BOM, default is 1.

documents - If "true", returns associated documents info, default is "false".Only operative if "Parts" = "true".

configSpec - The Config Spec. value to use when navigating BOMs. See the Query-Tree Webject documentation for acceptable and default values.

auth - This parameter contains authentication information from I*E.

wcAdapter - This parameter contains the name of the Windchill adapter.

transactionID - The TransactionID for this ObjectID.

Returns:

IeCollection

Throws:

WTException

adjustTargetAssignments

public void adjustTargetAssignments(String ufids,
                                    Group targetInfo)
                             throws WTException

Given a concatenated set of UFIDs (for WTParts) and a Collection of ESITarget UFIDs, make (or remove) any required assignments.

• The ufids argument contains a set of UFIDs which define the parts to operate on.
• The targetInfo argument is an Group. Each element in the group has Atts that:
1. define the ufid of an ESITarget
2. define the operation to perfom on the parts. If the operation is add, then all parts that do not have the target assigned are given the assignment. If the operation is remove, then all existing assignments for that target to any of the existing parts are removed.

Delegates all action to ESITransactionUtility.adjustTargetAssignments(String ufids, Group targetInfo)

Supported API: true

Parameters:

ufids - A concatenated list of UFIDs of the objects to operate on.

targetInfo - A collection of Info*Engine elements containing the UFIDs of the ESITargets to assign/remove and the operation to perform.

Throws:

WTException

getTargetAssociations

public Group getTargetAssociations(String ufids,
                                   String groupName)
                            throws WTException

Given a string of concatenated UFIDs, return the ESITarget objects that are associated with those objects. If the ESITarget is assigned to all of the objects identified by a UFID, indicate that it is a full assignment. Otherwise, indicate that the value is partial.
Delegates all work to ESITargetUtility.getTargetAssociations(String ufids, String groupName).

Supported API: true

Parameters:

ufids - A concatenated list of UFIDs.

groupName - The name of the Info*Engine group to return.

Returns:

Group

Throws:

WTException

getTargetsWithHistory

public Group getTargetsWithHistory(Collection objects)
                            throws WTException

Returns an Info*Engine Group of mapped ESITargetHistory objects. The ESITargetHistory objects contain the following:

• The target attribute of the will be one of the available targets.
• The persistableObject will be one of the objects in the argument to this method.
• If the persistable object has been exported to the target, the releaseAttribute will contain the appropriate ReleaseActivity.

The result is serialized by the ESI mapping routines to a group of Info*Engine Element objects.
All of the work is done by the ESITransactionUtility, which is called by this method.

Supported API: true

Parameters:

objects - The collection of objects of interest.

Returns:

Group

Throws:

WTException

getTargetsWithHistory

public Group getTargetsWithHistory(String ufid)
                            throws WTException

Returns an Info*Engine Group of mapped ESITargetHistory objects. The ESITargetHistory objects contain the following:

• The target attribute of the will be one of the available targets.
• The persistableObject will be one of the objects in the argument to this method.
• If the persistable object has been exported to the target, the releaseAttribute will contain the appropriate ReleaseActivity.

The result is serialized by the ESI mapping routines to a group of Info*Engine Element objects.
All of the work is done by the ESITransactionUtility, which is called by this method.

Supported API: true

Parameters:

ufid - The universal federation ID of the part to obtain.

Returns:

Group

Throws:

WTException

getTargetsWithHistory

public Collection getTargetsWithHistory(Persistable object)
                                 throws WTException

Returns a Collection of ESITargetHistory objects. The ESITargetHistory objects contain the following:

• The target attribute of the will be one of the available targets.
• The persistableObject will be one of the objects in the argument to this method.
• If the persistable object has been exported to the target, the releaseAttribute will contain the appropriate ReleaseActivity.

The result is serialized by the ESI mapping routines to a group of Info*Engine Element objects.
All of the work is done by the ESITransactionUtility, which is called by this method.

Supported API: true

Parameters:

object - The Persistable whose target assignments are to be queried.

Returns:

Collection

Throws:

WTException

getTargets

public WTKeyedMap getTargets(WTCollection objects)
                      throws WTException

Takes a WTCollection of persistables and returns a WTKeyedMap. The return map keyset is the input collection and the values are a WTCollection of ESITarget objects.
All of the work is done by the ESITransactionUtility, which is called by this method. Note that if no ESITarget objects are found for an input it will not be in the return map.

Supported API: true

Parameters:

objects - The Persistable whose target assignments are to be queried.

Returns:

WTKeyedMap

Throws:

WTException

getHistory

public Group getHistory(String ufid,
                        String groupOut)
                 throws WTException

Returns a Group of mapped ReleaseActivity objects associated with the object identied by the argument. This is the functional equivalent of getTargetsWithHistory() for objects that do not have ESITargetAssignmentLinks, but that do have ReleaseActivity associations. The method does the following:

1. Obtains an instance of ESIObjectHistoryRenderer and an instance of ESIObjectHistoryBuilder from the ESIObjectHistoryRendererFactory
2. Invokes the render() method on the renderer
3. Returns the result of builder.getResult()

Supported API: true

Parameters:

ufid - The UFID of the object whose release activities are to be mapped.

groupOut - The name of the Info*Engine group to create when generating output.

Returns:

Group

Throws:

WTException

getActivities

public ReleaseActivity[] getActivities(String ufid)
                                throws WTException

Given the UFID of an ESITransaction, returns an array of all of the ReleaseActivities associated with that ESITransaction. Delegates implementation to ESITransactionUtility.

Supported API: true

Parameters:

ufid - The UFID of the Transaction of interest.

Returns:

ReleaseActivity[]

Throws:

WTException

hideTransaction

public void hideTransaction(String ufid)
                     throws WTException

Hide an ESITransaction from the user interface.

Supported API: true

Parameters:

ufid - The UFID of the transaction to hide.

Throws:

WTException

recordExport

public void recordExport(String objectID,
                         String targetSystem,
                         String releaseClass)
                  throws WTException

RecordExport RPC processor. This method identifies an object as published to an ESITarget.

• Obtains the persistable object from from an instance of TaskHelper using the objectID argument.
• Obtains the target from an instance of ESITargetUtility from the targetSystem.
• Passes the target, the persistable object, and the releaseClass argument to an instance of ESITransactionUtility.

Supported API: true

Parameters:

objectID - The UFID of the object to record the export for.

targetSystem - The system attribute value for the ESITarget where the object was sent.

releaseClass - The type of release activity.

Throws:

WTException

getReleaseActivities

public Group getReleaseActivities(String ufid)
                           throws WTException

Returns an Info*Engine Group of mapped ESI ReleaseActivity objects given the ufid of an ESITransaction object.

Supported API: true

Parameters:

ufid - The universal federation ID of the ESITransaction object.

Returns:

Group

Throws:

WTException

getTransactions

public Group getTransactions(Group elements)
                      throws WTException

Returns an Info*Engine Group of ESITransaction objects that are associated with the objects in the argument. The argument is an Info*Engine Group containing Elements that have been created by (or resemble the output of) a Query-Objects webject. Defers all work to an instance of ESITransactionUtility.

Supported API: true

Parameters:

elements - An Info*Engine Group containing Elements that have been create by (or resemble the output of) a Query-Objects webject.

Returns:

Group

Throws:

WTException

getReleaseActivitiesMessage

public Group getReleaseActivitiesMessage(String ufid)
                                  throws WTException

Return an Info*Engine Group of mapped ReleaseActivityMessage object given the ufid of a ReleaseActivity object.

Supported API: true

Parameters:

ufid - The universal federation ID of the ReleaseActivity object.

Returns:

Group

Throws:

WTException

getTransactionLogMessage

public Group getTransactionLogMessage(String ufid)
                               throws WTException

Returns an Info*Engine Group of mapped ESITransactionMessage object given the ufid of an ESITransaction object.

Supported API: true

Parameters:

ufid - The universal federation ID of the ESITransaction object.

Returns:

Group

Throws:

WTException