Actually I don't think anyone would check-out a primaryBusinessObject. In the case of the Change Workflow, the primaryBusinessObject is either the Change Request or the Change Notice or the Change Task object. So, the isCheckedOut method should not be used in the first place.
However, the primaryBusinessObject (i.e., either the Change Request or Change Notice or the Change Task) could have multiple Affected Objects/Resulting Objects that you can navigate to and check for each of them if anyone is checked out.
The Windchill API has service class methods to get all the affected or resulting items for either a Change Activity or for the affected or resulting items for all the Change Activities for a Change Notice or the affected objects for a Change Request.
So, within the workflow for a Change Object i.e., the primaryBusinessObject is the Change Object itself.
- Within the Change Request workflow, the primaryBusinessObject is the Change Request
- Within Change Notice workflow, the primaryBusinessObject is the Change Notice
- Within the Change Activity workflow, the primaryBusinessObject is the Change Activity
Lets say for example, we are within a Change Activity workflow, and we want the list of all the Affected Objects. Then, within the expression robot (or the OR condition), you would add the code to get a list of all the Affected Objects and then check each of them whether they are checked-out or not. Here's the sample code:
//Comments: Get the list of all the affected objects for the current Change Activity
wt.fc.QueryResult affectedObjectsQR = wt.change2.ChangeHelper2.service.getChangeablesBefore((wt.change2.ChangeActivityIfc) primaryBusinessObject, true);
//Comments: Loop through each affected object and find if its checked out or not ?
while (affectedObjectsQR.hasMoreElements()) {
wt.vc.wip.Workable affectedObject = (wt.vc.wip.Workable) affectedObjectsQR.nextElement();
if(wt.vc.wip.WorkInProgressHelper.isCheckedOut(affectedObject)) {
//Comments: if the affected object is checked out, then take appropriate action - like route it to someone who can fix the problem
result = "FixCheckouts";
break;
//If you have set a routing option in the OR condition called "FixCheckouts", then the flow will navigate through that route.
}
}
Similar API is available for Change Request and Change Notice also.
The affected objects that you get from the QueryResult could be Parts, Document etc.
If you want to check if the affected object is Part or a Document, then you can do additional checks as follows:
if (affectedObject instanceof wt.part.WTPart) {
// Do something useful with the part
}
if (affectedObject instanceof wt.doc.WTDocument) {
// Do something useful with the document
}
You can use additional API's to navigate from the Part to its associated documents or from a Document to its associated documents also. Lets take for example we want to check all the references or referenced by documents from the current document. See the code below:
If you want to check if all the References Documents from the current Document are checked out, then see below:
if (affectedObject instanceof wt.doc.WTDocument) {
//We are casting the affected object to the WTDocument
wt.doc.WTDocument currentDocument = (wt.doc.WTDocument) affectedObject;
// Here you try to get the References Documents
wt.fc.QueryResult referencesDocumentQR = wt.doc.WTDocumentHelper.service.getDependsOnWTDocuments(currentDocument, true);
//Loop through all the References Documents
while (referencesDocumentsQR.hasMoreElements()) {
wt.doc.WTDocument referencesDoc = (wt.doc.WTDocument) referencesDocumentsQR.nextElement();
//Check if the document is checked out
if(wt.vc.wip.WorkInProgressHelper.isCheckedOut((wt.vc.wip.Workable) referencesDoc)) {
//Do something like route it to some other activity so that a user can get a task to do something about it
result = "FixCheckouts";
break;
}
}
}
If you want to check if all the ReferencedBy Documents from the current Document are checked out, then see below:
if (affectedObject instanceof wt.doc.WTDocument) {
//We are casting the affected object to the WTDocument
wt.doc.WTDocument currentDocument = (wt.doc.WTDocument) affectedObject;
// Here you try to get the ReferencedBy Documents
wt.fc.QueryResult referencedByDocumentsQR = wt.doc.WTDocumentHelper.service.getHasDependentWTDocuments(currentDocument, true);
//Loop through all the Referenced By Documents
while (referencedByDocumentsQR.hasMoreElements()) {
wt.doc.WTDocument referencedByDoc = (wt.doc.WTDocument) referencedByDocumentsQR.nextElement();
//Check if the document is checked out
if(wt.vc.wip.WorkInProgressHelper.isCheckedOut((wt.vc.wip.Workable) referencedByDoc)) {
//Do something like route it to some other activity so that a user can get a task to do something about it
result = "FixCheckouts";
break;
}
}
}
Note: I have not checked for the syntactical correctness of the code as I've just typed here but didn't validate the code against an IDE. So, please check if the code syntax is right and the package extensions are provided correctly to all the classes in the code. If not, the workflow editor will complain with errors.
.png "kregimbald"){kind=avatar}
