Skip navigation links


Thor.API.Operations
Interface tcLookupOperationsIntf

All Superinterfaces:
tcUtilityOperationsIntf

public interface tcLookupOperationsIntf
extends tcUtilityOperationsIntf

Method Summary
 void addLookupCode(java.lang.String psLookupCode)
          Adds a new lookup code
 void addLookupValue(java.lang.String psLookupCode, java.lang.String psValue, java.lang.String psDescriptiveValue, java.lang.String psLanguage, java.lang.String psCountry)
          Adds a new entry for the specified lookup
 Thor.API.tcResultSet findAvailableLookups(java.util.Map phAttributeList)
          Returns a collection of available Lookups
 Thor.API.tcResultSet getContextAgnosticLookupValuesForColumn(java.lang.String psColumnCode)
           
 java.lang.String getDecodedValueForColumnEncodedValue(java.lang.String strEncodeVal, java.lang.String userRole)
          For given encoded coloumn value ,return decoded value
 java.lang.String getDecodedValueForEncodedValue(java.lang.String lookupCode, java.lang.String strEncodeVal)
          For given encoded value and lookup code,return the decoded value.
 java.lang.String getLookupCodeForColumn(java.lang.String psColumnCode)
          Gets the lookup code of the lookup assigned to the specified column/field
 Thor.API.tcResultSet getLookupValues(java.lang.String psLookupCode)
          Gets the lookup values of the specified lookup
 Thor.API.tcResultSet getLookupValues(java.lang.String psLookupCode, java.util.Map poFilters)
          Gets the lookup values of the specified lookup
 Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode)
          Gets the lookup values of the lookup assigned to the specified column/field
 Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters)
          Gets the lookup values of the lookup assigned to the specified column/field
 Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters, long obiOrOrcKey)
          Gets the lookup values of the lookup assigned to the specified column/field
 Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters, long obiOrOrcKey, ProvisioningData provData)
          Gets the lookup values of the lookup assigned to the specified column/field
 Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters, ProvisioningData provData)
          Gets the lookup values of the lookup assigned to the specified column/field
 Thor.API.tcResultSet getLookupValuesForEncoded(java.lang.String psLookupCode, java.lang.String encodedValues)
          Gets the lookup values of the lookup assigned to the specified column/field
 void removeLookupCode(java.lang.String psLookupCode)
          Removes an existing lookup code This API also deletes all the lookup values associated with this code
 void removeLookupValue(java.lang.String psLookupCode, java.lang.String psValue)
          Removes an existing entry for the specified lookup
 void updateLookupCode(java.lang.String psLookupCode, java.util.Map phAttributeList)
          Updates an existing lookup code
 void updateLookupValue(java.lang.String psLookupCode, java.lang.String psExistingLookupValue, java.util.Map phAttributeList)
          Updates an existing lookup value for the specified lookup
 void updateLookupValue(java.lang.String psLookupCode, java.lang.String psExistingValue, java.lang.String psNewValue, java.lang.String psDescriptiveValue, java.lang.String psLanguage, java.lang.String psCountry)
          Updates an existing entry for the specified lookup

 

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf
close, getName, setCountry, setLanguage, setVariant

 

Method Detail

getLookupCodeForColumn

java.lang.String getLookupCodeForColumn(java.lang.String psColumnCode)
                                        throws tcAPIException,
                                               tcInvalidColumnException,
                                               tcNoLookupException,
                                               tcAPIException
Gets the lookup code of the lookup assigned to the specified column/field
Parameters:
psColumnCode - The Code for the column
Returns:
The lookup code of the lookup attached to the column
Throws:
tcAPIException
tcInvalidColumnException - - thrown if the Column Code does not exist
tcNoLookupException - - thrown if the specified column does not have a lookup attached to it.

getLookupValuesForColumn

Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode)
                                              throws tcAPIException,
                                                     tcInvalidColumnException,
                                                     tcNoLookupException,
                                                     tcAPIException
Gets the lookup values of the lookup assigned to the specified column/field
Parameters:
psColumnCode - The Code for the column
Returns:
a resultset containing the values
Throws:
tcAPIException
tcInvalidColumnException - - thrown if the Column Code does not exist
tcNoLookupException - - thrown if the specified column does not have a lookup attached to it.

getContextAgnosticLookupValuesForColumn

Thor.API.tcResultSet getContextAgnosticLookupValuesForColumn(java.lang.String psColumnCode)
                                                             throws tcAPIException,
                                                                    tcInvalidColumnException,
                                                                    tcNoLookupException,
                                                                    tcAPIException
Throws:
tcAPIException
tcInvalidColumnException
tcNoLookupException

getLookupValuesForEncoded

Thor.API.tcResultSet getLookupValuesForEncoded(java.lang.String psLookupCode,
                                               java.lang.String encodedValues)
                                               throws tcAPIException,
                                                      tcInvalidLookupException,
                                                      tcAPIException
Gets the lookup values of the lookup assigned to the specified column/field
Parameters:
psLookupCode - The Code for the column
encodedValues - The encoded values in comma separated fashion
Returns:
a resultset containing the values
Throws:
tcAPIException
tcInvalidLookupException - - thrown if the Lookup Code does not exist

getLookupValuesForColumn

Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode,
                                              java.util.Map poFilters)
                                              throws tcAPIException,
                                                     tcInvalidColumnException,
                                                     tcNoLookupException,
                                                     tcAPIException
Gets the lookup values of the lookup assigned to the specified column/field
Parameters:
psColumnCode - The Code for the column
poFilters - The filter name-value pair
Returns:
a resultset containing the values
Throws:
tcAPIException
tcInvalidColumnException - - thrown if the Column Code does not exist
tcNoLookupException - - thrown if the specified column does not have a lookup attached to it.

getLookupValuesForColumn

Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode,
                                              java.util.Map poFilters,
                                              long obiOrOrcKey,
                                              ProvisioningData provData)
                                              throws tcAPIException,
                                                     tcInvalidColumnException,
                                                     tcNoLookupException,
                                                     tcAPIException
Gets the lookup values of the lookup assigned to the specified column/field
Parameters:
psColumnCode - The Code for the column
poFilters - The filter name-value pair
obiOrOrcKey - is the key of obi or orc depending of what type of form it is
provData - provisioning data value object representing the
Returns:
a resultset containing the values
Throws:
tcAPIException
tcInvalidColumnException - - thrown if the Column Code does not exist
tcNoLookupException - - thrown if the specified column does not have a lookup attached to it.

getLookupValuesForColumn

Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode,
                                              java.util.Map poFilters,
                                              long obiOrOrcKey)
                                              throws tcAPIException,
                                                     tcInvalidColumnException,
                                                     tcNoLookupException,
                                                     tcAPIException
Gets the lookup values of the lookup assigned to the specified column/field
Parameters:
psColumnCode - The Code for the column
poFilters - The filter name-value pair
obiOrOrcKey - is the key of obi or orc depending of what type of form it is
Returns:
a resultset containing the values
Throws:
tcAPIException
tcInvalidColumnException - - thrown if the Column Code does not exist
tcNoLookupException - - thrown if the specified column does not have a lookup attached to it.

getLookupValuesForColumn

Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode,
                                              java.util.Map poFilters,
                                              ProvisioningData provData)
                                              throws tcAPIException,
                                                     tcInvalidColumnException,
                                                     tcNoLookupException,
                                                     tcAPIException
Gets the lookup values of the lookup assigned to the specified column/field
Parameters:
psColumnCode - The Code for the column
poFilters - The filter name-value pair
provData - provisioning data value object representing the
Returns:
a resultset containing the values
Throws:
tcAPIException
tcInvalidColumnException - - thrown if the Column Code does not exist
tcNoLookupException - - thrown if the specified column does not have a lookup attached to it.

getLookupValues

Thor.API.tcResultSet getLookupValues(java.lang.String psLookupCode)
                                     throws tcAPIException,
                                            tcInvalidLookupException,
                                            tcAPIException
Gets the lookup values of the specified lookup
Parameters:
psLookupCode - The Code for the lookup definition
Returns:
a resultset containing the values and the descriptive values
Throws:
tcAPIException
tcInvalidLookupException - - thrown if the Lookup Code does not exist

getLookupValues

Thor.API.tcResultSet getLookupValues(java.lang.String psLookupCode,
                                     java.util.Map poFilters)
                                     throws tcAPIException,
                                            tcInvalidLookupException,
                                            tcAPIException
Gets the lookup values of the specified lookup
Parameters:
psLookupCode - The Code for the lookup definition
poFilters - Key-value set
Returns:
a resultset containing the values and the descriptive values
Throws:
tcAPIException
tcInvalidLookupException - - thrown if the Lookup Code does not exist

addLookupValue

void addLookupValue(java.lang.String psLookupCode,
                    java.lang.String psValue,
                    java.lang.String psDescriptiveValue,
                    java.lang.String psLanguage,
                    java.lang.String psCountry)
                    throws tcAPIException,
                           tcInvalidLookupException,
                           tcInvalidValueException,
                           tcAPIException
Adds a new entry for the specified lookup
Parameters:
psLookupCode - The Code for the lookup definition
psValue - The value that will be stored in the database
psDescriptiveValue - A descriptive version of the value to be added
psLanguage - The language for the entry being added. Leave blank to accept the default (en)
psCountry - The country for the specified entry. Leave blank to accept the default (US)
Throws:
tcAPIException
tcInvalidLookupException - - thrown if the Lookup Code does not exist
tcInvalidValueException - - thrown if the value cannot be added to the lookup (because it is a duplicate, etc)

removeLookupValue

void removeLookupValue(java.lang.String psLookupCode,
                       java.lang.String psValue)
                       throws tcAPIException,
                              tcInvalidLookupException,
                              tcInvalidValueException,
                              tcAPIException
Removes an existing entry for the specified lookup
Parameters:
psLookupCode - The Code for the lookup definition
psValue - The value of the entry to be removed
Throws:
tcAPIException
tcInvalidLookupException - - thrown if the Lookup Code does not exist
tcInvalidValueException - - thrown if the value does not exist

updateLookupValue

void updateLookupValue(java.lang.String psLookupCode,
                       java.lang.String psExistingValue,
                       java.lang.String psNewValue,
                       java.lang.String psDescriptiveValue,
                       java.lang.String psLanguage,
                       java.lang.String psCountry)
                       throws tcAPIException,
                              tcInvalidLookupException,
                              tcInvalidValueException,
                              tcAPIException
Updates an existing entry for the specified lookup
Parameters:
psLookupCode - The Code for the lookup definition
psExistingValue - The value that is to be updated. This is the existing encoded lookup value
psNewValue - The new encoded value to be set. Leave blank to leave unchanged.
psDescriptiveValue - The descriptive version of the value or decoded value of the lookup. Leave blank to leave unchanged.
psLanguage - The language for the entry being added. Leave blank to leave unchanged.
psCountry - The country for the specified entry. Leave blank to leave unchanged.
Throws:
tcAPIException
tcInvalidLookupException - - thrown if the Lookup Code does not exist
tcInvalidValueException - - thrown if the value does not exist

addLookupCode

void addLookupCode(java.lang.String psLookupCode)
                   throws tcAPIException,
                          tcDuplicateLookupCodeException,
                          tcAPIException
Adds a new lookup code
Parameters:
psLookupCode - The Code for the lookup definition to be added This API can add only lookups of type 'lookup' and not of type 'field'
Throws:
tcAPIException - - thrown if errors occur while saving the lookup definition
tcDuplicateLookupCodeException - - thrown if the Lookup Code already exists

removeLookupCode

void removeLookupCode(java.lang.String psLookupCode)
                      throws tcInvalidLookupException,
                             tcAPIException,
                             tcAPIException
Removes an existing lookup code This API also deletes all the lookup values associated with this code
Parameters:
psLookupCode - The lookup code to be removed
Throws:
tcInvalidLookupException - - thrown if the Lookup Code does not exist
tcAPIException - - thrown if errors occur while removing the lookup definition

updateLookupCode

void updateLookupCode(java.lang.String psLookupCode,
                      java.util.Map phAttributeList)
                      throws tcInvalidLookupException,
                             tcInvalidAttributeException,
                             tcAPIException,
                             tcAPIException
Updates an existing lookup code
Parameters:
psLookupCode - The lookup code to be updated
phAttributeList - List of attributes attributes the given lookup code to be updated with
Throws:
tcInvalidLookupException - - thrown if the Lookup Code does not exist
tcInvalidAttributeException - - thrown if the one or many of the provided attributes do not exist
tcAPIException - - thrown if errors occur while updating the lookup definition

updateLookupValue

void updateLookupValue(java.lang.String psLookupCode,
                       java.lang.String psExistingLookupValue,
                       java.util.Map phAttributeList)
                       throws tcAPIException,
                              tcInvalidLookupException,
                              tcInvalidAttributeException,
                              tcInvalidValueException,
                              tcAPIException
Updates an existing lookup value for the specified lookup
Parameters:
psLookupCode - The Code for the lookup definition
psExistingLookupValue - The value that is to be updated. This is the existing encoded lookup value
phAttributeList - List of attributes the given lookup value to be updated with. Keys of the Map can be any of the following
  • Lookup Definition.Lookup Code Information.Code Key, You can specify the encoded value with this key
  • Lookup Definition.Lookup Code Information.Decode, You can specify the decoded value with this key
  • Lookup Definition.Lookup Code Information.Language, You can specify the language for which this lookup value associated with using this key
  • Lookup Definition.Lookup Code Information.Variant, You can specify the variant for which this lookup value associated with using this key
Throws:
tcAPIException - - thrown if errors occur while updating the lookup values
tcInvalidLookupException - - thrown if the Lookup Code does not exist
tcInvalidAttributeException - - thrown if the one or many of the provided attributes do not exist
tcInvalidValueException - - thrown if the lookup value does not exist

getDecodedValueForColumnEncodedValue

java.lang.String getDecodedValueForColumnEncodedValue(java.lang.String strEncodeVal,
                                                      java.lang.String userRole)
                                                      throws tcAPIException,
                                                             tcAPIException
For given encoded coloumn value ,return decoded value
Parameters:
strEncodeVal -
userRole -
Returns:
decoded value
Throws:
tcAPIException

getDecodedValueForEncodedValue

java.lang.String getDecodedValueForEncodedValue(java.lang.String lookupCode,
                                                java.lang.String strEncodeVal)
                                                throws tcAPIException,
                                                       tcAPIException
For given encoded value and lookup code,return the decoded value.
Parameters:
lookupCode -
strEncodeVal -
Returns:
Throws:
tcAPIException
Since:
9.1.0.2

findAvailableLookups

Thor.API.tcResultSet findAvailableLookups(java.util.Map phAttributeList)
                                          throws tcInvalidAttributeException,
                                                 tcAPIException,
                                                 tcAPIException
Returns a collection of available Lookups
Parameters:
phAttributeList - - list of Column Metadata Code which can be passed to this API valid attributes
  • Lookup Definition.Key
  • Lookup Definition.Lookup Key
  • Lookup Definition.Type
  • Lookup Definition.Required
  • Lookup Definition.Code
  • Lookup Definition.Field
  • Lookup Definition.System Level
  • Lookup Definition.Creation Date
  • Lookup Definition.Created By
  • Lookup Definition.Update Date
  • Lookup Definition.Updated By
  • Lookup Definition.Note
  • Lookup Definition.Row Version
Returns:
A tcResultSet containing multiple rows, each holding information about the available resource objects list of Column Metadata Code returned in tcResultSet
  • Lookup Definition.Code
  • Lookup Definition.Key
Throws:
tcAPIException - thrown if data set errors occur
tcInvalidAttributeException
Since:
11.1.1.4.0

Skip navigation links


Copyright © 2010, Oracle and/or its affiliates. All rights reserved.