IThingIDList (server-common-api)

```
public interface IThingIDList
```
List of Thing IDs. Based on List. A set of convenience functions and operations on lists.

See Also:

IThingID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IThingIDList`	`add(IThingID thingID)` Add an IThingID to the list.
`IThingIDList`	`add(IThingID[] thingIDs)` Add an array of IThingIDs to the list.
`IThingIDList`	`add(IThingIDList list)` Add another IThingIDList to the list.
`boolean`	`contains(IThingID thingID)` Check to see if the list contains a particular IThingID.
`boolean`	`equals(Object o)` Check to see whether list values match values in Object.
`IThingID`	`getBaseThingID()` Get the base Thing ID for the list.
`int`	`getEndIndex()` Get end index of list.
`List<IThingID>`	`getList()` Get the list of IThingIDs.
`int`	`getStartIndex()` Get start index of list.
`IThingID`	`getThingID(int index)` Shortcut for getting item.
`String`	`getThingString()` Get the list as a string of id's, useful for passing to the database.
`boolean`	`hasQuery()` Check to see whether setQuery has been called.
`void`	`merge(IThingIDList otherList)` This will merge all of the unique items in the other list into the current list.
`void`	`query(int startIndex, int endIndex)` Execute a query that has been associated with this list.
`void`	`remove(IThingID thingID)` Remove a particular ID from the list.
`void`	`remove(IThingIDList thingIDList)` Removes a list of items from the list.
`void`	`setBaseThingID(IThingID baseThingID)` Set this list's base Thing ID.
`void`	`setIndexes(int startIndex, int endIndex)` Set the list's start and end indexes.
`void`	`setQuery(Object[] params, String sp, IMetaContext mc)` Set up a query.
`int`	`size()` Return the number of items in the list.
`IThingIDList`	`subList(int start, int end)` Returns sublist of this list starting from start to end index.
`IThingID[]`	`toArray()` Get the list as an array of IThingIDs.

- Method Detail
  - getList
```
List<IThingID> getList()
```
    Get the list of IThingIDs.
    
    Returns:
    
    List of IThingIDs.
  - size
```
int size()
```
    Return the number of items in the list.
    
    Returns:
    
    Number of items in the list.
  - subList
```
IThingIDList subList(int start,
                     int end)
```
    Returns sublist of this list starting from start to end index. 0, -1 will return full list
    
    Parameters:
    
    start -
    
    end -
    
    Returns:
  - getThingID
```
IThingID getThingID(int index)
```
    Shortcut for getting item.
    
    Parameters:
    
    index - Index of item to retrieve from list.
    
    Returns:
    
    IThingID from list.
  - add
```
IThingIDList add(IThingID thingID)
```
    Add an IThingID to the list.
    
    Parameters:
    
    thingID - IThingID to add to list.
    
    Returns:
    
    IThingIDList including added IThingID.
  - add
```
IThingIDList add(IThingID[] thingIDs)
```
    Add an array of IThingIDs to the list.
    
    Parameters:
    
    thingIDs - Array of IThingIDs.
    
    Returns:
    
    IThingIDList including newly added IThingIDs.
  - add
```
IThingIDList add(IThingIDList list)
```
    Add another IThingIDList to the list.
    
    Parameters:
    
    list - IThingIDList to add to the list.
    
    Returns:
    
    IThingIDList including newly added IThingIDs.
  - contains
```
boolean contains(IThingID thingID)
```
    Check to see if the list contains a particular IThingID. Note: This may create an internal hash set for performance reasons.
    
    Parameters:
    
    thingID - IThingID to check list for.
    
    Returns:
    
    True if the list contains this IThingID, False if it does not.
  - getStartIndex
```
int getStartIndex()
```
    Get start index of list.
    
    Returns:
    
    start index
  - getEndIndex
```
int getEndIndex()
```
    Get end index of list.
    
    Returns:
    
    end index
  - setIndexes
```
void setIndexes(int startIndex,
                int endIndex)
```
    Set the list's start and end indexes.
    
    Parameters:
    
    startIndex - The start index for the list.
    
    endIndex - The end index for the list.
  - getThingString
```
String getThingString()
```
    Get the list as a string of id's, useful for passing to the database.
    
    Returns:
    
    String of IDs. For example: " 232400000025620000001234000000".
  - remove
```
void remove(IThingID thingID)
```
    Remove a particular ID from the list.
    
    Parameters:
    
    thingID - IThingID to remove from the list.
  - remove
```
void remove(IThingIDList thingIDList)
```
    Removes a list of items from the list.
    
    Parameters:
    
    thingIDList - List of items to remove from the list.
  - query
```
void query(int startIndex,
           int endIndex)
    throws MetaException
```
    Execute a query that has been associated with this list.
    
    Parameters:
    
    startIndex - Index of first item in list to use with query.
    
    endIndex - Index of last item in list to use with query.
    
    Throws:
    
    MetaException - if the stored query fails.
    
    See Also:
    
    com.webmethods.portal.service.meta2.util.ResultSetUtil#basicPagedThingList
  - hasQuery
```
boolean hasQuery()
```
    Check to see whether setQuery has been called.
    
    Returns:
    
    True if setQuery has been called, False if it has not.
  - setQuery
```
void setQuery(Object[] params,
              String sp,
              IMetaContext mc)
```
    Set up a query.
    
    Parameters:
    
    params - Parameters to pass to stored procedure.
    
    sp - Stored procedure to call. SP must have correct result set.
    
    mc - IMetaContext within which to execute this query (defines datasource).
    
    See Also:
    
    com.webmethods.portal.service.meta2.util.ResultSetUtil#basicPagedThingList
  - getBaseThingID
```
IThingID getBaseThingID()
```
    Get the base Thing ID for the list. Useful for certain lists, but usually is null. Is NOT considered for .equals() evaluations.
    
    Returns:
    
    Base Thing ID for the list.
  - setBaseThingID
```
void setBaseThingID(IThingID baseThingID)
```
    Set this list's base Thing ID.
    
    Parameters:
    
    baseThingID - IThingID to set as list's base Thing ID.
  - equals
```
boolean equals(Object o)
```
    Check to see whether list values match values in Object. Object must be an instance of IThingIDList. Only compares values in the lists in order. Does NOT compare base Thing ID or query parameters.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - Object to compare list to.
    
    Returns:
    
    True if values in Object are identical to values in list.
  - merge
```
void merge(IThingIDList otherList)
```
    This will merge all of the unique items in the other list into the current list.
    
    Parameters:
    
    otherList - IThingIDList of items to merge into list.
  - toArray
```
IThingID[] toArray()
```
    Get the list as an array of IThingIDs.
    
    Returns:
    
    Array of IThingIDs from list.

Interface IThingIDList

Method Summary

Method Detail

getList

size

subList

getThingID

add

add

add

contains

getStartIndex

getEndIndex

setIndexes

getThingString

remove

remove

query

hasQuery

setQuery

getBaseThingID

setBaseThingID

equals

merge

toArray