com.ibm.pim.lookuptable
Interface LookupTableManager

All Superinterfaces:
Manager

public interface LookupTableManager
extends Manager

Interface for the Manager of LookupTable objects

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 LookupTable createLookupTable(LookupSpec spec, java.lang.String name)
          Returns a new lookup table with the given spec and name
 LookupTable getLookupTable(java.lang.String lookupTableName)
          Retrieves the latest version of specific LookupTable by name.
 LookupTable getLookupTable(java.lang.String lookupTableName, VersionInfo version)
          Retrieves a particular version of a specified LookupTable
 java.util.Collection<LookupTable> getLookupTables()
          Retrieves all LookupTables available in the current context
 java.util.List<VersionInfo> getVersionInfo(java.lang.String lookupTableName)
          Retrieves all Version Information for a LookupTable
 VersionInfo getVersionInfo(java.lang.String lookupTableName, java.lang.String versionName)
          Retrieves Version Information for a particular version of a LookupTable
 
Methods inherited from interface com.ibm.pim.common.Manager
getManagerName
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

createLookupTable

LookupTable createLookupTable(LookupSpec spec,
                              java.lang.String name)
Returns a new lookup table with the given spec and name

Parameters:
spec - The spec for the new lookup table
name - The name to be given to the new lookup table
Returns:
A LookupTable object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If spec is null or name is null or if the name is an empty string
java.lang.IllegalStateException - If the spec has not been persisted

getLookupTables

java.util.Collection<LookupTable> getLookupTables()
Retrieves all LookupTables available in the current context

Returns:
A Collection of LookupTables.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getLookupTable

LookupTable getLookupTable(java.lang.String lookupTableName)
Retrieves the latest version of specific LookupTable by name.

Parameters:
lookupTableName - The name of the LookupTable to be retrieved
Returns:
The LookupTable matching that name. Return null if the LookupTable with the given name does not exist
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If lookupTableName is null or if the lookupTableName is an empty string

getLookupTable

LookupTable getLookupTable(java.lang.String lookupTableName,
                           VersionInfo version)
Retrieves a particular version of a specified LookupTable

Parameters:
lookupTableName - The name of the LookupTable
version - The version info object representing the LookupTable to be retrieved
Returns:
The LookupTable matching that name.Return null if the LookupTable with the given name and version does not exist
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If lookupTableName is null or if the lookupTableName is an empty string or if version is null

getVersionInfo

java.util.List<VersionInfo> getVersionInfo(java.lang.String lookupTableName)
Retrieves all Version Information for a LookupTable

Parameters:
lookupTableName - The name of the LookupTable
Returns:
A list of VersionInfo objects. Return an empty List if the LookupTable with the given name does not exist
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If lookupTableName is null or if the lookupTableName is an empty string

getVersionInfo

VersionInfo getVersionInfo(java.lang.String lookupTableName,
                           java.lang.String versionName)
Retrieves Version Information for a particular version of a LookupTable

Parameters:
lookupTableName - The name of the LookupTable
versionName - the version of the LookupTable as a String
Returns:
A VersionInfo object for this LookupTable. Return null ,if the LookupTable with the given name does not exist or if the version with the given name does not exist for the LookupTable
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If lookupTableName is null or if the lookupTableName is an empty string or if versionName is null or if the versionName is an empty string