|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcLookupOperationsIntf
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 |
---|
java.lang.String getLookupCodeForColumn(java.lang.String psColumnCode) throws tcAPIException, tcInvalidColumnException, tcNoLookupException, tcAPIException
psColumnCode
- The Code for the columntcAPIException
tcInvalidColumnException
- - thrown if the Column Code does not existtcNoLookupException
- - thrown if the specified column does not have a lookup attached to it.Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode) throws tcAPIException, tcInvalidColumnException, tcNoLookupException, tcAPIException
psColumnCode
- The Code for the columntcAPIException
tcInvalidColumnException
- - thrown if the Column Code does not existtcNoLookupException
- - thrown if the specified column does not have a lookup attached to it.Thor.API.tcResultSet getContextAgnosticLookupValuesForColumn(java.lang.String psColumnCode) throws tcAPIException, tcInvalidColumnException, tcNoLookupException, tcAPIException
tcAPIException
tcInvalidColumnException
tcNoLookupException
Thor.API.tcResultSet getLookupValuesForEncoded(java.lang.String psLookupCode, java.lang.String encodedValues) throws tcAPIException, tcInvalidLookupException, tcAPIException
psLookupCode
- The Code for the columnencodedValues
- The encoded values in comma separated fashiontcAPIException
tcInvalidLookupException
- - thrown if the Lookup Code does not existThor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters) throws tcAPIException, tcInvalidColumnException, tcNoLookupException, tcAPIException
psColumnCode
- The Code for the columnpoFilters
- The filter name-value pairtcAPIException
tcInvalidColumnException
- - thrown if the Column Code does not existtcNoLookupException
- - thrown if the specified column does not have a lookup attached to it.Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters, long obiOrOrcKey, ProvisioningData provData) throws tcAPIException, tcInvalidColumnException, tcNoLookupException, tcAPIException
psColumnCode
- The Code for the columnpoFilters
- The filter name-value pairobiOrOrcKey
- is the key of obi or orc depending of what type of form it isprovData
- provisioning data value object representing thetcAPIException
tcInvalidColumnException
- - thrown if the Column Code does not existtcNoLookupException
- - thrown if the specified column does not have a lookup attached to it.Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters, long obiOrOrcKey) throws tcAPIException, tcInvalidColumnException, tcNoLookupException, tcAPIException
psColumnCode
- The Code for the columnpoFilters
- The filter name-value pairobiOrOrcKey
- is the key of obi or orc depending of what type of form it istcAPIException
tcInvalidColumnException
- - thrown if the Column Code does not existtcNoLookupException
- - thrown if the specified column does not have a lookup attached to it.Thor.API.tcResultSet getLookupValuesForColumn(java.lang.String psColumnCode, java.util.Map poFilters, ProvisioningData provData) throws tcAPIException, tcInvalidColumnException, tcNoLookupException, tcAPIException
psColumnCode
- The Code for the columnpoFilters
- The filter name-value pairprovData
- provisioning data value object representing thetcAPIException
tcInvalidColumnException
- - thrown if the Column Code does not existtcNoLookupException
- - thrown if the specified column does not have a lookup attached to it.Thor.API.tcResultSet getLookupValues(java.lang.String psLookupCode) throws tcAPIException, tcInvalidLookupException, tcAPIException
psLookupCode
- The Code for the lookup definitiontcAPIException
tcInvalidLookupException
- - thrown if the Lookup Code does not existThor.API.tcResultSet getLookupValues(java.lang.String psLookupCode, java.util.Map poFilters) throws tcAPIException, tcInvalidLookupException, tcAPIException
psLookupCode
- The Code for the lookup definitionpoFilters
- Key-value settcAPIException
tcInvalidLookupException
- - thrown if the Lookup Code does not existvoid 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
psLookupCode
- The Code for the lookup definitionpsValue
- The value that will be stored in the databasepsDescriptiveValue
- A descriptive version of the value to be addedpsLanguage
- 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)tcAPIException
tcInvalidLookupException
- - thrown if the Lookup Code does not existtcInvalidValueException
- - thrown if the value cannot be added to the lookup (because it is a duplicate, etc)void removeLookupValue(java.lang.String psLookupCode, java.lang.String psValue) throws tcAPIException, tcInvalidLookupException, tcInvalidValueException, tcAPIException
psLookupCode
- The Code for the lookup definitionpsValue
- The value of the entry to be removedtcAPIException
tcInvalidLookupException
- - thrown if the Lookup Code does not existtcInvalidValueException
- - thrown if the value does not existvoid 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
psLookupCode
- The Code for the lookup definitionpsExistingValue
- The value that is to be updated. This is the existing encoded lookup valuepsNewValue
- 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.tcAPIException
tcInvalidLookupException
- - thrown if the Lookup Code does not existtcInvalidValueException
- - thrown if the value does not existvoid addLookupCode(java.lang.String psLookupCode) throws tcAPIException, tcDuplicateLookupCodeException, tcAPIException
psLookupCode
- The Code for the lookup definition to be added This API can add only lookups of type 'lookup' and not of type 'field'tcAPIException
- - thrown if errors occur while saving the lookup definitiontcDuplicateLookupCodeException
- - thrown if the Lookup Code already existsvoid removeLookupCode(java.lang.String psLookupCode) throws tcInvalidLookupException, tcAPIException, tcAPIException
psLookupCode
- The lookup code to be removedtcInvalidLookupException
- - thrown if the Lookup Code does not existtcAPIException
- - thrown if errors occur while removing the lookup definitionvoid updateLookupCode(java.lang.String psLookupCode, java.util.Map phAttributeList) throws tcInvalidLookupException, tcInvalidAttributeException, tcAPIException, tcAPIException
psLookupCode
- The lookup code to be updatedphAttributeList
- List of attributes attributes the given lookup code to be updated withtcInvalidLookupException
- - thrown if the Lookup Code does not existtcInvalidAttributeException
- - thrown if the one or many of the provided attributes do not existtcAPIException
- - thrown if errors occur while updating the lookup definitionvoid updateLookupValue(java.lang.String psLookupCode, java.lang.String psExistingLookupValue, java.util.Map phAttributeList) throws tcAPIException, tcInvalidLookupException, tcInvalidAttributeException, tcInvalidValueException, tcAPIException
psLookupCode
- The Code for the lookup definitionpsExistingLookupValue
- The value that is to be updated. This is the existing encoded lookup valuephAttributeList
- List of attributes the given lookup value to be updated with. Keys of the Map can be any of the following
tcAPIException
- - thrown if errors occur while updating the lookup valuestcInvalidLookupException
- - thrown if the Lookup Code does not existtcInvalidAttributeException
- - thrown if the one or many of the provided attributes do not existtcInvalidValueException
- - thrown if the lookup value does not existjava.lang.String getDecodedValueForColumnEncodedValue(java.lang.String strEncodeVal, java.lang.String userRole) throws tcAPIException, tcAPIException
strEncodeVal
-userRole
-tcAPIException
java.lang.String getDecodedValueForEncodedValue(java.lang.String lookupCode, java.lang.String strEncodeVal) throws tcAPIException, tcAPIException
lookupCode
-strEncodeVal
-tcAPIException
Thor.API.tcResultSet findAvailableLookups(java.util.Map phAttributeList) throws tcInvalidAttributeException, tcAPIException, tcAPIException
phAttributeList
- - list of Column Metadata Code which can be passed to this API valid attributes
tcAPIException
- thrown if data set errors occurtcInvalidAttributeException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |