atg.svc.repository.beans
Interface KnowledgeQuery

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Subinterfaces:

FavoriteQuery

All Known Implementing Classes:

_FavoriteQuery_BeanImpl, _FavoriteQuery_Impl, _FavoriteQuery_ReposImpl, _KnowledgeQuery_BeanImpl, _KnowledgeQuery_Impl, _KnowledgeQuery_ReposImpl

public interface KnowledgeQuery
extends javax.ejb.EJBLocalObject

Class KnowledgeQuery

• Home: KnowledgeQueryHome
• Flags:
• Attributes:

  Attribute Name	Attribute Value
  atg.repository.query.SupportedQueries	and, comparison, constant, inFolders, includesAny, includes, includesItem, isNull, matchId, not, or, patternMatch, property, propertyOf, unconstrained, patternMatch, textSearch
  references	[:KnowledgeSession.queries, :KnowledgeQueryPredicate.query]

Property Summaries

Property Name	Property Type	Property Description	Flags
browseTopicId	String		R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
predicates	Set of KnowledgeQueryPredicate		R, W, CsD, CsU, Cch, CoM, Mv, Qry
queryDate	Timestamp		R, W, Cch, Qry, Req
queryType	KnowledgeQueryQueryType		R, W, Cch, Qry
searchRequestType	KnowledgeQuerySearchRequestType		R, W, Cch, Qry
searchTextValues	List		R, W, Cch, CoM, Mv, Qry

Flags Key:R=readable, W=writable, CsD=cascadeDelete, CsI=cascadeInsert, CsU=cascadeUpdate, Cch=cacheable, CoM=collectionOrMap, Drv=derived, Id=idProperty, Mv=multivalued, Qry=queryable, Req=required, Exp=expert, Hdn=hidden, Prf=preferred

Property Details

Property browseTopicId: String

• Getter: getBrowseTopicId()
• Setter: setBrowseTopicId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: browsetopicid

Property id: String

• Getter: getId()
• Setter: setId(java.lang.String)
• Flags: readable, writable, cacheable, idProperty, queryable, required
• Type Name: string
• Sort String: id

Property predicates: Set of KnowledgeQueryPredicate

• Getter: getPredicates()
• Setter: setPredicates(java.util.Set)
• Flags: readable, writable, cascadeDelete, cascadeUpdate, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: predicates

Property queryDate: Timestamp

• Getter: getQueryDate()
• Setter: setQueryDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: 2011-03-30 23:20:21.451
• Type Name: timestamp
• Sort String: querydate
• Attributes:

  Attribute Name	Attribute Value
  useNowForDefault	true

Property queryType: KnowledgeQueryQueryType

• Getter: getQueryType()
• Setter: setQueryType(atg.svc.repository.beans.KnowledgeQueryQueryType)
• Flags: readable, writable, cacheable, queryable
• Type Name: enumerated
• Sort String: querytype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property searchRequestType: KnowledgeQuerySearchRequestType

• Getter: getSearchRequestType()
• Setter: setSearchRequestType(atg.svc.repository.beans.KnowledgeQuerySearchRequestType)
• Flags: readable, writable, cacheable, queryable
• Type Name: enumerated
• Sort String: searchrequesttype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property searchTextValues: List

• Getter: getSearchTextValues()
• Setter: setSearchTextValues(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: searchtextvalues

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(KnowledgeQuery destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getBrowseTopicId() Getter for property browseTopicId
java.lang.String	getId() Getter for property id
java.util.Set	getPredicates() Getter for property predicates
java.sql.Timestamp	getQueryDate() Getter for property queryDate
KnowledgeQueryQueryType	getQueryType() Getter for property queryType
KnowledgeQuerySearchRequestType	getSearchRequestType() Getter for property searchRequestType
java.util.List	getSearchTextValues() Getter for property searchTextValues
boolean	isRemoved() Returns true if the underlying object has been removed.
void	prepareInstanceForWrite() This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write.
void	setBrowseTopicId(java.lang.String value) Setter for property browseTopicId .
void	setId(java.lang.String value) Setter for property id .
void	setPredicates(java.util.Set value) Setter for property predicates .
void	setQueryDate(java.sql.Timestamp value) Setter for property queryDate .
void	setQueryType(KnowledgeQueryQueryType value) Setter for property queryType .
void	setSearchRequestType(KnowledgeQuerySearchRequestType value) Setter for property searchRequestType .
void	setSearchTextValues(java.util.List value) Setter for property searchTextValues .
void	writeInstance() This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries.

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

getBrowseTopicId

java.lang.String getBrowseTopicId()
                                  throws javax.ejb.EJBException

Getter for property browseTopicId

Returns:

String

Throws:

javax.ejb.EJBException

setBrowseTopicId

void setBrowseTopicId(java.lang.String value)
                      throws javax.ejb.EJBException

Setter for property browseTopicId . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getId

java.lang.String getId()
                       throws javax.ejb.EJBException

Getter for property id

Returns:

String

Throws:

javax.ejb.EJBException

setId

void setId(java.lang.String value)
           throws javax.ejb.EJBException

Setter for property id . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getPredicates

java.util.Set getPredicates()
                            throws javax.ejb.EJBException

Getter for property predicates

Returns:

Set of KnowledgeQueryPredicate

Throws:

javax.ejb.EJBException

setPredicates

void setPredicates(java.util.Set value)
                   throws javax.ejb.EJBException

Setter for property predicates . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - Set of KnowledgeQueryPredicate

Throws:

javax.ejb.EJBException

getQueryDate

java.sql.Timestamp getQueryDate()
                                throws javax.ejb.EJBException

Getter for property queryDate

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setQueryDate

void setQueryDate(java.sql.Timestamp value)
                  throws javax.ejb.EJBException

Setter for property queryDate . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - Timestamp

Throws:

javax.ejb.EJBException

getQueryType

KnowledgeQueryQueryType getQueryType()
                                     throws javax.ejb.EJBException

Getter for property queryType

Returns:

KnowledgeQueryQueryType

Throws:

javax.ejb.EJBException

setQueryType

void setQueryType(KnowledgeQueryQueryType value)
                  throws javax.ejb.EJBException

Setter for property queryType . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - KnowledgeQueryQueryType

Throws:

javax.ejb.EJBException

getSearchRequestType

KnowledgeQuerySearchRequestType getSearchRequestType()
                                                     throws javax.ejb.EJBException

Getter for property searchRequestType

Returns:

KnowledgeQuerySearchRequestType

Throws:

javax.ejb.EJBException

setSearchRequestType

void setSearchRequestType(KnowledgeQuerySearchRequestType value)
                          throws javax.ejb.EJBException

Setter for property searchRequestType . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - KnowledgeQuerySearchRequestType

Throws:

javax.ejb.EJBException

getSearchTextValues

java.util.List getSearchTextValues()
                                   throws javax.ejb.EJBException

Getter for property searchTextValues

Returns:

List

Throws:

javax.ejb.EJBException

setSearchTextValues

void setSearchTextValues(java.util.List value)
                         throws javax.ejb.EJBException

Setter for property searchTextValues . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - List

Throws:

javax.ejb.EJBException

isRemoved

boolean isRemoved()
                  throws javax.ejb.EJBException

Returns true if the underlying object has been removed. False otherwise.

Throws:

javax.ejb.EJBException

copyTo

void copyTo(KnowledgeQuery destination)
            throws javax.ejb.EJBException

Copies the property values of this instance to another instance of the same data type. Only properties that are both readable and writable are copied. Each property is copied by calling the getter method on the source instance and setting the result in the destination instance using the setter method.

Throws:

javax.ejb.EJBException

writeInstance

void writeInstance()
                   throws javax.ejb.EJBException

This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries. Changes might be made visible before calling this method, but this is not guaranteed until this method is called.

Throws:

javax.ejb.EJBException

prepareInstanceForWrite

void prepareInstanceForWrite()
                             throws javax.ejb.EJBException

This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write. This must be called before that first read.

Throws:

javax.ejb.EJBException

_isMutable

boolean _isMutable()

Returns true if the item is mutable. Items are only mutable after a setter method or prepareInstanceForWrite is called.