|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectwt.services.StandardManager
com.ptc.windchill.esi.svc.StandardESIService
public final class StandardESIService
StandardESIService is a concrete implementation of ESIService and ESISvrService.
Use the newStandardESIService static factory method(s),
not the StandardESIService 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.
Supported API: true
Extendable: false
| Method Summary | |
|---|---|
void |
adjustTargetAssignments(String ufids,
com.infoengine.object.factory.Group targetInfo)
Given a concatenated set of UFIDs (for WTParts) and a Collection of ESITarget UFIDs, make (or remove) any required assignments. |
void |
assignTarget(Persistable object,
ESITarget target)
Assign an object to an ESITarget for ESI target system destination determination. |
void |
assignTarget(Persistable object,
com.infoengine.object.factory.Group targets)
Assign an object to an Infoengine group of ESITarget objects for ESI target system destination determination. |
ESITarget |
createTarget(String name,
String description,
String system)
Creates an ESITarget from the arguments and saves the result in the database. |
ESITarget |
createTarget(String name,
String description,
String system,
WTContainerRef containerRef)
Creates and persists an ESITarget. |
void |
deleteTarget(ESITarget tgt)
Deletes an ESITarget from the database. |
Collection |
findESITargets(Persistable anObject)
Returns a collection of ESITargets for the given object. |
ReleaseActivity[] |
getActivities(String ufid)
Given the UFID of an ESITransaction, returns an array of all of the ReleaseActivities associated with that ESITransaction. |
com.infoengine.object.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. |
com.infoengine.object.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. |
com.infoengine.object.factory.Group |
getHistory(String ufid,
String groupOut)
Returns a Group of mapped ReleaseActivity objects associated with the object identied by the argument. |
com.infoengine.object.IeCollection |
getPart(String objectID,
boolean alternates,
boolean documents,
String auth,
String wcAdapter,
String transactionID)
GetPart RPC processor. |
com.infoengine.object.factory.Group |
getReleaseActivities(String ufid)
Returns an Info*Engine Group of mapped ESI ReleaseActivity objects given the ufid of an ESITransaction object. |
com.infoengine.object.factory.Group |
getReleaseActivitiesMessage(String ufid)
Return an Info*Engine Group of mapped ReleaseActivityMessage object given the ufid of a ReleaseActivity object. |
ESITarget |
getTarget(String system)
Return the ESI Target whose system attribute matches the argument. |
com.infoengine.object.factory.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. |
com.infoengine.object.factory.Group |
getTargetsWithHistory(Collection objects)
Returns an Info*Engine Group of mapped ESITargetHistory objects. |
Collection |
getTargetsWithHistory(Persistable object)
Returns a Collection of ESITargetHistory objects. |
com.infoengine.object.factory.Group |
getTargetsWithHistory(String ufid)
Returns an Info*Engine Group of mapped ESITargetHistory objects. |
ESITransaction |
getTransaction(String id)
Return the ESITransaction whose idNumber attribute matches the argument. |
com.infoengine.object.factory.Group |
getTransactionLogMessage(String ufid)
Returns an Info*Engine Group of mapped ESITransactionMessage object given the ufid of an ESITransaction object. |
com.infoengine.object.factory.Group |
getTransactions(com.infoengine.object.factory.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. |
boolean |
isInRelease(Persistable obj)
Returns true if the given releasable object or any releasable iteration for the given master has been published to ERP . |
boolean |
isWfLaunched(wt.lifecycle.LifeCycleManaged anObject)
Check whether there is a workflow process with the status of OPEN_RUNNING for the given object. |
ESITargetAssociation |
latestExport(Persistable object,
ESITarget target)
Find the highest revision of an object that has been exported to an ESI target. |
protected void |
performStartupProcess()
Prepare the Windchill Service to begin operations. |
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. |
void |
removeTargetAssignment(com.infoengine.object.factory.Group ufids)
Deletes from the database the ESITargetAssignmentLink objects that are identified by the argument. |
void |
removeTargetAssignment(Persistable object,
ESITarget target)
Remove the relationship between an ESITarget and a persistable object. |
void |
removeTargetAssignment(String ufid)
Deletes from the database the ESITargetAssignmentLink that is identified by the argument. |
| Methods inherited from class wt.services.StandardManager |
|---|
getManagerService, getManagerStatus, getName, getStartupType |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
protected void performStartupProcess()
throws wt.services.ManagerException
wt.services.ManagerException
public void assignTarget(Persistable object,
com.infoengine.object.factory.Group targets)
throws com.ptc.windchill.esi.tgt.ESITargetAssignmentException,
WTException
assignTarget in interface ESIServiceobject - The object to which the target is being assignedtargets - The Infoengine group of ESITarget objects to be assigned to the object argument.
com.ptc.windchill.esi.tgt.ESITargetAssignmentException
WTException
public void assignTarget(Persistable object,
ESITarget target)
throws com.ptc.windchill.esi.tgt.ESITargetAssignmentException,
WTException
assignTarget in interface ESIServiceobject - The object to which the target is being assignedtarget - The ESITarget to be assigned to the object argument.
com.ptc.windchill.esi.tgt.ESITargetAssignmentException
WTException
public ESITarget createTarget(String name,
String description,
String system)
throws WTException
createTarget in interface ESIServicename - The value to supply to the ESITarget name attribute.description - The value to supply to the ESITarget description attribute.system - The value to supply to the ESITarget ssytem attribute.
WTException
public ESITarget createTarget(String name,
String description,
String system,
WTContainerRef containerRef)
throws WTException
createTarget in interface ESIServicename - The value to supply to the ESITarget name attribute.description - The value to supply to the ESITarget description attribute.system - The value to supply to the ESITarget system attribute.containerRef - The current container ESI target resided.
WTException
public void deleteTarget(ESITarget tgt)
throws WTException
deleteTarget in interface ESIServicetgt - The object to be deleted.
WTException
public Collection findESITargets(Persistable anObject)
throws com.ptc.windchill.esi.utl.ESIException,
WTException
findESITargets in interface ESIServiceanObject - The object whose ESITarget associations are to be found.
com.ptc.windchill.esi.utl.ESIException
WTException
public ESITarget getTarget(String system)
throws WTException
getTarget in interface ESIServicesystem - The value of the ESITarget system attribute.
WTException
public ESITransaction getTransaction(String id)
throws WTException
getTransaction in interface ESIServiceid - The idNumber attribute value for and ESITransaction that is to be fetched.
WTException
public boolean isWfLaunched(wt.lifecycle.LifeCycleManaged anObject)
throws com.ptc.windchill.esi.utl.ESIException,
WTException
isWfLaunched in interface ESIServiceanObject - The object whose workflow status is to be determined.
com.ptc.windchill.esi.utl.ESIException
WTException
public boolean isInRelease(Persistable obj)
throws com.ptc.windchill.esi.utl.ESIException,
WTException
isInRelease in interface ESIServiceobj - The persistable object.
com.ptc.windchill.esi.utl.ESIException
WTException
public void removeTargetAssignment(Persistable object,
ESITarget target)
throws WTException
removeTargetAssignment in interface ESIServiceobject - The object whose target association is to be removed.target - The ESITarget that is no longer to be associated with the persistable object in the object argument.
WTException
public void removeTargetAssignment(String ufid)
throws WTException
removeTargetAssignment in interface ESIServiceufid - The UFID of an ESITargetAssignmentLink that is to be deleted.
WTException
public void removeTargetAssignment(com.infoengine.object.factory.Group ufids)
throws WTException
removeTargetAssignment in interface ESIServiceufids - An Info*Engine group of Element objects. Each element has an Att object that contains the UFID of an ESITargetAssignmentLink that is to be deleted.
WTException
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 in interface ESISvrServiceobjectID - 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 sentmessage - An optional messagetimestamp - 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.
WTException
public ESITargetAssociation latestExport(Persistable object,
ESITarget target)
throws WTException
latestExport in interface ESISvrServiceobject - The persistable whose release history is being interrogated.target - The ESITarget of interest.
WTException
public void postEvent(String objectID,
String transaction,
boolean successful,
String message)
throws WTException
postEvent in interface ESISvrServiceobjectID - 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 successmessage - a message that will be conveyed to the workflow which is waiting for this event.
WTException
public com.infoengine.object.IeCollection getPart(String objectID,
boolean alternates,
boolean documents,
String auth,
String wcAdapter,
String transactionID)
throws WTException
getPart in interface ESISvrServiceobjectID - 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.
WTException
public com.infoengine.object.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 in interface ESISvrServiceobjectID - 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 datareferenceDesignators - 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.
WTException
public com.infoengine.object.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 in interface ESISvrServiceobjectID - 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 datareferenceDesignators - 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.
WTException
public void adjustTargetAssignments(String ufids,
com.infoengine.object.factory.Group targetInfo)
throws WTException
adjustTargetAssignments in interface ESISvrServiceufids - 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.
WTException
public com.infoengine.object.factory.Group getTargetAssociations(String ufids,
String groupName)
throws WTException
getTargetAssociations in interface ESISvrServiceufids - A concatenated list of UFIDs.groupName - The name of the Info*Engine group to return.
WTException
public com.infoengine.object.factory.Group getTargetsWithHistory(Collection objects)
throws WTException
getTargetsWithHistory in interface ESISvrServiceobjects - The collection of objects of interest.
WTException
public com.infoengine.object.factory.Group getTargetsWithHistory(String ufid)
throws WTException
getTargetsWithHistory in interface ESISvrServiceufid - The universal federation ID of the part to obtain.
WTException
public Collection getTargetsWithHistory(Persistable object)
throws WTException
getTargetsWithHistory in interface ESISvrServiceobject - The Persistable whose target assignments are to be queried.
WTException
public WTKeyedMap getTargets(WTCollection objects)
throws WTException
getTargets in interface ESISvrServiceobjects - The Persistable whose target assignments are to be queried.
WTException
public com.infoengine.object.factory.Group getHistory(String ufid,
String groupOut)
throws WTException
getHistory in interface ESISvrServiceufid - 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.
WTException
public ReleaseActivity[] getActivities(String ufid)
throws WTException
getActivities in interface ESISvrServiceufid - The UFID of the Transaction of interest.
WTException
public void hideTransaction(String ufid)
throws WTException
hideTransaction in interface ESISvrServiceufid - The UFID of the transaction to hide.
WTException
public void recordExport(String objectID,
String targetSystem,
String releaseClass)
throws WTException
recordExport in interface ESISvrServiceobjectID - 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.
WTException
public com.infoengine.object.factory.Group getReleaseActivities(String ufid)
throws WTException
getReleaseActivities in interface ESISvrServiceufid - The universal federation ID of the ESITransaction object.
WTException
public com.infoengine.object.factory.Group getTransactions(com.infoengine.object.factory.Group elements)
throws WTException
getTransactions in interface ESISvrServiceelements - An Info*Engine Group containing Elements that have been create by (or resemble the output of) a Query-Objects webject.
WTException
public com.infoengine.object.factory.Group getReleaseActivitiesMessage(String ufid)
throws WTException
getReleaseActivitiesMessage in interface ESISvrServiceufid - The universal federation ID of the ReleaseActivity object.
WTException
public com.infoengine.object.factory.Group getTransactionLogMessage(String ufid)
throws WTException
getTransactionLogMessage in interface ESISvrServiceufid - The universal federation ID of the ESITransaction object.
WTException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||