How to use ITransportable to add a list of objects to the transport case

[Michael A. Lowry]

Can anyone provide an example of how to use the ITransportable interface to add a list of objects to the transport case?

Update 2023.03.27 11:20 CEST: I figured it out. The answer is documented in a comment below.

[Jared Kessans]

Not sure if this is what you are looking for as I am not a Java developer but we had someone write a program to place objects into the transport case. 

	private void doTransport() {
		if (deploymentList != null && !deploymentList.isEmpty()) {
			try {
				if (con == null) {
					createConnection(client.getText(), user.getText(), pass.getText(), dept.getText());
				}
			} catch (IOException e) {
				return;
			}
			try {
				con.sendRequestAndWait(new ClearTransportCase());
				con.sendRequestAndWait(new TransportObject(deploymentList.iterator()));
				print("Transport complete");
			} catch (Exception e) {
				error(e.getMessage());
				throw new RuntimeException(e);
			} finally {
				setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
			}
		} else {
			print("Nothing to transport");
		}
	}

	private void doMove() {
		try {
			if (con == null) {
				createConnection(client.getText(), user.getText(), pass.getText(), dept.getText());
			}
		} catch (IOException e) {
			return;
		}
		setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
		if (moveResultList == null) {
			moveResultList = new ArrayList<ITransportable>();
		}
		try {
			BufferedReader reader = new BufferedReader(new StringReader(topText.getText()));
			String line = null;
			while ((line = reader.readLine()) != null) {
				line = line.trim();
				if (line.equals("")) {
					continue;
				}
				SearchObject so = new SearchObject();
				so.setName(line);
				so.setTypeCALE(true);
				so.setTypeCALL(true);
				so.setTypeCODE(true);
				so.setTypeCONN(true);
				so.setTypeCPIT(true);
				so.setTypeDOCU(true);
				so.setTypeEVNT(true);
				so.setTypeFILTER(true);
				so.setTypeHOSTG(true);
				so.setTypeJOBF(true);
				so.setTypeJOBG(true);
				so.setTypeJOBI(true);
				so.setTypeJOBP(true);
				so.setTypeJOBQ(true);
				so.setTypeJOBS(true);
				so.setTypeJSCH(true);
				so.setTypeLOGIN(true);
				so.setTypePRPT(true);
				so.setTypeQUEUE(true);
				so.setTypeSCRI(true);
				so.setTypeSYNC(true);
				so.setTypeVARA(true);
				so.setTypeXSL(true);
				so.setTypePERIOD(true); // Include "PERIOD" Object
				con.sendRequestAndWait(so);
				if (so.size() == 0) {
					error("No match found for: " + line);
				} else if (so.size() == 1) {
					print("Found: " + line);
					Iterator<SearchResultItem> it = so.resultIterator();
					while (it.hasNext()) {
						moveResultList.add(it.next());
					}
				} else {
					error("Too many matches found for: " + line);
				}
			}
			updateDeploymentList();
		} catch (Exception e) {
			error(e.getMessage());
			throw new RuntimeException(e);
		} finally {
			setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
		}
	}

	private void doTransport() {
		if (deploymentList != null && !deploymentList.isEmpty()) {
			try {
				if (con == null) {
					createConnection(client.getText(), user.getText(), pass.getText(), dept.getText());
				}
			} catch (IOException e) {
				return;
			}
			try {
				con.sendRequestAndWait(new ClearTransportCase());
				con.sendRequestAndWait(new TransportObject(deploymentList.iterator()));
				print("Transport complete");
			} catch (Exception e) {
				error(e.getMessage());
				throw new RuntimeException(e);
			} finally {
				setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
			}
		} else {
			print("Nothing to transport");
		}
	}

	private boolean isTransportableInList(List<ITransportable> list, ITransportable transportable) {
		for (ITransportable it : list) {
			if (it.getName().equals(transportable.getName())) {
				return true;
			}
		}
		return false;
	}

[Michael A. Lowry]

Thanks, @Jared Kessans. That is helpful. Could you please also share the updateDeploymentList() method?

[Jared Kessans]

Hope this helps.  I believe the code provided (above and below) is from an older version of this tool, but I doubt it has been changed much.

	private void updateDeploymentList() {
		if (deploymentList == null) {
			deploymentList = new ArrayList<ITransportable>();
		}
		int dups = 0;
		if (searchResultList != null && !searchResultList.isEmpty()) {
			for (ITransportable it : searchResultList) {
				if (!isTransportableInList(deploymentList, it)) {
					deploymentList.add(it);
				} else {
					++dups;
				}
			}
			searchResultList.clear();
			finalizeBtn.setEnabled(true);
		}
		if (moveResultList != null && !moveResultList.isEmpty()) {
			for (ITransportable it : moveResultList) {
				if (!isTransportableInList(deploymentList, it)) {
					deploymentList.add(it);
				} else {
					++dups;
				}
			}
			moveResultList.clear();
			finalizeBtn.setEnabled(true);
		}
		if (dups > 0) {
			error(dups + " duplicate(s) not added to list");
		}
		model.clear();
		int listSize = 0;
		for (ITransportable it : deploymentList) {
			model.addElement(it.getName() + "\n");
			++listSize;
		}
		labelMiddle.setText(labelTextPt1 + listSize + labelTextPt2);
	}

[Michael A. Lowry]

I figured out how it works. The 1st constructor of TransportObject is intended to cover most of the situations in which multiple objects must be added to the transport case at the same time.

public TransportObject(java.util.Iterator<? extends ITransportable> it)

This constructor takes a single argument: an Iterator over any class that implements ITransportable.

Two classes implement ITransportable: FolderListItem and SearchResultItem. The APIs include two methods that return Iterators over these classes.

ITransportable subclass	Method that returns Iterator over this class
FolderListItem	FolderListItem.iterator()
SearchResultItem	SearchObject.resultIterator()

When constructing TransportObject, you can pass either a folder listing or a set of search results as the argument. An example of each approach is shown below.

Add folder listing to transport case

public static void addFolderObjectsToTransportCase(Connection aeConnection, String folderPath) throws IOException {
    FolderTree folderTree = new FolderTree();
    aeConnection.sendRequestAndWait(folderTree);
    IFolder iFolder = folderTree.getFolder(folderPath);
    FolderList folderList = new FolderList(iFolder,false);
    Integer numSearchResults = folderList.size();
    System.out.println(String.format("Adding %s objects to transport case.",numSearchResults));
    TransportObject transportObject = new TransportObject(folderList.iterator());
    aeConnection.sendRequestAndWait(transportObject);
}

Add search results to transport case

public static void addAllLoginObjectsToTransportCase(Connection aeConnection) throws IOException {
    SearchObject searchObject = new SearchObject();
    searchObject.setTypeLOGIN(true);
    searchObject.setSearchLocation("/", true);
    searchObject.setIncludeLinks(false);
    searchObject.setNoDateSelection();
    aeConnection.sendRequestAndWait(searchObject);
    Integer numSearchResults = searchObject.size();
    System.out.println(String.format("Adding %s objects to transport case.",numSearchResults));
    TransportObject transportObject = new TransportObject(searchObject.resultIterator());
    aeConnection.sendRequestAndWait(transportObject);
}