public class SortDescriptionList
extends java.lang.Object
implements java.io.Serializable
Constructor and Description |
---|
SortDescriptionList() |
Modifier and Type | Method and Description |
---|---|
void |
addSortDescription(int index,
SortDescription vSortDescription) |
void |
addSortDescription(SortDescription vSortDescription) |
java.util.Enumeration<? extends SortDescription> |
enumerateSortDescription()
Method enumerateSortDescription.
|
SortDescription[] |
getSortDescription()
Method getSortDescription.Returns the contents of the
collection in an Array.
|
SortDescription |
getSortDescription(int index)
Method getSortDescription.
|
int |
getSortDescriptionCount()
Method getSortDescriptionCount.
|
java.util.Iterator<? extends SortDescription> |
iterateSortDescription()
Method iterateSortDescription.
|
void |
removeAllSortDescription() |
boolean |
removeSortDescription(SortDescription vSortDescription)
Method removeSortDescription.
|
SortDescription |
removeSortDescriptionAt(int index)
Method removeSortDescriptionAt.
|
void |
setSortDescription(int index,
SortDescription vSortDescription) |
void |
setSortDescription(SortDescription[] vSortDescriptionArray) |
public void addSortDescription(SortDescription vSortDescription) throws java.lang.IndexOutOfBoundsException
vSortDescription
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addSortDescription(int index, SortDescription vSortDescription) throws java.lang.IndexOutOfBoundsException
index
- vSortDescription
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends SortDescription> enumerateSortDescription()
public SortDescription getSortDescription(int index) throws java.lang.IndexOutOfBoundsException
index
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic SortDescription[] getSortDescription()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public int getSortDescriptionCount()
public java.util.Iterator<? extends SortDescription> iterateSortDescription()
public void removeAllSortDescription()
public boolean removeSortDescription(SortDescription vSortDescription)
vSortDescription
- public SortDescription removeSortDescriptionAt(int index)
index
- public void setSortDescription(int index, SortDescription vSortDescription) throws java.lang.IndexOutOfBoundsException
index
- vSortDescription
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setSortDescription(SortDescription[] vSortDescriptionArray)
vSortDescriptionArray
-