public class NodePageSpecification extends ServiceDataObject implements Serializable
Constructor and Description |
---|
NodePageSpecification() |
Modifier and Type | Method and Description |
---|---|
boolean |
getContainersOnly()
Gets whether only containers should be returned.
|
String[] |
getExcludeTypes()
Gets a list of node types to exclude from the results.
|
String |
getExcludeTypes(int index)
Gets the value at the specified index in the ExcludeTypes array.
|
boolean |
getIncludeHiddenNodes()
Gets whether hidden nodes should be returned.
|
String[] |
getIncludeTypes()
Gets a list of node types to filter the results on.
|
String |
getIncludeTypes(int index)
Gets the value at the specified index in the IncludeTypes array.
|
String |
getNameFilter()
Gets a partial name to filter results against.
|
String |
getPageContext()
Gets the state token from prior call's NodePageResult.
|
int |
getPageNumber()
Gets the page number requested.
|
int |
getPageSize()
Gets the number of items per page.
|
String |
getTypeFilter()
Gets the name of a type to use for filtering the results.
|
void |
load(com.opentext.api.LLValue value)
Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
|
void |
setContainersOnly(boolean value)
Sets whether only containers should be returned.
|
void |
setExcludeTypes(int index,
String value)
Sets the value at the specified index in the fExcludeTypes array.
|
void |
setExcludeTypes(String[] value)
Sets a list of node types to exclude from the results.
|
void |
setIncludeHiddenNodes(boolean value)
Sets whether hidden nodes should be returned.
|
void |
setIncludeTypes(int index,
String value)
Sets the value at the specified index in the fIncludeTypes array.
|
void |
setIncludeTypes(String[] value)
Sets a list of node types to filter the results on.
|
void |
setNameFilter(String value)
Sets a partial name to filter results against.
|
void |
setPageContext(String value)
Sets the state token from prior call's NodePageResult.
|
void |
setPageNumber(int value)
Sets the page number requested.
|
void |
setPageSize(int value)
Sets the number of items per page.
|
void |
setTypeFilter(String value)
Sets the name of a type to use for filtering the results.
|
com.opentext.api.LLValue |
toLLValue()
Serialize an SDO object to an LLValue that can be sent to Livelink.
|
String |
toString()
Returns a string representation of the object consisting of the object name
and any features and their values within square brackets.
|
public void setContainersOnly(boolean value)
public boolean getContainersOnly()
public void setExcludeTypes(String[] value)
public String[] getExcludeTypes()
public void setExcludeTypes(int index, String value)
public String getExcludeTypes(int index)
public void setIncludeHiddenNodes(boolean value)
public boolean getIncludeHiddenNodes()
public void setIncludeTypes(String[] value)
public String[] getIncludeTypes()
public void setIncludeTypes(int index, String value)
public String getIncludeTypes(int index)
public void setNameFilter(String value)
public String getNameFilter()
public void setPageContext(String value)
public String getPageContext()
public void setPageNumber(int value)
public int getPageNumber()
public void setPageSize(int value)
public int getPageSize()
public void setTypeFilter(String value)
public String getTypeFilter()
public void load(com.opentext.api.LLValue value)
IServiceDataObject
load
in interface IServiceDataObject
load
in class ServiceDataObject
value
- the LLValue containing the data to be loadedpublic com.opentext.api.LLValue toLLValue()
IServiceDataObject
toLLValue
in interface IServiceDataObject
toLLValue
in class ServiceDataObject
public String toString()
ServiceDataObject
toString
in class ServiceDataObject
© Copyright 2017 OpenText Corp. All Rights Reserved.