org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common

Class Paging

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Paging

public class Paging
extends ObjectPrinter

Represents the metadata related to a page of results or relationships.

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	begin Specifies the numeric index at which this page of results starts.
protected Integer	end Specifies the numeric index at which this page of results ends.
protected String	next Specifies the URL to the next page of results, within a given IGC environment.
protected Integer	numTotal Specifies the total number of items that exist across all pages.
protected Integer	pageSize Specifies the number of results within each page.
protected String	previous Specifies the URL to the previous page of results, within a given IGC environment.

Constructor Summary

Constructors

Constructor and Description
Paging() Default constructor sets up defaults for an empty paging object.
Paging(Integer numTotal) Creates a new "full" Paging object (without any previous or next pages).

Method Summary

Modifier and Type	Method and Description
Integer	getBeginIndex() Retrieve the numeric index representing the first item in this page.
Integer	getEndIndex() Retrieve the numeric index representing the last item in this page.
String	getNextPageURL() Retrieve the URL for the next page of results, or null if there are no more pages.
Integer	getNumTotal() Retrieve the total number of items across all pages.
Integer	getPageSize() Retrieve the number of items included in each page.
String	getPreviousPageURL() Retrieve the URL for the previous page of results, or null if there is no previous page.
Boolean	hasMore() Returns true iff there are more (unretrieved) pages for the paging that this object represents.
void	setBeginIndex(Integer begin) Set the numeric index representing the first item in this page.
void	setEndIndex(Integer end) Set the numeric index representing the last item in this page.
void	setNextPageURL(String next) Set the URL for the next page of results, or null if there are no more pages.
void	setNumTotal(Integer numTotal) Set the total number of items across all pages.
void	setPageSize(Integer pageSize) Set the number of items included in each page.
void	setPreviousPageURL(String previous) Set the URL for the previous page of results, or null if there is no previous page.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

numTotal

protected Integer numTotal

Specifies the total number of items that exist across all pages.

next

protected String next

Specifies the URL to the next page of results, within a given IGC environment. If there is no next page of results, this will be null.

(In other words: if this is null, you are on the last page of results.)

previous

protected String previous

Specifies the URL to the previous page of results, within a given IGC environment. If there is no previous page of results, this will be null.

(In other words: if this is null, you are on the first page of results.)

pageSize

protected Integer pageSize

Specifies the number of results within each page.

end

protected Integer end

Specifies the numeric index at which this page of results ends.

begin

protected Integer begin

Specifies the numeric index at which this page of results starts.

Constructor Detail

Paging

public Paging()

Default constructor sets up defaults for an empty paging object.

Paging

public Paging(Integer numTotal)

Creates a new "full" Paging object (without any previous or next pages).

Parameters:

numTotal - total number of objects that this "page" represents containing

Method Detail

getNumTotal

public Integer getNumTotal()

Retrieve the total number of items across all pages.

Returns:

Integer

setNumTotal

public void setNumTotal(Integer numTotal)

Set the total number of items across all pages.

Parameters:

numTotal - of items across all pages

getNextPageURL

public String getNextPageURL()

Retrieve the URL for the next page of results, or null if there are no more pages.

Returns:

String

setNextPageURL

public void setNextPageURL(String next)

Set the URL for the next page of results, or null if there are no more pages.

Parameters:

next - URL for the next page of results

getPreviousPageURL

public String getPreviousPageURL()

Retrieve the URL for the previous page of results, or null if there is no previous page.

Returns:

String

setPreviousPageURL

public void setPreviousPageURL(String previous)

Set the URL for the previous page of results, or null if there is no previous page.

Parameters:

previous - URL for the previous page of results

getPageSize

public Integer getPageSize()

Retrieve the number of items included in each page.

Returns:

Integer

setPageSize

public void setPageSize(Integer pageSize)

Set the number of items included in each page.

Parameters:

pageSize - number of items included in each page

getEndIndex

public Integer getEndIndex()

Retrieve the numeric index representing the last item in this page.

Returns:

Integer

setEndIndex

public void setEndIndex(Integer end)

Set the numeric index representing the last item in this page.

Parameters:

end - numeric index of last item in this page

getBeginIndex

public Integer getBeginIndex()

Retrieve the numeric index representing the first item in this page.

Returns:

Integer

setBeginIndex

public void setBeginIndex(Integer begin)

Set the numeric index representing the first item in this page.

Parameters:

begin - numeric index of first item in this page

hasMore

public Boolean hasMore()

Returns true iff there are more (unretrieved) pages for the paging that this object represents.

Returns:

Boolean