|
|||||||||
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.targeting.TargetingServices
public class TargetingServices
A collection of services that execute targeters and return Repo2XML items
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
TargetingServices()
|
Method Summary | |
---|---|
java.lang.String[] |
executeRepositoryTargeter(java.lang.String pTargeterPath)
Executes the repository targeter that exists at pTargeterPath in the config layer, and returns
the results as Repo2XML items. |
java.lang.String[] |
executeRepositoryTargeter(java.lang.String pTargeterPath,
int pMaxNumber)
Executes the repository targeter that exists at pTargeterPath in the config layer, and returns
the results as Repo2XML items. |
java.lang.String[] |
executeRepositoryTargeter(java.lang.String pTargeterPath,
int pStartingIndex,
int pEndingIndex)
Executes the repository targeter that exists at pTargeterPath in the config layer, and returns
the results as Repo2XML items. |
java.lang.String[] |
executeRepositoryTargeter(java.lang.String pTargeterPath,
int pStartingIndex,
int pEndingIndex,
java.lang.String pMappingFile)
Executes the repository targeter that exists at pTargeterPath in the config layer, and returns
the results as Repo2XML items. |
java.lang.String[] |
executeRepositoryTargeter(java.lang.String pTargeterPath,
int pMaxNumber,
java.lang.String pMappingFile)
Executes the repository targeter that exists at pTargeterPath in the config layer, and returns
the results as Repo2XML items. |
java.lang.String[] |
executeRepositoryTargeter(java.lang.String pTargeterPath,
java.lang.String pMappingFile)
Executes the repository targeter that exists at pTargeterPath in the config layer, and returns
the results as Repo2XML items. |
atg.repository.xml.ItemDescriptorMappingManager |
getMappingManager()
Get property MappingManager |
TargetingSourceMap |
getTargetingSourceMap()
Get property TargetingSourceMap |
GetService |
getXmlGetService()
Get property XmlGetService |
boolean |
isUseDefaultMappings()
Get property UseDefaultMappings
DEFAULT: true |
void |
setMappingManager(atg.repository.xml.ItemDescriptorMappingManager pMappingManager)
Set property MappingManager |
void |
setTargetingSourceMap(TargetingSourceMap pTargetingSourceMap)
Set property TargetingSourceMap |
void |
setUseDefaultMappings(boolean pUseDefaultMappings)
Set property UseDefaultMappings
DEFAULT: true |
void |
setXmlGetService(GetService pXmlGetService)
Set property XmlGetService |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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
Constructor Detail |
---|
public TargetingServices()
Method Detail |
---|
public void setXmlGetService(GetService pXmlGetService)
XmlGetService
pXmlGetService
- the service that turns a RepositoryItem
into an XML filepublic GetService getXmlGetService()
XmlGetService
public void setMappingManager(atg.repository.xml.ItemDescriptorMappingManager pMappingManager)
MappingManager
pMappingManager
- the service that controls mapping files for all
item descriptorspublic atg.repository.xml.ItemDescriptorMappingManager getMappingManager()
MappingManager
public void setUseDefaultMappings(boolean pUseDefaultMappings)
UseDefaultMappings
DEFAULT: true
pUseDefaultMappings
- true if services that return Repo2Xml
items should use default mapping files supplied by the
ItemMappingManager
configured for this component. This
property is ignored if a mapping file is explicitly passed to
the servicepublic boolean isUseDefaultMappings()
UseDefaultMappings
DEFAULT: true
ItemMappingManager
configured for this component. This
property is ignored if a mapping file is explicitly passed to
the servicepublic void setTargetingSourceMap(TargetingSourceMap pTargetingSourceMap)
TargetingSourceMap
pTargetingSourceMap
- public TargetingSourceMap getTargetingSourceMap()
TargetingSourceMap
public java.lang.String[] executeRepositoryTargeter(java.lang.String pTargeterPath) throws atg.targeting.TargetingException, GetException
pTargeterPath
in the config layer, and returns
the results as Repo2XML items. If this targeter is called in
the context or a request, then that request is used to
resolve and execute the targeter, so that any session or request
scoped components referenced (e.g. Profile) can be resolved
properly
pTargeterPath
- the nucleus path of the targeter to executepMappingFile
- the mapping file to use when turning the item
into an XML document
TargetingException
- if a targeting error occurs
GetException
- if an error occurs turning the
results into Repo2XML itemspublic java.lang.String[] executeRepositoryTargeter(java.lang.String pTargeterPath, java.lang.String pMappingFile) throws atg.targeting.TargetingException, GetException
pTargeterPath
in the config layer, and returns
the results as Repo2XML items. If this targeter is called in
the context or a request, then that request is used to
resolve and execute the targeter, so that any session or request
scoped components referenced (e.g. Profile) can be resolved
properly
pTargeterPath
- the nucleus path of the targeter to execute
TargetingException
- if a targeting error occurs
GetException
- if an error occurs turning the
results into Repo2XML itemspublic java.lang.String[] executeRepositoryTargeter(java.lang.String pTargeterPath, int pMaxNumber) throws atg.targeting.TargetingException, GetException
pTargeterPath
in the config layer, and returns
the results as Repo2XML items. If this targeter is called in
the context or a request, then that request is used to
resolve and execute the targeter, so that any session or request
scoped components referenced (e.g. Profile) can be resolved
properly
pTargeterPath
- the nucleus path of the targeter to executepMaxNumber
- the maximum number of elements to return
TargetingException
- if a targeting error occurs
GetException
- if an error occurs turning the
results into Repo2XML itemspublic java.lang.String[] executeRepositoryTargeter(java.lang.String pTargeterPath, int pMaxNumber, java.lang.String pMappingFile) throws atg.targeting.TargetingException, GetException
pTargeterPath
in the config layer, and returns
the results as Repo2XML items. If this targeter is called in
the context or a request, then that request is used to
resolve and execute the targeter, so that any session or request
scoped components referenced (e.g. Profile) can be resolved
properly
pTargeterPath
- the nucleus path of the targeter to executepMaxNumber
- the maximum number of elements to returnpMappingFile
- the mapping file to use when turning the item
into an XML document
TargetingException
- if a targeting error occurs
GetException
- if an error occurs turning the
results into Repo2XML itemspublic java.lang.String[] executeRepositoryTargeter(java.lang.String pTargeterPath, int pStartingIndex, int pEndingIndex) throws atg.targeting.TargetingException, GetException
pTargeterPath
in the config layer, and returns
the results as Repo2XML items. If this targeter is called in
the context or a request, then that request is used to
resolve and execute the targeter, so that any session or request
scoped components referenced (e.g. Profile) can be resolved
properly
pTargeterPath
- the nucleus path of the targeter to executepMaxNumber
- the maximum number of elements to returnpStartingIndex
- if items are returned from the targeter,
the index of the result that should be the first item
in the result setpEndingIndex
- if items are returned, the index of the
result that should be the last item in the result set
TargetingException
- if a targeting error occurs
GetException
- if an error occurs turning the
results into Repo2XML itemspublic java.lang.String[] executeRepositoryTargeter(java.lang.String pTargeterPath, int pStartingIndex, int pEndingIndex, java.lang.String pMappingFile) throws atg.targeting.TargetingException, GetException
pTargeterPath
in the config layer, and returns
the results as Repo2XML items. If this targeter is called in
the context or a request, then that request is used to
resolve and execute the targeter, so that any session or request
scoped components referenced (e.g. Profile) can be resolved
properly
pTargeterPath
- the nucleus path of the targeter to executepMaxNumber
- the maximum number of elements to returnpStartingIndex
- if items are returned from the targeter,
the index of the result that should be the first item
in the result setpEndingIndex
- if items are returned, the index of the
result that should be the last item in the result setpMappingFile
- the mapping file to use when turning the item
into an XML document
TargetingException
- if a targeting error occurs
GetException
- if an error occurs turning the
results into Repo2XML items
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |