atg.svc.repository.beans.methods
Class SolutionClassMethods

java.lang.Object
  atg.svc.repository.beans.methods.BaseMethods
      atg.svc.repository.beans.methods.SolutionClassMethods

public class SolutionClassMethods
extends BaseMethods

Defines extension methods for the SolutionClass object.

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

SolutionClassMethods()

Method Summary

java.util.List	getExternallyVisiblePropertyFields(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets the solution class property fields that are visible to everyone external.
java.util.List	getExternallyVisibleStatementFields(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets the solution class statement fields that are visible to everyone external.
boolean	getIsVisible(atg.svc.repository.beans.SolutionClass pSolutionClass) Returns true if the given Solution Class is visible for the current user.
int	getNumberOfSearchableFields(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets the number of solution class fields that are searchable.
java.util.Map	getRelativeSearchWeights(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets a Map with the relative search weight of each searchable Solution Class field keyed by the field name.
int	getTotalSearchWeight(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets the total of the search weight on each searchable solution class field.
java.util.List	getVisibleFields(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets the list of SolutionClassClassFields that are viewable for the current user.
java.util.List	getVisiblePropertyFields(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets the set of non-statement and non-text fields that are viewable for the current user.
java.util.List	getVisibleStatementFields(atg.svc.repository.beans.SolutionClass pSolutionClass) Gets the set of statement and text fields that are viewable for the current user.

Methods inherited from class atg.svc.repository.beans.methods.BaseMethods

getServiceFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

SolutionClassMethods

public SolutionClassMethods()

Method Detail

getVisibleFields

public java.util.List getVisibleFields(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets the list of SolutionClassClassFields that are viewable for the current user.

Parameters:

pSolutionClass - The SolutionClass to get the fields from.

Returns:

The list of SolutionClassClassFields that are viewable for the current user.

getVisibleStatementFields

public java.util.List getVisibleStatementFields(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets the set of statement and text fields that are viewable for the current user.

Parameters:

pSolutionClass - The SolutionClass to get the fields from.

Returns:

The List of SolutionClassClassFieldDefinition objects that are viewable for the current user.

getVisiblePropertyFields

public java.util.List getVisiblePropertyFields(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets the set of non-statement and non-text fields that are viewable for the current user.

Parameters:

pSolutionClass - The SolutionClass to get the fields from.

Returns:

The List of SolutionClassClassFieldDefinition objects that are viewable for the current user.

getExternallyVisibleStatementFields

public java.util.List getExternallyVisibleStatementFields(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets the solution class statement fields that are visible to everyone external.

Parameters:

pSolutionClass - The SolutionClass to get the statement fields from.

Returns:

The List of SolutionClassClassFieldDefinition objects that are viewable for all external users.

getExternallyVisiblePropertyFields

public java.util.List getExternallyVisiblePropertyFields(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets the solution class property fields that are visible to everyone external.

Parameters:

pSolutionClass - The SolutionClass to get the property fields from.

Returns:

The List of SolutionClassClassFieldDefinition objects that are viewable for all external users.

getRelativeSearchWeights

public java.util.Map getRelativeSearchWeights(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets a Map with the relative search weight of each searchable Solution Class field keyed by the field name. If the total of all weights is zero, the relative weights will just be distributed evenly among the searchable fields.

Parameters:

pSolutionClass - The SolutionClass to calculate the relative weight on each searchable field.

Returns:

A Map where the key is the field name (String) and the value is the relative weight (Float). If there are no searchable fields on the SolutionClass an empty Map is returned.

getTotalSearchWeight

public int getTotalSearchWeight(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets the total of the search weight on each searchable solution class field.

Parameters:

pSolutionClass - The SolutionClass to calculate the total.

Returns:

The total of the search weight on each searchable solution class field.

getNumberOfSearchableFields

public int getNumberOfSearchableFields(atg.svc.repository.beans.SolutionClass pSolutionClass)

Gets the number of solution class fields that are searchable. A field is searchable if the indexing property is set to Searchable or Both.

Parameters:

pSolutionClass - The SolutionClass to calculate the total.

Returns:

The number of solution class fields with indexing set to Searchable or Both.

getIsVisible

public boolean getIsVisible(atg.svc.repository.beans.SolutionClass pSolutionClass)

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

Parameters:

pSolutionClass - The SolutionClass to check.

Returns:

True if the SolutionClass is visible else false.