atg.svc.repository.service
Class QueryService

java.lang.Object
  atg.nucleus.GenericService
      atg.svc.repository.service.BaseService
          atg.svc.repository.service.SharedService
              atg.svc.repository.service.QueryService

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

public class QueryService
extends SharedService

Business methods for atg.svc.repository.beans.shared.KnowledgeQuery objects. A KnowledgeQuery is a search or browse recorded either as part of a KnowledgeSession or as a FavoriteQuery

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.svc.repository.service.BaseService

mBeanHomes, mBeanHomesName, mRepositoryHomes, mRepositoryHomesName

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

QueryService()

Method Summary

KnowledgeQueryPredicate	createBooleanPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.lang.Boolean pValue) Creates a predicate r2j bean for a boolean field.
KnowledgeQueryPredicate	createDatePredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.util.Date pValue) Creates a predicate r2j bean for a timestamp field.
KnowledgeQueryPredicate	createDateRangePredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.util.Date pMaxDate, java.util.Date pMinDate) Creates a range predicate r2j bean for a timestamp field.
KnowledgeQueryPredicate	createEnumListPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.util.List pEnumListIds) Creates a predicate r2j bean for a list of enumerated list field valuess.
KnowledgeQueryPredicate	createKeywordPredicate(java.lang.String pFieldName, KnowledgeQueryPredicateOperator pOperator, java.lang.String pKeywordString) Creates a predicate r2j bean for a keyword expression.
java.util.List	createKeywordPredicates(java.lang.String pAnyOfKeywords, java.lang.String pAllOfKeywords, java.lang.String pNoneOfKeywords) Creates up to 3 keyword predicates - one each of type anyOf, allOf and/or noneOf.
KnowledgeQueryPredicate	createNumberPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.lang.Float pValue) Creates a predicate r2j bean for a numeric field.
KnowledgeQueryPredicate	createNumberRangePredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, float pUpperValue, float pLowerValue) Creates a range predicate r2j bean for a numeric field.
KnowledgeQueryPredicate	createOrganizationPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.util.List pOrganizationIds) Creates a predicate r2j bean for a list of organizations.
KnowledgeQueryPredicate	createPredicateFromSearchContext(KnowledgeQueryPredicate pSearchPredicate) Copy an atg.svc.search.KnowledgeQueryPredicateImpl to a RJRepositoryBean so we can save the search query.
KnowledgeQueryPredicate	createSegmentPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.util.List pSegmentIds) Creates a predicate r2j bean for a list of segments.
KnowledgeQueryPredicate	createTextMatchPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, boolean pMatchCase, java.util.List pTextValues) Creates a predicate r2j bean for a list of text values.
KnowledgeQueryPredicate	createTextMatchPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, boolean pMatchCase, java.lang.String pTextValue) Creates a predicate r2j bean for a list of text values.
KnowledgeQueryPredicate	createTopicPredicate(KnowledgeQueryPredicateOperator pOperator, java.util.List pTopicIds) Creates a predicate r2j bean for a list of topics.
KnowledgeQueryPredicate	createUserPredicate(java.lang.String pFieldName, KnowledgeQueryPredicatePredicateType pPredType, KnowledgeQueryPredicateOperator pOperator, java.util.List pUserIds) Creates a predicate r2j bean for a list of users.
KnowledgeQuery	findQueryByPrimaryKey(java.lang.String pQueryId) Returns the repository object for the given KnowledgeQuery object.
KnowledgeQueryPredicate	getPredicateByType(KnowledgeQuery pQuery, KnowledgeQueryPredicateValueType pValueType) Returns the first predicate found of the specified predicate type.
SessionService	getSessionService() Set via configuration property
atg.svc.ticketing.TicketHolder	getTicketHolder()
java.lang.String	getTicketHolderNucleusPath()
void	setSessionService(SessionService pSessionService)
void	setTicketHolderNucleusPath(java.lang.String pTicketHolderNucleusPath)

Methods inherited from class atg.svc.repository.service.SharedService

getBeanHomes, getRepositoryHomes

Methods inherited from class atg.svc.repository.service.BaseService

getBaseBeanHomes, getBaseRepositoryHomes, getBeanHomesName, getRepositoryHomesName, getRepositoryService, getToday, setBeanHomesName, setRepositoryHomesName, setRepositoryService

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingWarning, setServiceInfo, startService, stopService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

QueryService

public QueryService()

Method Detail

getSessionService

public SessionService getSessionService()

Set via configuration property

setSessionService

public void setSessionService(SessionService pSessionService)

getTicketHolderNucleusPath

public java.lang.String getTicketHolderNucleusPath()

setTicketHolderNucleusPath

public void setTicketHolderNucleusPath(java.lang.String pTicketHolderNucleusPath)

getTicketHolder

public atg.svc.ticketing.TicketHolder getTicketHolder()

findQueryByPrimaryKey

public KnowledgeQuery findQueryByPrimaryKey(java.lang.String pQueryId)
                                     throws ObjectNotFoundException

Returns the repository object for the given KnowledgeQuery object.

Parameters:

pQueryId - The repository id.

Returns:

The Query RJReposistoryObject

Throws:

ObjectNotFoundException - If the id is not found.

createBooleanPredicate

public KnowledgeQueryPredicate createBooleanPredicate(java.lang.String pFieldName,
                                                      KnowledgeQueryPredicatePredicateType pPredType,
                                                      KnowledgeQueryPredicateOperator pOperator,
                                                      java.lang.Boolean pValue)
                                               throws javax.ejb.CreateException,
                                                      ObjectNotFoundException

Creates a predicate r2j bean for a boolean field. The bean is not committed until you call saveQuery

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - query parameter, instrinsic field or custom field

pOperator - valid operations are equal, notEqual

pValue - The boolean value to constrain against. A null value means look for all solutions with no value specified for this field.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createKeywordPredicates

public java.util.List createKeywordPredicates(java.lang.String pAnyOfKeywords,
                                              java.lang.String pAllOfKeywords,
                                              java.lang.String pNoneOfKeywords)
                                       throws javax.ejb.CreateException,
                                              ObjectNotFoundException

Creates up to 3 keyword predicates - one each of type anyOf, allOf and/or noneOf. To omit a predicate, pass a null value for that input parameter.

Parameters:

pAnyOfKeywords - - anyof expression

pAllOfKeywords - - allof expression

pNoneOfKeywords - - noneof expressoin

Returns:

A list of keyword KnowledgeQueryPredicates - one is created for each non-null keyword input parameter.

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createNumberPredicate

public KnowledgeQueryPredicate createNumberPredicate(java.lang.String pFieldName,
                                                     KnowledgeQueryPredicatePredicateType pPredType,
                                                     KnowledgeQueryPredicateOperator pOperator,
                                                     java.lang.Float pValue)
                                              throws javax.ejb.CreateException,
                                                     ObjectNotFoundException

Creates a predicate r2j bean for a numeric field. The bean is not committed until you call saveQuery.

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - query parameter, instrinsic field or custom field

pOperator - valid operations are equal, notEqual, greatereq, greater, lesseq, less

pValue - Number to compare against. A null value means look for all solutions with no value specified for this field.

pLowerValue - Lower bound of the range. Ignored if equal or notEqual are used.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createNumberRangePredicate

public KnowledgeQueryPredicate createNumberRangePredicate(java.lang.String pFieldName,
                                                          KnowledgeQueryPredicatePredicateType pPredType,
                                                          KnowledgeQueryPredicateOperator pOperator,
                                                          float pUpperValue,
                                                          float pLowerValue)
                                                   throws javax.ejb.CreateException,
                                                          ObjectNotFoundException

Creates a range predicate r2j bean for a numeric field. The bean is not committed until you call saveQuery.

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - query parameter, instrinsic field or custom field

pOperator - valid operations are within (inclusive) and between (exlusive)

pUpperValue - Upper bound of the range.

pLowerValue - Lower bound of the range.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createDatePredicate

public KnowledgeQueryPredicate createDatePredicate(java.lang.String pFieldName,
                                                   KnowledgeQueryPredicatePredicateType pPredType,
                                                   KnowledgeQueryPredicateOperator pOperator,
                                                   java.util.Date pValue)
                                            throws javax.ejb.CreateException,
                                                   ObjectNotFoundException

Creates a predicate r2j bean for a timestamp field. The bean is not committed until you call saveQuery.

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - query parameter, instrinsic field or custom field

pOperator - valid operations are equal, notEqual, greatereq, greater, lesseq, less

pValue - Timestamp to compare against. A null value means look for all solutions with no value specified for this field.

pLowerValue - Lower bound of the range. Ignored if equal or notEqual are used.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createDateRangePredicate

public KnowledgeQueryPredicate createDateRangePredicate(java.lang.String pFieldName,
                                                        KnowledgeQueryPredicatePredicateType pPredType,
                                                        KnowledgeQueryPredicateOperator pOperator,
                                                        java.util.Date pMaxDate,
                                                        java.util.Date pMinDate)
                                                 throws javax.ejb.CreateException,
                                                        ObjectNotFoundException

Creates a range predicate r2j bean for a timestamp field. The bean is not committed until you call saveQuery.

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - query parameter, instrinsic field or custom field

pOperator - valid operations are within (inclusive) and between (exlusive)

pUpperValue - Upper bound of the range.

pLowerValue - Lower bound of the range.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createTopicPredicate

public KnowledgeQueryPredicate createTopicPredicate(KnowledgeQueryPredicateOperator pOperator,
                                                    java.util.List pTopicIds)
                                             throws javax.ejb.CreateException,
                                                    ObjectNotFoundException

Creates a predicate r2j bean for a list of topics. The bean is not committed until you call saveQuery

Parameters:

pOperator - Valid values are anyOf, allOf, noneOf

pTopicIds - A list of topic ids (List of String). An empty or null list means look for solutions with no value.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createEnumListPredicate

public KnowledgeQueryPredicate createEnumListPredicate(java.lang.String pFieldName,
                                                       KnowledgeQueryPredicatePredicateType pPredType,
                                                       KnowledgeQueryPredicateOperator pOperator,
                                                       java.util.List pEnumListIds)
                                                throws javax.ejb.CreateException,
                                                       ObjectNotFoundException

Creates a predicate r2j bean for a list of enumerated list field valuess. The bean is not committed until you call saveQuery

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - instrinsic field or custom field

pOperator - Valid values are anyOf, allOf, noneOf

pTopicIds - A list of enumerated list field value ids (List of String). An empty or null list means look for solutions with no value.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createUserPredicate

public KnowledgeQueryPredicate createUserPredicate(java.lang.String pFieldName,
                                                   KnowledgeQueryPredicatePredicateType pPredType,
                                                   KnowledgeQueryPredicateOperator pOperator,
                                                   java.util.List pUserIds)
                                            throws javax.ejb.CreateException,
                                                   ObjectNotFoundException

Creates a predicate r2j bean for a list of users. The bean is not committed until you call saveQuery

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - instrinsic field or custom field

pOperator - Valid values are anyOf, allOf, noneOf

pUserIds - A list of user profile ids (List of String). An empty or null list means look for solutions with no value.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createOrganizationPredicate

public KnowledgeQueryPredicate createOrganizationPredicate(java.lang.String pFieldName,
                                                           KnowledgeQueryPredicatePredicateType pPredType,
                                                           KnowledgeQueryPredicateOperator pOperator,
                                                           java.util.List pOrganizationIds)
                                                    throws javax.ejb.CreateException,
                                                           ObjectNotFoundException

Creates a predicate r2j bean for a list of organizations. The bean is not committed until you call saveQuery

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - instrinsic field or custom field

pOperator - Valid values are anyOf, allOf, noneOf

pOrganizationIds - A list of organization ids (List of String). An empty or null list means look for solutions with no value.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createSegmentPredicate

public KnowledgeQueryPredicate createSegmentPredicate(java.lang.String pFieldName,
                                                      KnowledgeQueryPredicatePredicateType pPredType,
                                                      KnowledgeQueryPredicateOperator pOperator,
                                                      java.util.List pSegmentIds)
                                               throws javax.ejb.CreateException,
                                                      ObjectNotFoundException

Creates a predicate r2j bean for a list of segments. The bean is not committed until you call saveQuery

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - instrinsic field or custom field

pOperator - Valid values are anyOf, allOf, noneOf

pSegmentIds - A list of segment ids (List of String). An empty or null list means look for solutions with no value.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createKeywordPredicate

public KnowledgeQueryPredicate createKeywordPredicate(java.lang.String pFieldName,
                                                      KnowledgeQueryPredicateOperator pOperator,
                                                      java.lang.String pKeywordString)
                                               throws javax.ejb.CreateException,
                                                      ObjectNotFoundException

Creates a predicate r2j bean for a keyword expression. The bean is not committed until you call saveQuery

Parameters:

pFieldName - Name of the intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pOperator - Valid values are anyOf, allOf, noneOf

pKeywordString - A keyword expression. See the "ATG Search Technology" developer's guide for the keyword syntax.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createTextMatchPredicate

public KnowledgeQueryPredicate createTextMatchPredicate(java.lang.String pFieldName,
                                                        KnowledgeQueryPredicatePredicateType pPredType,
                                                        KnowledgeQueryPredicateOperator pOperator,
                                                        boolean pMatchCase,
                                                        java.lang.String pTextValue)
                                                 throws javax.ejb.CreateException,
                                                        ObjectNotFoundException

Creates a predicate r2j bean for a list of text values. The bean is not committed until you call saveQuery NOTE: This can be used to apply meta tag constraints in the AS query parameters.

Parameters:

pFieldName - Name of the query parameter, intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - query parameter, instrinsic field or custom field

pOperator - Valid values are equal, notEqual, starts, ends, contains

pMatchCase - true if match is case insensitive, false if case sensitive

pTextValue - A list of text values (List of String). An empty or null list means look for solutions with no value.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

createTextMatchPredicate

public KnowledgeQueryPredicate createTextMatchPredicate(java.lang.String pFieldName,
                                                        KnowledgeQueryPredicatePredicateType pPredType,
                                                        KnowledgeQueryPredicateOperator pOperator,
                                                        boolean pMatchCase,
                                                        java.util.List pTextValues)
                                                 throws javax.ejb.CreateException,
                                                        ObjectNotFoundException

Creates a predicate r2j bean for a list of text values. The bean is not committed until you call saveQuery NOTE: This can be used to apply meta tag constraints in the AS query parameters.

Parameters:

pFieldName - Name of the query parameter, intrinsic or custom field. For intrinsic fields, the name is the property name of the intrinsic field in the solution repository item.

pPredType - query parameter, instrinsic field or custom field

pOperator - Valid values are anyOf, allOf, noneOf

pMatchCase - true if match is case insensitive, false if case sensitive

pTextValues - A list of text values (List of String). An empty or null list means look for solutions with no value.

Returns:

A new KnowledgeQueryPredicate r2j bean

Throws:

javax.ejb.CreateException

ObjectNotFoundException

getPredicateByType

public KnowledgeQueryPredicate getPredicateByType(KnowledgeQuery pQuery,
                                                  KnowledgeQueryPredicateValueType pValueType)

Returns the first predicate found of the specified predicate type. NOTE: A query generally only has one predicate of each type. However, that's not strictly required. If your query may have multiple predicates of the same type, you should call KnowledgeQuery.getPredicates() and iterate thru the predicates looking for all predicates that match the desired predicate type.

Parameters:

pQuery - The query we're looking at for predicates

pValueType - The predicate value type we're looking for

Returns:

Returns the first predicate matching the predicate type or null if no predicates of that type were found.

See Also:

KnowledgeQuery, atg.svc.repository.beans.KnowledgeQueryValueType

createPredicateFromSearchContext

public KnowledgeQueryPredicate createPredicateFromSearchContext(KnowledgeQueryPredicate pSearchPredicate)
                                                         throws javax.ejb.CreateException

Copy an atg.svc.search.KnowledgeQueryPredicateImpl to a RJRepositoryBean so we can save the search query. Called from SearchService on a search to save a search query.

Parameters:

pSearchPredicate - A KnowledgeQueryPredicateImpl that implements the KnowledgeQueryPredicate interface.

Returns:

A RJRepositoryBean object that can be passed into saveQuery.

Throws:

javax.ejb.CreateException