com.softwareag.centrasite.appl.framework.persistence.search
Class SearchQuery

java.lang.Object
  extended by com.softwareag.centrasite.appl.framework.persistence.search.SearchQuery

public class SearchQuery
extends java.lang.Object

Internal class representing the CentraSite query that will be executed by instance.


Constructor Summary
SearchQuery(Predicate predicate, java.util.List<Order> orders, ManagedBeanPool beanPool, com.centrasite.jaxr.CentraSiteBusinessQuery centraSiteBusinessQuery)
          Creates a SearchQuery instance for a given search properties
 
Method Summary
 void addPrologExtension(java.lang.String prologExtension)
          Adds a prologExtension to a String of prolog extensions.
 javax.xml.registry.BulkResponse execute()
          Creates and executes the business query
 java.lang.String generateNextContextObject()
           
 ManagedBeanPool getBeanPool()
          Returns the bean pool
 PersistenceContext getContext()
          Returns the persitanceContext
 java.lang.String getCurrentContextObject()
          Returns the current context object and itarates for the next
 java.util.Locale getLocale()
          Returns the current locale
 int getLocalFunctionCount()
           
 java.lang.String getNextContextObject()
           
 javax.xml.namespace.QName getObjectTypeName(java.lang.Class<? extends RegistryBean> beanClass)
          Gives the object type name for a given bean class
 java.lang.String getPrefixForNamespaceUri(java.lang.String nameSpaceUri, boolean importRequired)
          Declares and returns a prefix for a given nameSpaceUri
 java.lang.String getPreviousContextObjectType()
           
 java.lang.String getPrologExtension()
           
 java.lang.String getQueryPath()
           
 boolean isInFunction()
           
 void resetContextObjects()
          Resets the values of the context objects so they are ready for next iteration
 void setIsInFunction(boolean isInFunction)
           
 void setLocalFunctionCount(int localFunctionCount)
           
 void setNextFunctionCount()
           
 void setPreviousContextObjectType(java.lang.String previsousContextObjectType)
           
 void setPrologExtension(java.lang.String expression)
          Declares a prolog extension in CentraSiteBusinessQuery
 void setQueryPath(java.lang.String queryPath)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchQuery

public SearchQuery(Predicate predicate,
                   java.util.List<Order> orders,
                   ManagedBeanPool beanPool,
                   com.centrasite.jaxr.CentraSiteBusinessQuery centraSiteBusinessQuery)
Creates a SearchQuery instance for a given search properties

Parameters:
predicate -
orders -
beanPool -
centraSiteBusinessQuery -
Method Detail

execute

public javax.xml.registry.BulkResponse execute()
                                        throws CSAppFrameworkException
Creates and executes the business query

Returns:
BulkResponse with info of the executed query
Throws:
CSAppFrameworkException

getCurrentContextObject

public java.lang.String getCurrentContextObject()
Returns the current context object and itarates for the next

Returns:
String currentContextObject

resetContextObjects

public void resetContextObjects()
Resets the values of the context objects so they are ready for next iteration


getPrefixForNamespaceUri

public java.lang.String getPrefixForNamespaceUri(java.lang.String nameSpaceUri,
                                                 boolean importRequired)
Declares and returns a prefix for a given nameSpaceUri

Parameters:
nameSpaceUri -
importRequired -
Returns:
String

setPrologExtension

public void setPrologExtension(java.lang.String expression)
Declares a prolog extension in CentraSiteBusinessQuery

Parameters:
expression -

getObjectTypeName

public javax.xml.namespace.QName getObjectTypeName(java.lang.Class<? extends RegistryBean> beanClass)
                                            throws CSAppFrameworkException
Gives the object type name for a given bean class

Parameters:
beanClass -
Returns:
QName
Throws:
CSAppFrameworkException

getContext

public PersistenceContext getContext()
Returns the persitanceContext

Returns:
PersitanceContext

getBeanPool

public ManagedBeanPool getBeanPool()
Returns the bean pool

Returns:
ManagedBeanPool

getLocale

public java.util.Locale getLocale()
Returns the current locale

Returns:
Locale

getPreviousContextObjectType

public java.lang.String getPreviousContextObjectType()

setPreviousContextObjectType

public void setPreviousContextObjectType(java.lang.String previsousContextObjectType)

getQueryPath

public java.lang.String getQueryPath()

setQueryPath

public void setQueryPath(java.lang.String queryPath)

getNextContextObject

public java.lang.String getNextContextObject()

generateNextContextObject

public java.lang.String generateNextContextObject()

isInFunction

public boolean isInFunction()

setIsInFunction

public void setIsInFunction(boolean isInFunction)

getPrologExtension

public java.lang.String getPrologExtension()

addPrologExtension

public void addPrologExtension(java.lang.String prologExtension)
Adds a prologExtension to a String of prolog extensions. They should be set to the BusinessQuery by using setPrologExtension(String) so the can be set in the query when needed

Parameters:
prologExtension -

getLocalFunctionCount

public int getLocalFunctionCount()

setLocalFunctionCount

public void setLocalFunctionCount(int localFunctionCount)

setNextFunctionCount

public void setNextFunctionCount()