atg.svc.repository.beans
Interface RecommendedAnswer

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_RecommendedAnswer_BeanImpl, _RecommendedAnswer_Impl, _RecommendedAnswer_ReposImpl

public interface RecommendedAnswer
extends javax.ejb.EJBLocalObject

Class RecommendedAnswer

• Home: RecommendedAnswerHome
• 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	[/atg/svc/ServiceRepository:Solution.recommendedAnswers, :KnowledgeSession.linkedDocuments, :KnowledgeSession.rejectedDocuments]
  updateLastActivity	true

Property Summaries

Property Name	Property Type	Property Description	Flags
contextId	String		R, W, Cch, Qry
createdBy	String		R, W, Cch, Qry, Req
dateCreated	Date		R, W, Cch, Qry, Req
dateModified	Date		R, W, Cch, Qry, Req
docId	String		R, Cch, Drv, Qry
docType	RecommendedAnswerDocType		R, W, Cch, Qry, Req
excerpt	String		R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
modifiedBy	String		R, W, Cch, Qry, Req
solutionId	String		R, W, Cch, Qry
solutionVersion	String		R, W, Cch, Qry
state	RecommendedAnswerState		R, W, Cch, Qry, Req, Hdn
ticket	RepositoryItem		R, W, Cch, Qry
title	String		R, W, Cch, Qry, Req
url	String		R, W, Cch, 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 contextId: String

• Getter: getContextId()
• Setter: setContextId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: contextid

Property createdBy: String

• Getter: getCreatedBy()
• Setter: setCreatedBy(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: createdby

Property dateCreated: Date

• Getter: getDateCreated()
• Setter: setDateCreated(java.util.Date)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: date
• Sort String: datecreated

Property dateModified: Date

• Getter: getDateModified()
• Setter: setDateModified(java.util.Date)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: date
• Sort String: datemodified

Property docId: String

• Getter: getDocId()
• Flags: readable, cacheable, derived, queryable
• Type Name: string
• Sort String: docid

Property docType: RecommendedAnswerDocType

• Getter: getDocType()
• Setter: setDocType(atg.svc.repository.beans.RecommendedAnswerDocType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: doctype

Property excerpt: String

• Getter: getExcerpt()
• Setter: setExcerpt(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: excerpt

Property id: String

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

Property modifiedBy: String

• Getter: getModifiedBy()
• Setter: setModifiedBy(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: modifiedby

Property solutionId: String

• Getter: getSolutionId()
• Setter: setSolutionId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: solutionid

Property solutionVersion: String

• Getter: getSolutionVersion()
• Setter: setSolutionVersion(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: solutionversion

Property state: RecommendedAnswerState

• Getter: getState()
• Setter: setState(atg.svc.repository.beans.RecommendedAnswerState)
• Flags: readable, writable, cacheable, queryable, required, hidden
• Type Name: enumerated
• Sort String: state
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property ticket: RepositoryItem

• Getter: getTicket()
• Setter: setTicket(atg.repository.RepositoryItem)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: ticket
• Attributes:

  Attribute Name	Attribute Value
  foreignRepositoryName	TicketingRepository

Property title: String

• Getter: getTitle()
• Setter: setTitle(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: title

Property url: String

• Getter: getUrl()
• Setter: setUrl(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: url

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(RecommendedAnswer destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getContextId() Getter for property contextId
java.lang.String	getCreatedBy() Getter for property createdBy
java.util.Date	getDateCreated() Getter for property dateCreated
java.util.Date	getDateModified() Getter for property dateModified
java.lang.String	getDocId() Getter for property docId
RecommendedAnswerDocType	getDocType() Getter for property docType
java.lang.String	getExcerpt() Getter for property excerpt
java.lang.String	getId() Getter for property id
java.lang.String	getModifiedBy() Getter for property modifiedBy
java.lang.String	getSolutionId() Getter for property solutionId
java.lang.String	getSolutionVersion() Getter for property solutionVersion
RecommendedAnswerState	getState() Getter for property state
atg.repository.RepositoryItem	getTicket() Getter for property ticket
java.lang.String	getTitle() Getter for property title
java.lang.String	getUrl() Getter for property url
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	setContextId(java.lang.String value) Setter for property contextId .
void	setCreatedBy(java.lang.String value) Setter for property createdBy .
void	setDateCreated(java.util.Date value) Setter for property dateCreated .
void	setDateModified(java.util.Date value) Setter for property dateModified .
void	setDocType(RecommendedAnswerDocType value) Setter for property docType .
void	setExcerpt(java.lang.String value) Setter for property excerpt .
void	setId(java.lang.String value) Setter for property id .
void	setModifiedBy(java.lang.String value) Setter for property modifiedBy .
void	setSolutionId(java.lang.String value) Setter for property solutionId .
void	setSolutionVersion(java.lang.String value) Setter for property solutionVersion .
void	setState(RecommendedAnswerState value) Setter for property state .
void	setTicket(atg.repository.RepositoryItem value) Setter for property ticket .
void	setTitle(java.lang.String value) Setter for property title .
void	setUrl(java.lang.String value) Setter for property url .
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

getContextId

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

Getter for property contextId

Returns:

String

Throws:

javax.ejb.EJBException

setContextId

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

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

getCreatedBy

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

Getter for property createdBy

Returns:

String

Throws:

javax.ejb.EJBException

setCreatedBy

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

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

getDateCreated

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

Getter for property dateCreated

Returns:

Date

Throws:

javax.ejb.EJBException

setDateCreated

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

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

getDateModified

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

Getter for property dateModified

Returns:

Date

Throws:

javax.ejb.EJBException

setDateModified

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

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

getDocId

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

Getter for property docId

Returns:

String

Throws:

javax.ejb.EJBException

getDocType

RecommendedAnswerDocType getDocType()
                                    throws javax.ejb.EJBException

Getter for property docType

Returns:

RecommendedAnswerDocType

Throws:

javax.ejb.EJBException

setDocType

void setDocType(RecommendedAnswerDocType value)
                throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getExcerpt

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

Getter for property excerpt

Returns:

String

Throws:

javax.ejb.EJBException

setExcerpt

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

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

getModifiedBy

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

Getter for property modifiedBy

Returns:

String

Throws:

javax.ejb.EJBException

setModifiedBy

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

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

getSolutionId

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

Getter for property solutionId

Returns:

String

Throws:

javax.ejb.EJBException

setSolutionId

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

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

getSolutionVersion

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

Getter for property solutionVersion

Returns:

String

Throws:

javax.ejb.EJBException

setSolutionVersion

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

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

getState

RecommendedAnswerState getState()
                                throws javax.ejb.EJBException

Getter for property state

Returns:

RecommendedAnswerState

Throws:

javax.ejb.EJBException

setState

void setState(RecommendedAnswerState value)
              throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getTicket

atg.repository.RepositoryItem getTicket()
                                        throws javax.ejb.EJBException

Getter for property ticket

Returns:

RepositoryItem

Throws:

javax.ejb.EJBException

setTicket

void setTicket(atg.repository.RepositoryItem value)
               throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getTitle

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

Getter for property title

Returns:

String

Throws:

javax.ejb.EJBException

setTitle

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

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

getUrl

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

Getter for property url

Returns:

String

Throws:

javax.ejb.EJBException

setUrl

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

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

Throws:

javax.ejb.EJBException

copyTo

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