atg.repository.loader
Interface ResultList


public interface ResultList

A JavaBean interface that represents an aggregation of the Job's known Results, collected from each completed Batch.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Method Summary
 java.util.List getElements()
          Returns a List of Result objects
 java.lang.String[] getItemIds()
          Returns the array of items ids contained in the batch.
 Job getJob()
          Returns the Job containing this object
 int getSize()
          Returns number of Results in this list
 java.lang.String[] getSourcePaths()
          Returns the array of file paths from which the items are derived.
 java.lang.String idForPath(java.lang.String pPath)
          Returns the string id of the item derived from the provided file path.
 java.lang.String pathForId(java.lang.String pId, java.lang.String pItemDescriptorName)
          Returns the path of the file from which the specified item was derived.
 

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values
Method Detail

getJob

Job getJob()
Returns the Job containing this object


getElements

java.util.List getElements()
Returns a List of Result objects


getSize

int getSize()
Returns number of Results in this list


getItemIds

java.lang.String[] getItemIds()
Returns the array of items ids contained in the batch.


getSourcePaths

java.lang.String[] getSourcePaths()
Returns the array of file paths from which the items are derived.


pathForId

java.lang.String pathForId(java.lang.String pId,
                           java.lang.String pItemDescriptorName)
Returns the path of the file from which the specified item was derived.

Parameters:
pId - the repository id of the item
pItemDescriptorName - the name of the item's descriptor

idForPath

java.lang.String idForPath(java.lang.String pPath)
Returns the string id of the item derived from the provided file path.