How to search DocumentPackage by attribute?

romainlefebvre | Posts: 5

How to search DocumentPackage by attribute?

Tuesday, May 10, 2016 at 05:39am

Hi, I want to create empty packages with DRAFT status and one custom attribute (i.e internalID).

DocumentPackage documentPackage = newPackageNamed("TEST_PACKAGE")
                       .withAttributes(newDocumentPackageAttributes()
     	               .withAttribute("internalID", "123456" )
     	               .build())
.build();

PackageId packageId = eslClient.createPackage(documentPackage);

Then, how can I do a search of the DRAFT packages with specific attribute 'internalID' ?

Page resultPage = eslClient.getPackageService().getPackages(new PackageStatusConverter(PackageStatus.DRAFT).toAPIPackageStatus(), new PageRequest(1));

Thanks

May 10 Created

January 21 Last Updated

9 years ago Last Reply

1 Replies

25 Views

2 Users

0 Likes

0 Links

Answered by harishaidary

Approved Answer

harishaidary | Posts: 1812

Reply to: How to search DocumentPackage by attribute?

Tuesday, May 10, 2016 at 08:04am

Hey Romain, What you will probably end up doing is going through your packages in draft and retrieve the attributes. Here's an example code on how to do so:

int i = 1;

Page resultPage = client.getPackageService().getPackages(new PackageStatusConverter(PackageStatus.DRAFT).toAPIPackageStatus(), new PageRequest(i, 50));
		
while (resultPage.getNumberOfElements() != 0) {
          for (DocumentPackage pack : resultPage) {
	  System.out.println(pack.getName());
          DocumentPackageAttributes attributes = pack.getAttributes();
	  Map attr = attributes.getContents();

	  for (Map.Entry entry : attr.entrySet()) {
                    System.out.println(entry.getKey() + ", " + entry.getValue());
	    }
            i++;
          }
          resultPage = client.getPackageService().getPackages(new PackageStatusConverter(PackageStatus.DRAFT).toAPIPackageStatus(), new PageRequest(i, 50));
}

Here, I used a variable "i" to keep track of the package index in the resulting page. Also, the maximum number of packages you can retrieve per page is 50. Having said this, this is an exhaustive method of searching your package attributes. This should be alright for a relatively small number of packages, but as you create more and more packages overtime, I wouldn't suggest this method. You would be better off keeping track of your attributes within your application and associate them with the package id that eSignLive returns you.