atg.svc.repository.beans
Interface SolutionClass

All Superinterfaces:

javax.ejb.EJBLocalObject, SecuredInternalItem

All Known Implementing Classes:

_SolutionClass_BeanImpl, _SolutionClass_Impl, _SolutionClass_ReposImpl

public interface SolutionClass
extends javax.ejb.EJBLocalObject, SecuredInternalItem

Class SolutionClass

• Home: SolutionClassHome
• 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	[:Solution.solutionClass]

Property Summaries

Property Name	Property Type	Property Description	Flags
description	String		R, W, Cch, Qry
fields	List of SolutionClassFieldDefinition		R, W, Cch, CoM, Mv, Qry
id	String		R, W, Cch, Id, Qry, Req
internalAudience	String[]		R, W, Cch, Mv, Qry
internalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
name	String		R, W, Cch, Qry, Req
workflowName	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 description: String

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

Property fields: List of SolutionClassFieldDefinition

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

  Attribute Name	Attribute Value
  removeNullValues	true

Property id: String

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

Property internalAudience: String[]

• Getter: getInternalAudience()
• Setter: setInternalAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@363068
• Type Name: array
• Sort String: internalaudience
• Attributes:

  Attribute Name	Attribute Value
  deployable	false
  removeNullValues	true

Property internalAudienceSorted: Object[]

• Getter: getInternalAudienceSorted()
• Flags: readable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: internalaudiencesorted

Property name: String

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

Property workflowName: String

• Getter: getWorkflowName()
• Setter: setWorkflowName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: workflowname

Field Summary

Fields inherited from interface atg.svc.repository.beans.SecuredInternalItem

CLASS_VERSION

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(SolutionClass 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.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.List	getFields() Getter for property fields
java.lang.String	getId() Getter for property id
java.lang.String[]	getInternalAudience() Getter for property internalAudience
java.lang.Object[]	getInternalAudienceSorted() Getter for property internalAudienceSorted
boolean	getIsVisible() Returns true if the object is visible for the current user.
java.lang.String	getName() Getter for property name
int	getNumberOfSearchableFields() Gets the number of searchable fields on the SolutionClass
java.util.Map	getRelativeSearchWeights() Gets relative search weightings as a percentage for each field in the SolutionClass
int	getTotalSearchWeight() Gets the total search weight of all searchable fields
java.util.List	getVisibleFields() Returns the fields that are visible to the current user.
java.util.List	getVisiblePropertyFields() Returns the non-statement and non-text fields that are visible to the current user.
java.util.List	getVisibleStatementFields() Returns the statement and text fields that are visible to the current user.
java.lang.String	getWorkflowName() Getter for property workflowName
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	setFields(java.util.List value) Setter for property fields .
void	setId(java.lang.String value) Setter for property id .
void	setInternalAudience(java.lang.String[] value) Setter for property internalAudience .
void	setName(java.lang.String value) Setter for property name .
void	setWorkflowName(java.lang.String value) Setter for property workflowName .
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

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

getFields

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

Getter for property fields

Returns:

List of SolutionClassFieldDefinition

Throws:

javax.ejb.EJBException

setFields

void setFields(java.util.List 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 - List of SolutionClassFieldDefinition

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.lang.String[] getInternalAudience()
                                       throws javax.ejb.EJBException

Getter for property internalAudience

Specified by:

getInternalAudience in interface SecuredInternalItem

Returns:

String[]

Throws:

javax.ejb.EJBException

setInternalAudience

void setInternalAudience(java.lang.String[] 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.

Specified by:

setInternalAudience in interface SecuredInternalItem

Parameters:

value - String[]

Throws:

javax.ejb.EJBException

getInternalAudienceSorted

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

Getter for property internalAudienceSorted

Returns:

Object[]

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

getWorkflowName

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

Getter for property workflowName

Returns:

String

Throws:

javax.ejb.EJBException

setWorkflowName

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

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

getVisibleFields

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

Returns the fields that are visible to the current user.

Returns:

Returns a list of SolutionClassFieldDefinition objects.

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 list of SolutionClassFieldDefinition 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 visible to the current user.

Returns:

Returns a list of SolutionClassFieldDefinition 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

getRelativeSearchWeights

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

Gets relative search weightings as a percentage for each field in the SolutionClass

Returns:

A Map where the key is the field name as a String and the value is the percentage as an Integer

Throws:

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

getTotalSearchWeight

int getTotalSearchWeight()
                         throws javax.ejb.EJBException

Gets the total search weight of all searchable fields

Returns:

The total weight of all searchable fields

Throws:

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

getNumberOfSearchableFields

int getNumberOfSearchableFields()
                                throws javax.ejb.EJBException

Gets the number of searchable fields on the SolutionClass

Returns:

The number of searchable fields on the SolutionClass

Throws:

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

getIsVisible

boolean getIsVisible()
                     throws javax.ejb.EJBException

Description copied from interface: SecuredInternalItem

Returns true if the object is visible for the current user.

Specified by:

getIsVisible in interface SecuredInternalItem

Returns:

Returns true if this Solution Class is visible for the current user.

Throws:

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