public class PossibleValues extends DynamoServlet
A complete description of the parameters to the servlet are:
Note: This parameter is only valid for repository items, it will not work with enumerated data-types.
Note: This parameter is only valid for enumerated data-types. For repository items this parameter will contain an empty map.
Within the body of the "output" oparam, this parameter is set
to the map of possible values for the named item descriptor
and property. This parameter is mainly used to display
internationalized enumerated option values.
The map key is set to the PossibleValues.PossibleValue.getSettableValue()
.
The could be a value or an option code. This key is determined
based on the EnumPropertyDescriptor.EnumeratedOption.getUseCodeForValue()
.
The map value object could contain the following values.
getCurrentReturnValueObjectsValue()
is true, then the map values contain
PossibleValues.EnumeratedOptionPossibleValue
object.getCurrentReturnValueObjectsValue()
is false, then the map values contain
PossibleValues.EnumeratedOptionPossibleValue.getLocalizedLabel()
Modifier and Type | Class and Description |
---|---|
class |
PossibleValues.EnumeratedOptionPossibleValue
A possible item based by a repository item.
|
class |
PossibleValues.PossibleValue
Class representing a possible value.
|
class |
PossibleValues.RepositoryItemPossibleValue
A possible item based by a repository item.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
static java.lang.String |
DISPLAY_VALUES |
static java.lang.String |
ENUMERATED |
static ParameterName |
ITEM_NAME |
static ParameterName |
MAX_REPOSITORY_ITEMS |
static ParameterName |
OUTPUT |
static ParameterName |
PROPERTY_NAME |
static ParameterName |
REPOSITORY |
static ParameterName |
REPOSITORY_ITEM |
static java.lang.String |
RESOURCE_BUNDLE |
static ParameterName |
RETURN_VALUE_OBJECTS |
protected static java.util.ResourceBundle |
smResourceBundle |
static ParameterName |
SORT_PROPERTIES |
static ParameterName |
USE_CODE_FOR_VALUE |
static java.lang.String |
VALUES |
mAllowCleanupRequest, mParameters
SERVLET_INFO_KEY
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
PossibleValues() |
Modifier and Type | Method and Description |
---|---|
static SortDirectives |
buildSortDirectives(java.lang.String[] pSortProperties)
Build sort directives
|
protected int |
getCurrentMaxRepositoryItemsValue()
Method to get the current "maxRepositoryItems" parameter value.
|
protected boolean |
getCurrentReturnValueObjectsValue()
Method to get the current "returnValueObjects" parameter value.
|
java.util.Map<java.lang.Object,java.lang.Object> |
getDisplayValues(Repository pRepository,
java.lang.String pItemDescriptorName,
java.lang.String pPropertyName)
This method returns a map.
|
PossibleValues.EnumeratedOptionPossibleValue[] |
getEnumeratedPossibleObjectValues(Repository pRepository,
java.lang.String pItemDescriptorName,
java.lang.String pPropertyName)
This method returns an array of
PossibleValues.EnumeratedOptionPossibleValue objects. |
int |
getMaxRepositoryItems()
Gets the default maximum number of repository items to
be returned from a query.
|
Repository |
getRepository()
Get the repository
|
protected Query |
getRepositoryItemQuery(RepositoryItemDescriptor pItemDescriptor,
QueryBuilder pBuilder)
Get the query that is used by
getRepositoryItems
By default, this is just an unconstrained query |
protected RepositoryItem[] |
getRepositoryItems(RepositoryItemDescriptor pItemDescriptor,
RepositoryPropertyDescriptor pPropertyDescriptor,
SortDirectives pSortDirectives)
Get repository items
|
java.lang.Object |
getRepositoryValues(Repository pRepository,
java.lang.String pItemDescriptorName,
java.lang.String pPropertyName,
boolean pUseCodeForValue,
SortDirectives pSortDirectives)
Get repository values for either enumerated types or for linked
property values, using the specified repository
|
protected java.lang.Object |
getRepositoryValues(java.lang.String pItemDescriptorName,
java.lang.String pPropertyName,
java.lang.String pUseCodeForValue,
SortDirectives pSortDirectives)
Get repository values for either enumerated types or for linked
property values, use the configured repository
|
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Service routine
|
void |
setMaxRepositoryItems(int pMaxRepositoryItems)
Sets the default maximum number of repository items to
be returned from a query.
|
void |
setRepository(Repository pRepository)
Set the repository
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static java.lang.String RESOURCE_BUNDLE
public static java.lang.String ENUMERATED
public static java.lang.String VALUES
public static java.lang.String DISPLAY_VALUES
public static final ParameterName REPOSITORY
public static final ParameterName ITEM_NAME
public static final ParameterName REPOSITORY_ITEM
public static final ParameterName RETURN_VALUE_OBJECTS
public static final ParameterName PROPERTY_NAME
public static final ParameterName SORT_PROPERTIES
public static final ParameterName USE_CODE_FOR_VALUE
public static final ParameterName MAX_REPOSITORY_ITEMS
public static final ParameterName OUTPUT
protected static java.util.ResourceBundle smResourceBundle
public void setRepository(Repository pRepository)
pRepository
- a repositorypublic Repository getRepository()
public void setMaxRepositoryItems(int pMaxRepositoryItems)
public int getMaxRepositoryItems()
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
service
in class DynamoServlet
pRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- an application specific error occurred
processing this requestjava.io.IOException
- an error occurred reading data from the request
or writing data to the response.public static SortDirectives buildSortDirectives(java.lang.String[] pSortProperties)
pSortProperties
- a list of sort directivesprotected java.lang.Object getRepositoryValues(java.lang.String pItemDescriptorName, java.lang.String pPropertyName, java.lang.String pUseCodeForValue, SortDirectives pSortDirectives)
pItemDescriptorName
- item descriptor namepPropertyName
- the property namepSortProperties
- sort directivespublic java.lang.Object getRepositoryValues(Repository pRepository, java.lang.String pItemDescriptorName, java.lang.String pPropertyName, boolean pUseCodeForValue, SortDirectives pSortDirectives)
pRepository
- the repositorypItemDescriptorName
- item descriptor namepPropertyName
- the property namepSortProperties
- sort directivesprotected RepositoryItem[] getRepositoryItems(RepositoryItemDescriptor pItemDescriptor, RepositoryPropertyDescriptor pPropertyDescriptor, SortDirectives pSortDirectives)
pItemDescriptorName
- the name of the item descriptorpPropertyName
- an optional linked property namepSortDirectives
- a possibly empty or null SortDirectives objectprotected Query getRepositoryItemQuery(RepositoryItemDescriptor pItemDescriptor, QueryBuilder pBuilder) throws RepositoryException
getRepositoryItems
By default, this is just an unconstrained querypItemDescriptor
- The type of item that is return by this querypBuilder
- The query builder used to build the queryRepositoryException
protected boolean getCurrentReturnValueObjectsValue()
protected int getCurrentMaxRepositoryItemsValue()
public PossibleValues.EnumeratedOptionPossibleValue[] getEnumeratedPossibleObjectValues(Repository pRepository, java.lang.String pItemDescriptorName, java.lang.String pPropertyName)
PossibleValues.EnumeratedOptionPossibleValue
objects.
If the property is of enumerated type, then this method returns an array of
PossibleValues.EnumeratedOptionPossibleValue
objects. Otherwise returns null.
pRepository
- The repository in which a property needs to be looked uppItemDescriptorName
- The item descriptor in which a property needs to be looked uppPropertyName
- The property name to be looked upPossibleValues.EnumeratedOptionPossibleValue
objectspublic java.util.Map<java.lang.Object,java.lang.Object> getDisplayValues(Repository pRepository, java.lang.String pItemDescriptorName, java.lang.String pPropertyName)
If the property that needs to be looked up is an enumerated property, the following possible map values are returned.
The map key is the PossibleValues.PossibleValue.getSettableValue()
. The could be a value or
an option code. This key is determined based on the EnumPropertyDescriptor.EnumeratedOption.getUseCodeForValue()
.
The map value object could contain the following values.
getCurrentReturnValueObjectsValue()
is true, then the map values contain
PossibleValues.EnumeratedOptionPossibleValue
object.getCurrentReturnValueObjectsValue()
is false, then the map values contain
PossibleValues.EnumeratedOptionPossibleValue.getLocalizedLabel()
pRepository
- The repository in which a property needs to be looked uppItemDescriptorName
- The item descriptor in which a property needs to be looked uppPropertyName
- The property name to be looked upgetEnumeratedPossibleObjectValues(Repository, String, String)
,
getCurrentReturnValueObjectsValue()