atg.svc.repository.beans
Interface Solution

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface Solution
extends javax.ejb.EJBLocalObject

Class Solution

• Home: SolutionHome
• 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	[:QOAA.solution]
  updateLastActivity	true

Property Summaries

Property Name	Property Type	Property Description	Flags
audience	String[]		R, W, Cch, Mv, Qry
audienceSorted	Object[]		R, W, Cch, Drv, Mv, Qry
author	String		R, W, Cch, Qry, Req
bestBet	boolean		R, W, Cch, Qry, Req
dateCreated	Timestamp		R, W, Cch, Qry, Req
dateModified	Timestamp		R, W, Cch, Qry
encodedFieldData	String		R, W, Cch, Qry
externallyVisible	boolean		R, W, Cch, Qry
fields	Map with SolutionField values		R, W, Cch, CoM, Mv
id	String		R, W, Cch, Id, Qry, Req
internalAudience	List of OrganizationValue		R, W, Cch, CoM, Mv, Qry
internalAudienceSorted	List of OrganizationValue		R, W, Cch, CoM, Drv, Mv, Qry
language	String		R, W, Cch, Qry, Req
legacyId	String		R, W, Cch, Qry
modifiedBy	String		R, W, Cch, Qry
owningGroup	OrganizationValue		R, W, Cch, Qry
rawTitle	String		R, W, Cch, Qry, Req
recognition	String		R, W, Cch, Qry
recommendedAnswers	List	Gets the most recent recommended answers for the solution based on the modified date.	R, Cch, CoM, Mv
solutionClass	SolutionClass		R, W, Cch, Qry, Req
solutionRelevance	RepositoryItem	Gets the Solution Relevance item.	R, Cch
status	SolutionStatus		R, W, Cch, Qry
topicIds	Set		R, W, Cch, CoM, Mv, Qry
topicPaths	Set	Gets the set of Topic Paths	R, Cch, CoM, Mv

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 audience: String[]

• Getter: getAudience()
• Setter: setAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@2a801059
• Type Name: array
• Sort String: audience
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property audienceSorted: Object[]

• Getter: getAudienceSorted()
• Setter: setAudienceSorted(java.lang.Object[])
• Flags: readable, writable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: audiencesorted

Property author: String

• Getter: getAuthor()
• Setter: setAuthor(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: author
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property bestBet: boolean

• Getter: isBestBet()
• Setter: setBestBet(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: bestbet
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property dateCreated: Timestamp

• Getter: getDateCreated()
• Setter: setDateCreated(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: 2012-01-28 00:35:02.39
• Type Name: timestamp
• Sort String: datecreated
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes
  useNowForDefault	true

Property dateModified: Timestamp

• Getter: getDateModified()
• Setter: setDateModified(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Type Name: timestamp
• Sort String: datemodified
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property encodedFieldData: String

• Getter: getEncodedFieldData()
• Setter: setEncodedFieldData(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: big string
• Sort String: encodedfielddata

Property externallyVisible: boolean

• Getter: isExternallyVisible()
• Setter: setExternallyVisible(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: externallyvisible
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property fields: Map with SolutionField values

• Getter: getFields()
• Setter: setFields(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued
• Default Value: {}
• Type Name: Solution Fields
• Sort String: fields
• Attributes:

  Attribute Name	Attribute Value
  encodedFieldDataPropertyName	encodedFieldData

Property id: String

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

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property internalAudience: List of OrganizationValue

• Getter: getInternalAudience()
• Setter: setInternalAudience(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: internalaudience
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property internalAudienceSorted: List of OrganizationValue

• Getter: getInternalAudienceSorted()
• Setter: setInternalAudienceSorted(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, derived, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: internalaudiencesorted
• Attributes:

  Attribute Name	Attribute Value
  sort	organizationName:ascending:ignorecase

Property language: String

• Getter: getLanguage()
• Setter: setLanguage(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: language
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property legacyId: String

• Getter: getLegacyId()
• Setter: setLegacyId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: legacyid
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property modifiedBy: String

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

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property owningGroup: OrganizationValue

• Getter: getOwningGroup()
• Setter: setOwningGroup(atg.svc.repository.beans.OrganizationValue)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: owninggroup
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property rawTitle: String

• Getter: getRawTitle()
• Setter: setRawTitle(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: big string
• Sort String: rawtitle
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property recognition: String

• Getter: getRecognition()
• Setter: setRecognition(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: recognition
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property recommendedAnswers: List

Gets the most recent recommended answers for the solution based on the modified date.
• Getter: getRecommendedAnswers()
• Flags: readable, cacheable, collectionOrMap, multivalued
• Default Value: []
• Type Name: Solution Recommend Answers
• Sort String: recommendedanswers
• Attributes:

  Attribute Name	Attribute Value
  foreignRepositoryName	ServiceSharedRepository
  foreignRepositoryPath	/atg/svc/shared/ServiceSharedRepository
  maximumRecommendedAnswers	50
  recommendedAnswersItemDescName	RecommendedAnswer
  serviceSharedRepositoryPath	/atg/svc/shared/ServiceSharedRepository
  solutionIdProperty	id

Property solutionClass: SolutionClass

• Getter: getSolutionClass()
• Setter: setSolutionClass(atg.svc.repository.beans.SolutionClass)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: solutionclass
• Attributes:

  Attribute Name	Attribute Value
  auto-checkout	false
  propertyCategory	attributes

Property solutionRelevance: RepositoryItem

Gets the Solution Relevance item.
• Getter: getSolutionRelevance()
• Flags: readable, cacheable
• Type Name: Solution Relevance
• Sort String: solutionrelevance
• Attributes:

  Attribute Name	Attribute Value
  foreignRepositoryName	ServiceSharedRepository
  foreignRepositoryPath	/atg/svc/shared/ServiceSharedRepository
  serviceSharedRepositoryPath	/atg/svc/shared/ServiceSharedRepository
  solutionIdProperty	id
  solutionRelevanceItemDescName	SolutionRelevance

Property status: SolutionStatus

• Getter: getStatus()
• Setter: setStatus(atg.svc.repository.beans.SolutionStatus)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: status
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	attributes

Property topicIds: Set

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

Property topicPaths: Set

Gets the set of Topic Paths
• Getter: getTopicPaths()
• Flags: readable, cacheable, collectionOrMap, multivalued
• Default Value: []
• Type Name: Topic Path
• Sort String: topicpaths
• Attributes:

  Attribute Name	Attribute Value
  topicIdsPropertyName	topicIds
  topicService	/atg/searchadmin/repository/service/TopicService

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	addTopic(java.lang.String topicId) Adds a topic to the solution given the topic id
void	copyTo(Solution destination) Copies the property values of this instance to another instance of the same data type.
java.util.Map	getAllFields()
java.lang.String[]	getAudience() Getter for property audience
java.lang.Object[]	getAudienceSorted() Getter for property audienceSorted
java.lang.String	getAuthor() Getter for property author
java.sql.Timestamp	getDateCreated() Getter for property dateCreated
java.sql.Timestamp	getDateModified() Getter for property dateModified
java.lang.String	getDisplayId() Gets the displayable solution id - for new solutions this matches the repository id.
java.lang.String	getDisplayTitle() Gets the title for the Solution truncated to the configured maximum number of characters.
java.util.List	getEditableFields()
java.util.List	getEditablePropertyFields() Returns the non-statement and non-text fields that are editable by the current user.
java.util.List	getEditableStatementFields() Returns the statement and text fields that are editable by the current user.
java.lang.String	getEncodedFieldData() Getter for property encodedFieldData
java.util.List	getExternallyVisiblePropertyFields() Gets the property fields visible to all external users
java.util.List	getExternallyVisibleStatementFields() Gets the statement fields visible to all external users
java.util.Map	getFields() Getter for property fields
java.lang.Object	getFieldValue(java.lang.String name) Gets a value for the given property on the solution.
boolean	getHasExternallyVisible() Returns true if the value of property externallyVisible is null.
java.lang.String	getId() Getter for property id
java.util.List	getInternalAudience() Getter for property internalAudience
java.util.List	getInternalAudienceSorted() Getter for property internalAudienceSorted
boolean	getIsEditable()
boolean	getIsExternallyVisibleToEveryone()
boolean	getIsExternallyVisibleToSegment(java.lang.String segmentName)
boolean	getIsVisible()
java.lang.String	getLanguage() Getter for property language
java.lang.String	getLegacyId() Getter for property legacyId
java.lang.String	getModifiedBy() Getter for property modifiedBy
atg.svc.repository.beans.OrganizationValue	getOwningGroup() Getter for property owningGroup
java.lang.String	getRawTitle() Getter for property rawTitle
java.lang.String	getRecognition() Getter for property recognition
java.util.List	getRecommendedAnswers() Getter for property recommendedAnswers
atg.svc.repository.beans.SolutionClass	getSolutionClass() Getter for property solutionClass
atg.repository.RepositoryItem	getSolutionRelevance() Getter for property solutionRelevance
SolutionStatus	getStatus() Getter for property status
java.lang.String	getTitle() Gets the computed title for the Solution.
java.util.Set	getTopicIds() Getter for property topicIds
java.util.Set	getTopicPaths() Getter for property topicPaths
java.util.Set	getTopics() Returns Topic objects instead of topic ids.
java.lang.Integer	getVersion()
java.util.List	getVisibleFields()
java.util.List	getVisiblePropertyFields() Returns the non-statement and non-text fields that are editable by the current user.
java.util.List	getVisibleStatementFields() Returns the statement and text fields that are visible to the current user.
boolean	isBestBet() Getter for property bestBet
boolean	isExternallyVisible() Getter for property externallyVisible
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	setAudience(java.lang.String[] value) Setter for property audience .
void	setAudienceSorted(java.lang.Object[] value) Setter for property audienceSorted .
void	setAuthor(java.lang.String value) Setter for property author .
void	setBestBet(boolean value) Setter for property bestBet .
void	setDateCreated(java.sql.Timestamp value) Setter for property dateCreated .
void	setDateModified(java.sql.Timestamp value) Setter for property dateModified .
void	setEncodedFieldData(java.lang.String value) Setter for property encodedFieldData .
void	setExternallyVisible(boolean value) Setter for property externallyVisible .
void	setFields(java.util.Map value) Setter for property fields .
void	setFieldValue(java.lang.String name, java.lang.Object value) Sets a value for the given property on the solution.
void	setHasExternallyVisible(boolean value) If this is set to false, then the underlying value of property externallyVisible is set to null.
void	setId(java.lang.String value) Setter for property id .
void	setInternalAudience(java.util.List value) Setter for property internalAudience .
void	setInternalAudience(java.lang.String[] orgValIds) Sets the internal audience on the Solution given a list of OrganizationValue repository ids.
void	setInternalAudienceSorted(java.util.List value) Setter for property internalAudienceSorted .
void	setLanguage(java.lang.String value) Setter for property language .
void	setLegacyId(java.lang.String value) Setter for property legacyId .
void	setModifiedBy(java.lang.String value) Setter for property modifiedBy .
void	setOwningGroup(atg.svc.repository.beans.OrganizationValue value) Setter for property owningGroup .
void	setOwningGroup(java.lang.String orgValId) Sets the owning group on the Solution given an OrganizationValue repository id.
void	setRawTitle(java.lang.String value) Setter for property rawTitle .
void	setRecognition(java.lang.String value) Setter for property recognition .
void	setSolutionClass(atg.svc.repository.beans.SolutionClass value) Setter for property solutionClass .
void	setSolutionClass(java.lang.String solutionClassId) Sets the SolutionClass on the Solution given the SolutionClass repository id.
void	setStatus(SolutionStatus value) Setter for property status .
void	setTitle(java.lang.String title) Sets the title for the Solution.
void	setTopicIds(java.util.Set value) Setter for property topicIds .
void	setTopics(java.util.Set topics) Updates the solution's topicIds given a set of Topic objects.
void	updateTopicIds(java.util.Set topicIds) Adds/Removes topics to/from the solution given a new set of topic ids.
void	validate() Performs validation on the Solution
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

getAudience

java.lang.String[] getAudience()
                               throws javax.ejb.EJBException

Getter for property audience

Returns:

String[]

Throws:

javax.ejb.EJBException

setAudience

void setAudience(java.lang.String[] value)
                 throws javax.ejb.EJBException

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

getAudienceSorted

java.lang.Object[] getAudienceSorted()
                                     throws javax.ejb.EJBException

Getter for property audienceSorted

Returns:

Object[]

Throws:

javax.ejb.EJBException

setAudienceSorted

void setAudienceSorted(java.lang.Object[] value)
                       throws javax.ejb.EJBException

Setter for property audienceSorted . 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 - Object[]

Throws:

javax.ejb.EJBException

getAuthor

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

Getter for property author

Returns:

String

Throws:

javax.ejb.EJBException

setAuthor

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

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

isBestBet

boolean isBestBet()
                  throws javax.ejb.EJBException

Getter for property bestBet

Returns:

boolean

Throws:

javax.ejb.EJBException

setBestBet

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

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

getDateCreated

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

Getter for property dateCreated

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setDateCreated

void setDateCreated(java.sql.Timestamp 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 - Timestamp

Throws:

javax.ejb.EJBException

getDateModified

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

Getter for property dateModified

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setDateModified

void setDateModified(java.sql.Timestamp 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 - Timestamp

Throws:

javax.ejb.EJBException

getEncodedFieldData

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

Getter for property encodedFieldData

Returns:

String

Throws:

javax.ejb.EJBException

setEncodedFieldData

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

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

isExternallyVisible

boolean isExternallyVisible()
                            throws javax.ejb.EJBException

Getter for property externallyVisible

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasExternallyVisible

boolean getHasExternallyVisible()
                                throws javax.ejb.EJBException

Returns true if the value of property externallyVisible is null.

Throws:

javax.ejb.EJBException

setExternallyVisible

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

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

setHasExternallyVisible

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

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

Throws:

javax.ejb.EJBException

getFields

java.util.Map getFields()
                        throws javax.ejb.EJBException

Getter for property fields

Returns:

Map with SolutionField values

Throws:

javax.ejb.EJBException

setFields

void setFields(java.util.Map value)
               throws javax.ejb.EJBException

Setter for property fields . 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 - Map with SolutionField values

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

getInternalAudience

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

Getter for property internalAudience

Returns:

List of OrganizationValue

Throws:

javax.ejb.EJBException

setInternalAudience

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

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

Throws:

javax.ejb.EJBException

getInternalAudienceSorted

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

Getter for property internalAudienceSorted

Returns:

List of OrganizationValue

Throws:

javax.ejb.EJBException

setInternalAudienceSorted

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

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

Throws:

javax.ejb.EJBException

getLanguage

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

Getter for property language

Returns:

String

Throws:

javax.ejb.EJBException

setLanguage

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

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

getLegacyId

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

Getter for property legacyId

Returns:

String

Throws:

javax.ejb.EJBException

setLegacyId

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

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

getOwningGroup

atg.svc.repository.beans.OrganizationValue getOwningGroup()
                                                          throws javax.ejb.EJBException

Getter for property owningGroup

Returns:

OrganizationValue

Throws:

javax.ejb.EJBException

setOwningGroup

void setOwningGroup(atg.svc.repository.beans.OrganizationValue value)
                    throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getRawTitle

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

Getter for property rawTitle

Returns:

String

Throws:

javax.ejb.EJBException

setRawTitle

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

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

getRecognition

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

Getter for property recognition

Returns:

String

Throws:

javax.ejb.EJBException

setRecognition

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

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

getRecommendedAnswers

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

Getter for property recommendedAnswers

Returns:

List

Throws:

javax.ejb.EJBException

getSolutionClass

atg.svc.repository.beans.SolutionClass getSolutionClass()
                                                        throws javax.ejb.EJBException

Getter for property solutionClass

Returns:

SolutionClass

Throws:

javax.ejb.EJBException

setSolutionClass

void setSolutionClass(atg.svc.repository.beans.SolutionClass value)
                      throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getSolutionRelevance

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

Getter for property solutionRelevance

Returns:

RepositoryItem

Throws:

javax.ejb.EJBException

getStatus

SolutionStatus getStatus()
                         throws javax.ejb.EJBException

Getter for property status

Returns:

SolutionStatus

Throws:

javax.ejb.EJBException

setStatus

void setStatus(SolutionStatus value)
               throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getTopicIds

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

Getter for property topicIds

Returns:

Set

Throws:

javax.ejb.EJBException

setTopicIds

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

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

getTopicPaths

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

Getter for property topicPaths

Returns:

Set

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

getIsVisible

boolean getIsVisible()
                     throws javax.ejb.EJBException

Returns:

Returns true if this solution is visible for the current user.

Throws:

javax.ejb.EJBException - A system-level error occurred

getIsExternallyVisibleToEveryone

boolean getIsExternallyVisibleToEveryone()
                                         throws javax.ejb.EJBException

Returns:

Returns true if this solution is visible for everyone external.

Throws:

javax.ejb.EJBException - A system-level error occurred

getIsExternallyVisibleToSegment

boolean getIsExternallyVisibleToSegment(java.lang.String segmentName)
                                        throws javax.ejb.EJBException

Parameters:

segmentName -

Returns:

Returns true if this solution is externally visible for the given segment.

Throws:

javax.ejb.EJBException - A system-level error occurred

getIsEditable

boolean getIsEditable()
                      throws javax.ejb.EJBException

Returns:

Returns true if this solution is editable for the current user.

Throws:

javax.ejb.EJBException - A system-level error occurred

getAllFields

java.util.Map getAllFields()
                           throws javax.ejb.EJBException

Returns:

Returns a Map of solution fields keyed on field name.

Throws:

javax.ejb.EJBException - A system-level error occurred

getVisibleFields

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

Returns:

Returns the List of SolutionField objects in the order described by the SolutionClass.

Throws:

javax.ejb.EJBException - A system-level error occurred

getVisibleStatementFields

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

Returns the statement and text fields that are visible to the current user.

Returns:

Returns a set of SolutionField objects.

Throws:

javax.ejb.EJBException - A system-level error occurred

getVisiblePropertyFields

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

Returns the non-statement and non-text fields that are editable by the current user.

Returns:

Returns a set of SolutionField objects.

Throws:

javax.ejb.EJBException - A system-level error occurred

getEditableFields

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

Returns:

Returns the List of SolutionField objects in the order described by the SolutionClass.

Throws:

javax.ejb.EJBException - A system-level error occurred

getEditableStatementFields

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

Returns the statement and text fields that are editable by the current user.

Returns:

Returns a set of SolutionField objects.

Throws:

javax.ejb.EJBException - A system-level error occurred

getEditablePropertyFields

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

Returns the non-statement and non-text fields that are editable by the current user.

Returns:

Returns a set of SolutionField objects.

Throws:

javax.ejb.EJBException - A system-level error occurred

getExternallyVisibleStatementFields

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

Gets the statement fields visible to all external users

Returns:

A List of SolutionField objects

Throws:

javax.ejb.EJBException - A system-level error occurred

getExternallyVisiblePropertyFields

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

Gets the property fields visible to all external users

Returns:

A List of SolutionField objects

Throws:

javax.ejb.EJBException - A system-level error occurred

setFieldValue

void setFieldValue(java.lang.String name,
                   java.lang.Object value)
                   throws atg.beans.PropertyNotFoundException,
                          javax.ejb.EJBException

Sets a value for the given property on the solution.

Parameters:

name - The name of the property to set. Formatting: see atg.beans.DynamicBeans

value - The value to set

Throws:

atg.beans.PropertyNotFoundException

javax.ejb.EJBException - A system-level error occurred

getFieldValue

java.lang.Object getFieldValue(java.lang.String name)
                               throws atg.beans.PropertyNotFoundException,
                                      javax.ejb.EJBException

Gets a value for the given property on the solution.

Parameters:

name - The name of the property to get. Formatting: see atg.beans.DynamicBeans

Returns:

The value of the property

Throws:

atg.beans.PropertyNotFoundException

javax.ejb.EJBException - A system-level error occurred

getTitle

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

Gets the computed title for the Solution.

Throws:

javax.ejb.EJBException - A system-level error occurred

setTitle

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

Sets the title for the Solution.

Parameters:

title - The title

Throws:

javax.ejb.EJBException - A system-level error occurred

getDisplayTitle

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

Gets the title for the Solution truncated to the configured maximum number of characters.

Throws:

javax.ejb.EJBException - A system-level error occurred

getTopics

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

Returns Topic objects instead of topic ids.

Throws:

javax.ejb.EJBException - A system-level error occurred

setTopics

void setTopics(java.util.Set topics)
               throws javax.ejb.EJBException

Updates the solution's topicIds given a set of Topic objects.

Parameters:

topics - Set of atg.searchadmin.repository.beans.Topic

Throws:

javax.ejb.EJBException - A system-level error occurred

setSolutionClass

void setSolutionClass(java.lang.String solutionClassId)
                      throws ObjectNotFoundException,
                             javax.ejb.EJBException

Sets the SolutionClass on the Solution given the SolutionClass repository id.

Parameters:

solutionClassId - The repository id of the SolutionClass

Throws:

ObjectNotFoundException

javax.ejb.EJBException - A system-level error occurred

setOwningGroup

void setOwningGroup(java.lang.String orgValId)
                    throws ObjectNotFoundException,
                           SvcException,
                           javax.ejb.EJBException

Sets the owning group on the Solution given an OrganizationValue repository id.

Parameters:

orgValId - The repository id of the OrganizationValue to set as the owning group

Throws:

ObjectNotFoundException

SvcException

javax.ejb.EJBException - A system-level error occurred

setInternalAudience

void setInternalAudience(java.lang.String[] orgValIds)
                         throws ObjectNotFoundException,
                                SvcException,
                                javax.ejb.EJBException

Sets the internal audience on the Solution given a list of OrganizationValue repository ids.

Parameters:

orgValIds - The repository ids of the OrganizationValues to set as the internal audience or null/empty to clear

Throws:

ObjectNotFoundException

SvcException

javax.ejb.EJBException - A system-level error occurred

addTopic

void addTopic(java.lang.String topicId)
              throws ObjectNotFoundException,
                     javax.ejb.EJBException

Adds a topic to the solution given the topic id

Parameters:

topicId - The id of the topic

Throws:

ObjectNotFoundException

javax.ejb.EJBException - A system-level error occurred

updateTopicIds

void updateTopicIds(java.util.Set topicIds)
                    throws ObjectNotFoundException,
                           javax.ejb.EJBException

Adds/Removes topics to/from the solution given a new set of topic ids. Removes all topics if pTopicIds is null or empty.

Parameters:

topicIds - A set of topic ids

Throws:

ObjectNotFoundException

javax.ejb.EJBException - A system-level error occurred

validate

void validate()
              throws atg.svc.validation.ValidationException,
                     javax.ejb.EJBException

Performs validation on the Solution

Throws:

atg.svc.validation.ValidationException

javax.ejb.EJBException - A system-level error occurred

getDisplayId

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

Gets the displayable solution id - for new solutions this matches the repository id. For imported solutions, this is the legacyId.

Throws:

javax.ejb.EJBException - A system-level error occurred

getVersion

java.lang.Integer getVersion()
                             throws javax.ejb.EJBException

Returns:

Returns version id - null if no version exists for this solution.

Throws:

javax.ejb.EJBException - A system-level error occurred