|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.nucleus.servlet.ServletService atg.nucleus.servlet.HttpServletService atg.servlet.DynamoServlet atg.repository.servlet.PossibleValues
public class PossibleValues
This servlet queries a repository and returns all tag values or repository items for a given itemDescriptorName and propertyName depending on the type of the property identified by propertyName. If the optional parameter propertyName is omitted, the droplet will return all repository values for itemType.
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()
Nested Class Summary | |
---|---|
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. |
Field Summary | |
---|---|
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
|
Fields inherited from class atg.servlet.DynamoServlet |
---|
mAllowCleanupRequest, mParameters |
Fields inherited from class atg.nucleus.servlet.ServletService |
---|
SERVLET_INFO_KEY |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
PossibleValues()
|
Method Summary | |
---|---|
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 |
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, init, setServletInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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
Constructor Detail |
---|
public PossibleValues()
Method Detail |
---|
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 request
javax.servlet.ServletException
- an application specific error occurred
processing this request
java.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 directives
protected 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 directives
public 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 directives
protected 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 object
protected Query getRepositoryItemQuery(RepositoryItemDescriptor pItemDescriptor, QueryBuilder pBuilder) throws RepositoryException
getRepositoryItems
By default, this is just an unconstrained query
pItemDescriptor
- The type of item that is return by this querypBuilder
- The query builder used to build the query
RepositoryException
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 up
PossibleValues.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 up
getEnumeratedPossibleObjectValues(Repository, String, String)
,
getCurrentReturnValueObjectsValue()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |