atg.svc.repository.beans
Interface KnowledgeSession

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_KnowledgeSession_BeanImpl, _KnowledgeSession_Impl, _KnowledgeSession_ReposImpl

public interface KnowledgeSession
extends javax.ejb.EJBLocalObject

Class KnowledgeSession

• Home: KnowledgeSessionHome
• 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
id	String		R, W, Cch, Id, Qry, Req
linkedDocuments	Set of RecommendedAnswer		R, W, Cch, CoM, Mv, Qry
queries	List of KnowledgeQuery		R, W, CsD, Cch, CoM, Mv, Qry
rejectedDocuments	Set of RecommendedAnswer		R, W, Cch, CoM, Mv, Qry
sessionEndDate	Timestamp		R, W, Cch, Qry
sessionStartDate	Timestamp		R, W, Cch, Qry, Req
ticketId	String		R, W, Cch, Qry
userId	String		R, W, Cch, Qry, Req
viewedAnswers	List of ViewedAnswer		R, W, CsD, 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 id: String

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

Property linkedDocuments: Set of RecommendedAnswer

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

Property queries: List of KnowledgeQuery

• Getter: getQueries()
• Setter: setQueries(java.util.List)
• Flags: readable, writable, cascadeDelete, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: queries

Property rejectedDocuments: Set of RecommendedAnswer

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

Property sessionEndDate: Timestamp

• Getter: getSessionEndDate()
• Setter: setSessionEndDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Type Name: timestamp
• Sort String: sessionenddate

Property sessionStartDate: Timestamp

• Getter: getSessionStartDate()
• Setter: setSessionStartDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: 2011-03-30 23:20:21.465
• Type Name: timestamp
• Sort String: sessionstartdate
• Attributes:

  Attribute Name	Attribute Value
  useNowForDefault	true

Property ticketId: String

• Getter: getTicketId()
• Setter: setTicketId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: ticketid

Property userId: String

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

Property viewedAnswers: List of ViewedAnswer

• Getter: getViewedAnswers()
• Setter: setViewedAnswers(java.util.List)
• Flags: readable, writable, cascadeDelete, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: viewedanswers

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(KnowledgeSession destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getId() Getter for property id
java.util.Set	getLinkedDocuments() Getter for property linkedDocuments
java.util.List	getQueries() Getter for property queries
java.util.Set	getRejectedDocuments() Getter for property rejectedDocuments
java.sql.Timestamp	getSessionEndDate() Getter for property sessionEndDate
java.sql.Timestamp	getSessionStartDate() Getter for property sessionStartDate
java.lang.String	getTicketId() Getter for property ticketId
java.lang.String	getUserId() Getter for property userId
java.util.List	getViewedAnswers() Getter for property viewedAnswers
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	setId(java.lang.String value) Setter for property id .
void	setLinkedDocuments(java.util.Set value) Setter for property linkedDocuments .
void	setQueries(java.util.List value) Setter for property queries .
void	setRejectedDocuments(java.util.Set value) Setter for property rejectedDocuments .
void	setSessionEndDate(java.sql.Timestamp value) Setter for property sessionEndDate .
void	setSessionStartDate(java.sql.Timestamp value) Setter for property sessionStartDate .
void	setTicketId(java.lang.String value) Setter for property ticketId .
void	setUserId(java.lang.String value) Setter for property userId .
void	setViewedAnswers(java.util.List value) Setter for property viewedAnswers .
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

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

getLinkedDocuments

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

Getter for property linkedDocuments

Returns:

Set of RecommendedAnswer

Throws:

javax.ejb.EJBException

setLinkedDocuments

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

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

Throws:

javax.ejb.EJBException

getQueries

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

Getter for property queries

Returns:

List of KnowledgeQuery

Throws:

javax.ejb.EJBException

setQueries

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

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

Throws:

javax.ejb.EJBException

getRejectedDocuments

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

Getter for property rejectedDocuments

Returns:

Set of RecommendedAnswer

Throws:

javax.ejb.EJBException

setRejectedDocuments

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

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

Throws:

javax.ejb.EJBException

getSessionEndDate

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

Getter for property sessionEndDate

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setSessionEndDate

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

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

getSessionStartDate

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

Getter for property sessionStartDate

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setSessionStartDate

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

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

getTicketId

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

Getter for property ticketId

Returns:

String

Throws:

javax.ejb.EJBException

setTicketId

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

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

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

getViewedAnswers

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

Getter for property viewedAnswers

Returns:

List of ViewedAnswer

Throws:

javax.ejb.EJBException

setViewedAnswers

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

Setter for property viewedAnswers . 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 of ViewedAnswer

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