com.tsgrp.opencontent.core.picklist

Interface IPicklist

All Known Implementing Classes:

AbstractPicklistImpl, AlfrescoEmbPicklistImpl, DCTMPicklistImpl, DeferredPicklistImpl, DynamoPicklistImpl, ElasticsearchDynamoPicklistImpl, ElasticsearchPicklistImpl, HBasePicklistImpl, JdbcPicklistImpl, JSONPicklistImpl, SolrDynamoPicklistImpl, SolrPicklistImpl

public interface IPicklist

Method Summary

Modifier and Type	Method and Description
java.util.List<PicklistItem>	getPicklist(java.lang.String ticket, java.lang.String picklistName, java.util.Map<java.lang.String,java.lang.String> tokens) This method queries the database and returns a list of the PicklistItems that make up the picklist with the name of picklistName.
java.util.Set<java.lang.String>	getPicklists(java.lang.String ticket) This method returns the key set of the picklist map.

Method Detail

getPicklists

java.util.Set<java.lang.String> getPicklists(java.lang.String ticket)

This method returns the key set of the picklist map. If the map is null, an error is thrown. If the map is empty, an empty set is returned.

Parameters:

ticket - - valid OC Ticket

Returns:

set of picklist names

getPicklist

java.util.List<PicklistItem> getPicklist(java.lang.String ticket,
                                         java.lang.String picklistName,
                                         java.util.Map<java.lang.String,java.lang.String> tokens)

This method queries the database and returns a list of the PicklistItems that make up the picklist with the name of picklistName. If picklistName isn't a key in the picklist map, an OCObjectNotFound exception will be thrown. If there are no query results returned, an empty List will be returned. If only one column is returned from a query, the values for that column will be used for both the value and label attributes on the PicklistItem

Parameters:

ticket - - valid OC Ticket

picklistName - OC name (the map key) of the picklist to get values for

Returns:

List of PicklistItem objects which make up the picklist values