atg.svc.repository.beans
Interface KnowledgeQueryPredicate

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_KnowledgeQueryPredicate_BeanImpl, _KnowledgeQueryPredicate_Impl, _KnowledgeQueryPredicate_ReposImpl

public interface KnowledgeQueryPredicate
extends javax.ejb.EJBLocalObject

Class KnowledgeQueryPredicate

• Home: KnowledgeQueryPredicateHome
• 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	[:KnowledgeQuery.predicates]

Property Summaries

Property Name	Property Type	Property Description	Flags
booleanValue	boolean		R, W, Cch, Qry
caseInsensitive	boolean		R, W, Cch, Qry
dateMax	Date		R, W, Cch, Qry
dateMin	Date		R, W, Cch, Qry
fieldName	String		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
numberMax	float		R, W, Cch, Qry
numberMin	float		R, W, Cch, Qry
operator	KnowledgeQueryPredicateOperator		R, W, Cch, Qry, Req
predicateType	KnowledgeQueryPredicatePredicateType		R, W, Cch, Qry, Req
query	KnowledgeQuery		R, W, Cch, Qry, Req
textValues	List		R, W, Cch, CoM, Mv, Qry
valueType	KnowledgeQueryPredicateValueType		R, W, Cch, Qry, Req

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 booleanValue: boolean

• Getter: isBooleanValue()
• Setter: setBooleanValue(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: booleanvalue

Property caseInsensitive: boolean

• Getter: isCaseInsensitive()
• Setter: setCaseInsensitive(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: caseinsensitive

Property dateMax: Date

• Getter: getDateMax()
• Setter: setDateMax(java.util.Date)
• Flags: readable, writable, cacheable, queryable
• Type Name: date
• Sort String: datemax

Property dateMin: Date

• Getter: getDateMin()
• Setter: setDateMin(java.util.Date)
• Flags: readable, writable, cacheable, queryable
• Type Name: date
• Sort String: datemin

Property fieldName: String

• Getter: getFieldName()
• Setter: setFieldName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: fieldname

Property id: String

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

Property numberMax: float

• Getter: getNumberMax()
• Setter: setNumberMax(float)
• Flags: readable, writable, cacheable, queryable
• Type Name: float
• Sort String: numbermax

Property numberMin: float

• Getter: getNumberMin()
• Setter: setNumberMin(float)
• Flags: readable, writable, cacheable, queryable
• Type Name: float
• Sort String: numbermin

Property operator: KnowledgeQueryPredicateOperator

• Getter: getOperator()
• Setter: setOperator(atg.svc.repository.beans.KnowledgeQueryPredicateOperator)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: operator
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property predicateType: KnowledgeQueryPredicatePredicateType

• Getter: getPredicateType()
• Setter: setPredicateType(atg.svc.repository.beans.KnowledgeQueryPredicatePredicateType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: predicatetype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property query: KnowledgeQuery

• Getter: getQuery()
• Setter: setQuery(atg.svc.repository.beans.KnowledgeQuery)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: query

Property textValues: List

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

Property valueType: KnowledgeQueryPredicateValueType

• Getter: getValueType()
• Setter: setValueType(atg.svc.repository.beans.KnowledgeQueryPredicateValueType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: valuetype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(KnowledgeQueryPredicate destination) Copies the property values of this instance to another instance of the same data type.
java.util.Date	getDateMax() Getter for property dateMax
java.util.Date	getDateMin() Getter for property dateMin
java.lang.String	getFieldName() Getter for property fieldName
boolean	getHasBooleanValue() Returns true if the value of property booleanValue is null.
boolean	getHasCaseInsensitive() Returns true if the value of property caseInsensitive is null.
boolean	getHasNumberMax() Returns true if the value of property numberMax is null.
boolean	getHasNumberMin() Returns true if the value of property numberMin is null.
java.lang.String	getId() Getter for property id
float	getNumberMax() Getter for property numberMax
float	getNumberMin() Getter for property numberMin
KnowledgeQueryPredicateOperator	getOperator() Getter for property operator
KnowledgeQueryPredicatePredicateType	getPredicateType() Getter for property predicateType
KnowledgeQuery	getQuery() Getter for property query
java.util.List	getTextValues() Getter for property textValues
KnowledgeQueryPredicateValueType	getValueType() Getter for property valueType
boolean	isBooleanValue() Getter for property booleanValue
boolean	isCaseInsensitive() Getter for property caseInsensitive
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	setBooleanValue(boolean value) Setter for property booleanValue .
void	setCaseInsensitive(boolean value) Setter for property caseInsensitive .
void	setDateMax(java.util.Date value) Setter for property dateMax .
void	setDateMin(java.util.Date value) Setter for property dateMin .
void	setFieldName(java.lang.String value) Setter for property fieldName .
void	setHasBooleanValue(boolean value) If this is set to false, then the underlying value of property booleanValue is set to null.
void	setHasCaseInsensitive(boolean value) If this is set to false, then the underlying value of property caseInsensitive is set to null.
void	setHasNumberMax(boolean value) If this is set to false, then the underlying value of property numberMax is set to null.
void	setHasNumberMin(boolean value) If this is set to false, then the underlying value of property numberMin is set to null.
void	setId(java.lang.String value) Setter for property id .
void	setNumberMax(float value) Setter for property numberMax .
void	setNumberMin(float value) Setter for property numberMin .
void	setOperator(KnowledgeQueryPredicateOperator value) Setter for property operator .
void	setPredicateType(KnowledgeQueryPredicatePredicateType value) Setter for property predicateType .
void	setQuery(KnowledgeQuery value) Setter for property query .
void	setTextValues(java.util.List value) Setter for property textValues .
void	setValueType(KnowledgeQueryPredicateValueType value) Setter for property valueType .
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

isBooleanValue

boolean isBooleanValue()
                       throws javax.ejb.EJBException

Getter for property booleanValue

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasBooleanValue

boolean getHasBooleanValue()
                           throws javax.ejb.EJBException

Returns true if the value of property booleanValue is null.

Throws:

javax.ejb.EJBException

setBooleanValue

void setBooleanValue(boolean value)
                     throws javax.ejb.EJBException

Setter for property booleanValue . 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 - boolean

Throws:

javax.ejb.EJBException

setHasBooleanValue

void setHasBooleanValue(boolean value)
                        throws javax.ejb.EJBException

If this is set to false, then the underlying value of property booleanValue is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

isCaseInsensitive

boolean isCaseInsensitive()
                          throws javax.ejb.EJBException

Getter for property caseInsensitive

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasCaseInsensitive

boolean getHasCaseInsensitive()
                              throws javax.ejb.EJBException

Returns true if the value of property caseInsensitive is null.

Throws:

javax.ejb.EJBException

setCaseInsensitive

void setCaseInsensitive(boolean value)
                        throws javax.ejb.EJBException

Setter for property caseInsensitive . 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 - boolean

Throws:

javax.ejb.EJBException

setHasCaseInsensitive

void setHasCaseInsensitive(boolean value)
                           throws javax.ejb.EJBException

If this is set to false, then the underlying value of property caseInsensitive is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getDateMax

java.util.Date getDateMax()
                          throws javax.ejb.EJBException

Getter for property dateMax

Returns:

Date

Throws:

javax.ejb.EJBException

setDateMax

void setDateMax(java.util.Date value)
                throws javax.ejb.EJBException

Setter for property dateMax . 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 - Date

Throws:

javax.ejb.EJBException

getDateMin

java.util.Date getDateMin()
                          throws javax.ejb.EJBException

Getter for property dateMin

Returns:

Date

Throws:

javax.ejb.EJBException

setDateMin

void setDateMin(java.util.Date value)
                throws javax.ejb.EJBException

Setter for property dateMin . 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 - Date

Throws:

javax.ejb.EJBException

getFieldName

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

Getter for property fieldName

Returns:

String

Throws:

javax.ejb.EJBException

setFieldName

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

Setter for property fieldName . 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

getNumberMax

float getNumberMax()
                   throws javax.ejb.EJBException

Getter for property numberMax

Returns:

float

Throws:

javax.ejb.EJBException

getHasNumberMax

boolean getHasNumberMax()
                        throws javax.ejb.EJBException

Returns true if the value of property numberMax is null.

Throws:

javax.ejb.EJBException

setNumberMax

void setNumberMax(float value)
                  throws javax.ejb.EJBException

Setter for property numberMax . 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 - float

Throws:

javax.ejb.EJBException

setHasNumberMax

void setHasNumberMax(boolean value)
                     throws javax.ejb.EJBException

If this is set to false, then the underlying value of property numberMax is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getNumberMin

float getNumberMin()
                   throws javax.ejb.EJBException

Getter for property numberMin

Returns:

float

Throws:

javax.ejb.EJBException

getHasNumberMin

boolean getHasNumberMin()
                        throws javax.ejb.EJBException

Returns true if the value of property numberMin is null.

Throws:

javax.ejb.EJBException

setNumberMin

void setNumberMin(float value)
                  throws javax.ejb.EJBException

Setter for property numberMin . 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 - float

Throws:

javax.ejb.EJBException

setHasNumberMin

void setHasNumberMin(boolean value)
                     throws javax.ejb.EJBException

If this is set to false, then the underlying value of property numberMin is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getOperator

KnowledgeQueryPredicateOperator getOperator()
                                            throws javax.ejb.EJBException

Getter for property operator

Returns:

KnowledgeQueryPredicateOperator

Throws:

javax.ejb.EJBException

setOperator

void setOperator(KnowledgeQueryPredicateOperator value)
                 throws javax.ejb.EJBException

Setter for property operator . 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 - KnowledgeQueryPredicateOperator

Throws:

javax.ejb.EJBException

getPredicateType

KnowledgeQueryPredicatePredicateType getPredicateType()
                                                      throws javax.ejb.EJBException

Getter for property predicateType

Returns:

KnowledgeQueryPredicatePredicateType

Throws:

javax.ejb.EJBException

setPredicateType

void setPredicateType(KnowledgeQueryPredicatePredicateType value)
                      throws javax.ejb.EJBException

Setter for property predicateType . 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 - KnowledgeQueryPredicatePredicateType

Throws:

javax.ejb.EJBException

getQuery

KnowledgeQuery getQuery()
                        throws javax.ejb.EJBException

Getter for property query

Returns:

KnowledgeQuery

Throws:

javax.ejb.EJBException

setQuery

void setQuery(KnowledgeQuery value)
              throws javax.ejb.EJBException

Setter for property query . 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 - KnowledgeQuery

Throws:

javax.ejb.EJBException

getTextValues

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

Getter for property textValues

Returns:

List

Throws:

javax.ejb.EJBException

setTextValues

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

Setter for property textValues . 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

getValueType

KnowledgeQueryPredicateValueType getValueType()
                                              throws javax.ejb.EJBException

Getter for property valueType

Returns:

KnowledgeQueryPredicateValueType

Throws:

javax.ejb.EJBException

setValueType

void setValueType(KnowledgeQueryPredicateValueType value)
                  throws javax.ejb.EJBException

Setter for property valueType . 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 - KnowledgeQueryPredicateValueType

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(KnowledgeQueryPredicate 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.