public class CatalogPossibleValues extends PossibleValues
atg.repository.servlet.PossibleValues
will only include items that are contained in the current users
catalog, in the list of possible values. It does this by using a
different query than PossibleValues does. It uses the catalog
in the profile, or (if one is provided) the one in the parameter
"catalog"
Created: Mon Jul 16 15:11:40 2001PossibleValues.EnumeratedOptionPossibleValue, PossibleValues.PossibleValue, PossibleValues.RepositoryItemPossibleValue
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
DEFAULT_CATALOG_ITEMS_CATALOG_PROPERTY |
static java.lang.String |
DEFAULT_CATALOG_PROPERTY |
DISPLAY_VALUES, ENUMERATED, ITEM_NAME, MAX_REPOSITORY_ITEMS, OUTPUT, PROPERTY_NAME, REPOSITORY, REPOSITORY_ITEM, RESOURCE_BUNDLE, RETURN_VALUE_OBJECTS, smResourceBundle, SORT_PROPERTIES, USE_CODE_FOR_VALUE, 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 |
---|
CatalogPossibleValues() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCatalogItemsCatalogProperty()
The name of the property for each catalog item that contains the
list of catalogs containing that item
This defaults to "catalogs"
|
java.lang.String |
getCatalogPropertyName()
The name of the profile property pointing to the catalog
This defaults to "catalog"
|
CustomCatalogTools |
getCatalogTools()
Returns property catalogTools.
|
protected java.lang.Object |
getCurrentCatalog()
Get the current catalog from the profile
|
java.lang.String[] |
getExcludedItemDescriptors()
The list of item descriptors that we do not want to check...
|
protected Query |
getRepositoryItemQuery(RepositoryItemDescriptor pItemDescriptor,
QueryBuilder pQueryBuilder)
Get the query that is used by
getRepositoryItems
By default, this gets the items whose catalogItemsCatalogProperty
includes the current catalog. |
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
Override of getRepositoryValues that calls the super methods.
|
boolean |
isNullCatalogMeansNoResults()
If this is true, and the profile's catalog is null, no results
will be returned.
|
boolean |
isQueryByCatalog()
If this is true, queries will be constrained by catalog.
|
void |
setCatalogItemsCatalogProperty(java.lang.String pCatalogItemsCatalogProperty) |
void |
setCatalogPropertyName(java.lang.String pCatalogPropertyName) |
void |
setCatalogTools(CustomCatalogTools pCatalogTools)
Sets property catalogTools.
|
void |
setExcludedItemDescriptors(java.lang.String[] pExcludedItemDescriptors) |
void |
setNullCatalogMeansNoResults(boolean pNullCatalogMeansNoResults) |
void |
setQueryByCatalog(boolean pQueryByCatalog) |
buildSortDirectives, getCurrentMaxRepositoryItemsValue, getCurrentReturnValueObjectsValue, getDisplayValues, getEnumeratedPossibleObjectValues, getMaxRepositoryItems, getRepository, getRepositoryItems, getRepositoryValues, service, setMaxRepositoryItems, setRepository
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 final java.lang.String DEFAULT_CATALOG_PROPERTY
public static final java.lang.String DEFAULT_CATALOG_ITEMS_CATALOG_PROPERTY
public void setCatalogItemsCatalogProperty(java.lang.String pCatalogItemsCatalogProperty)
public java.lang.String getCatalogItemsCatalogProperty()
public void setCatalogPropertyName(java.lang.String pCatalogPropertyName)
public java.lang.String getCatalogPropertyName()
public void setNullCatalogMeansNoResults(boolean pNullCatalogMeansNoResults)
public boolean isNullCatalogMeansNoResults()
public void setExcludedItemDescriptors(java.lang.String[] pExcludedItemDescriptors)
public java.lang.String[] getExcludedItemDescriptors()
public void setCatalogTools(CustomCatalogTools pCatalogTools)
pCatalogTools
- the property to store the global service catalog tools factory to obtain the catalog to search in.public CustomCatalogTools getCatalogTools()
public void setQueryByCatalog(boolean pQueryByCatalog)
public boolean isQueryByCatalog()
protected Query getRepositoryItemQuery(RepositoryItemDescriptor pItemDescriptor, QueryBuilder pQueryBuilder) throws RepositoryException
getRepositoryItems
By default, this gets the items whose catalogItemsCatalogProperty
includes the current catalog. If the item we are interested in does not have this
property, then no extra contraints are added.getRepositoryItemQuery
in class PossibleValues
pItemDescriptor
- The type of item that is return by this querypQueryBuilder
- The query builder used to build the queryRepositoryException
protected java.lang.Object getRepositoryValues(java.lang.String pItemDescriptorName, java.lang.String pPropertyName, java.lang.String pUseCodeForValue, SortDirectives pSortDirectives)
getRepositoryValues
in class PossibleValues
pItemDescriptorName
- item descriptor namepPropertyName
- the property namepSortProperties
- sort directivesprotected java.lang.Object getCurrentCatalog() throws RepositoryException
RepositoryException