bhmCancelCheckOutOperation API

Use the following API to cancel the checkout of a model saved in Teamcenter.

List<BHMOperationOutput> bhmCancelCheckOutOperation (List<String> dataCancelCheckOutInputXML,  String toolType)

Inputs

• dataCancelCheckOutInputXML — Specifies a list of input strings with information about the models whose checkout must be canceled. These strings are based on the BHMOperationsSchema.xsd file. You can generate the xml string using the JAXB utility available with the BHMOperationData and BHMDesign classes in the com.teamcenter.behaviormodeling.common.xml package.
• toolType — Specifies the behavior modeling tool, for example, MATLAB.

In your Java code, you must specify the following:

• In the BHMOperations element, specify the values for rootModelFolder and rootModelIdentifier.
• In the Model element: specify the values for modelName and modelIdentifier, and specify the value of tcuid for an existing model.
• In the ReservationOperationOptions element, specify the value for BackUpExistingModel. This value backs up the model before the checkout is canceled.

Output

The output is a list of BHMOperationOutput objects (com.teamcenter.behaviormodeling.common package). Each object corresponds to one of the input XML strings sent through dataCancelCheckOutInputXML.

BHMOperationOutput variable	Description
OperationStatus	Returns one of: OPERATION_FAILED, OPERATION_WARNING, OPERATION_SUCCESSFUL, OPERATION_SUCCESSFUL_WITH_INFO
message	Specifies the cause of the API failure.
inputXML	Specifies the input XML string based on BHMOperationsSchema.xsd.
rootModelName	Specifies the root model to be saved.
rootModelIdentifier	Specifies the identifier of the root model.
rootModelFullFilePath	Specifies the full path of the root model.
backUpDirectory	Specifies the directory to back up the model before canceling the checkout.

Example

To cancel a checkout, you can pass the following string through the dataCancelCheckOutInputXML list of the bhmCancelCheckOutOperation API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BHMOperations rootModelFolder="D:\staging_11\M11_000260_A\M112"
rootModelIdentifier="M11"
xmlns="http://www.plmxml.org/Schemas/bhm">
  <modelInfo applicationName="MATLAB">
    <Model modelName="M11" modelIdentifier="M11" tcuid="g_Zhgh35IvwBJA">
	  <Attributes/>
	  <Contents>
		<ModelElements/>
	  </Contents>
	</Model>
  </modelInfo>
  <options>
    <reservationOperationOptions backUpExistingModel="true"/>
  </options>
</BHMOperations>