|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.repository.QueryOptions
public class QueryOptions
A bean class to holding properties that specify ways that a query may be modified:
atg.targeting.SortDirectives
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Constructor Summary | |
---|---|
QueryOptions(int pStartingIndex,
int pEndingIndex,
int pNthIndex,
SortDirectives pSortDirectives,
java.lang.String[] pPrecachedPropertyNames)
|
|
QueryOptions(int pStartingIndex,
int pEndingIndex,
SortDirectives pSortDirectives,
java.lang.String[] pPrecachedPropertyNames)
|
Method Summary | |
---|---|
void |
addPrecachedPropertyName(java.lang.String pPrecachedPropertyName)
Adds a property name to the property PrecachedPropertyNames. |
java.lang.Object |
clone()
Cloneable by all... |
boolean |
getDoNotCacheQuery()
|
int |
getEndingIndex()
Returns property EndingIndex |
boolean |
getIgnoreDuplicates()
|
int |
getNthIndex()
Returns property NthIndex |
java.lang.String[] |
getPrecachedPropertyNames()
Returns property PrecachedPropertyNames |
SortDirectives |
getSortDirectives()
Returns property SortDirectives |
int |
getStartingIndex()
Returns property StartingIndex. |
boolean |
getUncachedItems()
|
boolean |
isUncachedItemsSet()
Returns true if the UncachedItems was explicitly set on this QueryOptions. |
void |
setDoNotCacheQuery(boolean pDoNotCacheQuery)
Sets the property DoNotCacheQuery. |
void |
setEndingIndex(int pEndingIndex)
Sets property EndingIndex. |
void |
setIgnoreDuplicates(boolean pIgnoreDuplicates)
Sets the property IgnoreDuplicates. |
void |
setNthIndex(int pNthIndex)
Sets property SizeOf Range. |
void |
setPrecachedPropertyNames(java.lang.String[] pPrecachedPropertyNames)
Sets property PrecachedPropertyNames. |
void |
setSortDirectives(SortDirectives pSortDirectives)
Sets property SortDirectives |
void |
setStartingIndex(int pStartingIndex)
Sets property StartingIndex |
void |
setUncachedItems(boolean pUncachedItems)
Sets the property UncachedItems. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public QueryOptions(int pStartingIndex, int pEndingIndex, SortDirectives pSortDirectives, java.lang.String[] pPrecachedPropertyNames)
public QueryOptions(int pStartingIndex, int pEndingIndex, int pNthIndex, SortDirectives pSortDirectives, java.lang.String[] pPrecachedPropertyNames)
Method Detail |
---|
public void setStartingIndex(int pStartingIndex)
public int getStartingIndex()
public void setEndingIndex(int pEndingIndex)
The item at the endingIndex element of the array is not returned. In other words, the total number of items returned is endingIndex - startIndex.
public int getEndingIndex()
public void setNthIndex(int pNthIndex)
public int getNthIndex()
public void setSortDirectives(SortDirectives pSortDirectives)
public SortDirectives getSortDirectives()
public void addPrecachedPropertyName(java.lang.String pPrecachedPropertyName)
This function will detect and not add repeats
public void setPrecachedPropertyNames(java.lang.String[] pPrecachedPropertyNames)
public java.lang.String[] getPrecachedPropertyNames()
public void setUncachedItems(boolean pUncachedItems)
pUncachedItems
- new value to setpublic boolean getUncachedItems()
public boolean isUncachedItemsSet()
public void setDoNotCacheQuery(boolean pDoNotCacheQuery)
pDoNotCacheQuery
- new value to setpublic boolean getDoNotCacheQuery()
public void setIgnoreDuplicates(boolean pIgnoreDuplicates)
pIgnoreDuplicates
- new value to setpublic boolean getIgnoreDuplicates()
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |