JadePaginationEnvelopeIF Interface

The JadePaginationEnvelopeIF interface, defined in RootSchema, provides the contract to ensure that an envelope is able to be used. When consuming third‑party REST services, you will need to define a class matching its envelope definition and ensure it implements the JadePaginationEnvelopeIF interface.

The JadePaginationEnvelopeIF interface is used by the JadeRestResponse class parsePaginationEnvelope method to ensure that an envelope is able to be used by Jade to iterate through the pages of results.

For details about implementing the JadePaginationEnvelopeIF interface for a class selected in the Class Browser of your schema, see "Implementing an Interface", in Chapter 14 ("Adding and Maintaining Interfaces"), of the Development Environment User's Guide. See also "REST Services Pagination", in Chapter 11 of the Developer's Reference for usage examples.

The automatically generated stub methods in classes that implement the interface contain no body logic. It is your responsibility to provide the source code that meets your application requirements for each stub method.

For details about the JadePaginationEnvelopeIF interface method, see "JadePaginationEnvelopeIF Method", in the following subsection.

Implemented by:   JadePaginationEnvelope

2022.0.01 and higher