atg.svc.repository.beans
Interface FavoriteQuery

All Superinterfaces:

javax.ejb.EJBLocalObject, KnowledgeQuery

All Known Implementing Classes:

_FavoriteQuery_BeanImpl, _FavoriteQuery_Impl, _FavoriteQuery_ReposImpl

public interface FavoriteQuery
extends javax.ejb.EJBLocalObject, KnowledgeQuery

Class FavoriteQuery

• Home: FavoriteQueryHome
• 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

Property Summaries

Property Name	Property Type	Property Description	Flags
browseTopicId	String		R, W, Cch, Qry
description	String		R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
name	String		R, W, Cch, Qry, Req
organizationIds	Set		R, W, Cch, CoM, Mv, Qry
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
type	FavoriteQueryType		R, W, Cch, Qry, Req
userId	String		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 browseTopicId: String

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

Property description: String

• Getter: getDescription()
• Setter: setDescription(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: description

Property id: String

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

Property name: String

• Getter: getName()
• Setter: setName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: name

Property organizationIds: Set

• Getter: getOrganizationIds()
• Setter: setOrganizationIds(java.util.Set)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: organizationids

Property predicates: Set of KnowledgeQueryPredicate

• Getter: KnowledgeQuery.getPredicates()
• Setter: KnowledgeQuery.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: KnowledgeQuery.getQueryDate()
• Setter: KnowledgeQuery.setQueryDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: 2011-03-30 23:20:21.459
• Type Name: timestamp
• Sort String: querydate
• Attributes:

  Attribute Name	Attribute Value
  useNowForDefault	true

Property queryType: KnowledgeQueryQueryType

• Getter: KnowledgeQuery.getQueryType()
• Setter: KnowledgeQuery.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: KnowledgeQuery.getSearchRequestType()
• Setter: KnowledgeQuery.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: KnowledgeQuery.getSearchTextValues()
• Setter: KnowledgeQuery.setSearchTextValues(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: searchtextvalues

Property type: FavoriteQueryType

• Getter: getType()
• Setter: setType(atg.svc.repository.beans.FavoriteQueryType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: type
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property userId: String

• Getter: getUserId()
• Setter: setUserId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: userid

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(FavoriteQuery destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getDescription() Getter for property description
java.lang.String	getId() Getter for property id
java.lang.String	getName() Getter for property name
java.util.Set	getOrganizationIds() Getter for property organizationIds
FavoriteQueryType	getType() Getter for property type
java.lang.String	getUserId() Getter for property userId
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	setDescription(java.lang.String value) Setter for property description .
void	setId(java.lang.String value) Setter for property id .
void	setName(java.lang.String value) Setter for property name .
void	setOrganizationIds(java.util.Set value) Setter for property organizationIds .
void	setType(FavoriteQueryType value) Setter for property type .
void	setUserId(java.lang.String value) Setter for property userId .
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 atg.svc.repository.beans.KnowledgeQuery

copyTo, getBrowseTopicId, getPredicates, getQueryDate, getQueryType, getSearchRequestType, getSearchTextValues, setBrowseTopicId, setPredicates, setQueryDate, setQueryType, setSearchRequestType, setSearchTextValues

Method Detail

getDescription

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

Getter for property description

Returns:

String

Throws:

javax.ejb.EJBException

setDescription

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

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

Specified by:

getId in interface KnowledgeQuery

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.

Specified by:

setId in interface KnowledgeQuery

Parameters:

value - String

Throws:

javax.ejb.EJBException

getName

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

Getter for property name

Returns:

String

Throws:

javax.ejb.EJBException

setName

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

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

getOrganizationIds

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

Getter for property organizationIds

Returns:

Set

Throws:

javax.ejb.EJBException

setOrganizationIds

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

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

Throws:

javax.ejb.EJBException

getType

FavoriteQueryType getType()
                          throws javax.ejb.EJBException

Getter for property type

Returns:

FavoriteQueryType

Throws:

javax.ejb.EJBException

setType

void setType(FavoriteQueryType value)
             throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getUserId

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

Getter for property userId

Returns:

String

Throws:

javax.ejb.EJBException

setUserId

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

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

isRemoved

boolean isRemoved()
                  throws javax.ejb.EJBException

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

Specified by:

isRemoved in interface KnowledgeQuery

Throws:

javax.ejb.EJBException

copyTo

void copyTo(FavoriteQuery 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.

Specified by:

writeInstance in interface KnowledgeQuery

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.

Specified by:

prepareInstanceForWrite in interface KnowledgeQuery

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.

Specified by:

_isMutable in interface KnowledgeQuery