com.ibm.pim.lookuptable
Interface LookupTable


public interface LookupTable

Interface for LookupTable object

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 LookupTableEntry createEntry()
          Creates a new LookupTableEntry.
 Schedule deleteAsynchronous()
          Schedules the complete LookupTable deletion.
 PIMCollection<LookupTableEntry> getLookupTableEntries()
          Retrieves all the LookupTableEntries for this LookupTable
 LookupTableEntry getLookupTableEntry(java.lang.String key)
          Retrieve a LookupTableEntry identified by the given key
 java.lang.String getName()
          Retrieves the LookupTable name
 LookupSpec getSpec()
          Retrieve the Lookup Spec associated with this LookupTable
 VersionInfo getVersionInfo()
          Retrieves version information for this LookupTable
 void save()
          persists the LookupTable to the database
 

Field Detail

copyright

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

getLookupTableEntries

PIMCollection<LookupTableEntry> getLookupTableEntries()
Retrieves all the LookupTableEntries for this LookupTable

Returns:
an PIMCollection of LookupTableEntries for this LookupTable
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getLookupTableEntry

LookupTableEntry getLookupTableEntry(java.lang.String key)
Retrieve a LookupTableEntry identified by the given key

Parameters:
key - String identifying the required LookupTableEntry
Returns:
the requested LookupTableEntry.Return null if the LookupTable entry with the given key does not exist
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If key is null or if the key is an empty string

getSpec

LookupSpec getSpec()
Retrieve the Lookup Spec associated with this LookupTable

Returns:
The Lookup Spec associated with this LookupTable
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

save

void save()
persists the LookupTable to the database

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

deleteAsynchronous

Schedule deleteAsynchronous()
Schedules the complete LookupTable deletion. The Scheduled Job is run immediately and it's progress can be monitored, via the returned Schedule Object. Please note that subsequent to calling this method the LookupTable object becomes invalid and should be retrieved again after the Scheduled Job has completed.

Returns:
A Job Schedule
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of Permission.CATALOG_DELETE

createEntry

LookupTableEntry createEntry()
Creates a new LookupTableEntry. User has to set the key for this LookupTableEntry by calling com.ibm.pim.attribute method before invoking LookupTableEntry.save() method.

Returns:
the LookupTableEntry object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalStateException - If the Lookup Table has not yet been persisted

getVersionInfo

VersionInfo getVersionInfo()
Retrieves version information for this LookupTable

Returns:
a VersionInfo object representing the LookupTable version
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getName

java.lang.String getName()
Retrieves the LookupTable name

Returns:
the LookupTable name
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use