org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common

Class Paging

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.openmetadata.adapters.repositoryservices.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()
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()
Integer	getEndIndex()
static String	getIgcTypeId()
String	getNextPageURL()
Integer	getNumTotal()
Integer	getPageSize()
String	getPreviousPageURL()
Boolean	hasMore() Returns true iff there are more (unretrieved) pages for the paging that this object represents.
void	setBeginIndex(Integer begin)
void	setEndIndex(Integer end)
void	setNextPageURL(String next)
void	setNumTotal(Integer numTotal)
void	setPageSize(Integer pageSize)
void	setPreviousPageURL(String previous)

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

getAllFields, 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()

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

getIgcTypeId

public static String getIgcTypeId()

getNumTotal

public Integer getNumTotal()

See Also:

numTotal

setNumTotal

public void setNumTotal(Integer numTotal)

See Also:

numTotal

getNextPageURL

public String getNextPageURL()

See Also:

next

setNextPageURL

public void setNextPageURL(String next)

See Also:

next

getPreviousPageURL

public String getPreviousPageURL()

See Also:

previous

setPreviousPageURL

public void setPreviousPageURL(String previous)

See Also:

previous

getPageSize

public Integer getPageSize()

See Also:

pageSize

setPageSize

public void setPageSize(Integer pageSize)

See Also:

pageSize

getEndIndex

public Integer getEndIndex()

See Also:

end

setEndIndex

public void setEndIndex(Integer end)

See Also:

end

getBeginIndex

public Integer getBeginIndex()

See Also:

begin

setBeginIndex

public void setBeginIndex(Integer begin)

See Also:

begin

hasMore

public Boolean hasMore()

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

Returns:

Boolean