Package com.veeva.vault.sdk.api.document

Interface RenditionReadStructureExecutionRequest

All Known Subinterfaces:

RenditionReadBookmarkExecutionRequest, RenditionReadNamedDestinationExecutionRequest, RenditionReadPageLinkExecutionRequest, RenditionReadPageSizeExecutionRequest

public interface RenditionReadStructureExecutionRequest

Specifies the filters to initiate a request to read rendition structural metadata in a paginated manner.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RenditionReadStructureExecutionRequest.Builder<B extends RenditionReadStructureExecutionRequest.Builder,T extends RenditionReadStructureExecutionRequest>	Builds a RenditionReadStructureExecutionRequest.

Method Summary

Modifier and Type	Method	Description
List<String>	getDocumentVersionIds()	Gets the document version IDs to read the rendition structural metadata for.
int	getPageSize()	The limit of results to include in a page of rendition structural metadata.

Method Details

getDocumentVersionIds

List<String> getDocumentVersionIds()

Gets the document version IDs to read the rendition structural metadata for. In the format documentId_majorVersion_minorVersion, for example, 123_1_0.

Returns:

The document IDs and versions

getPageSize

int getPageSize()

The limit of results to include in a page of rendition structural metadata. Default and maximum depends on the operation.

Returns:

The limit of pages to include in the chunk of pages to read information about