atg.svc.repository.beans
Interface UserFieldDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject, atg.svc.repository.beans.FieldDefinition, atg.svc.repository.beans.SecuredItem

public interface UserFieldDefinition
extends javax.ejb.EJBLocalObject, atg.svc.repository.beans.FieldDefinition

Class UserFieldDefinition

• Home: UserFieldDefinitionHome
• 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
default	boolean	Set to true if the field instance should set default values from the definition on create.	R, W, Cch, Qry
displayName	String	Name displayed in UI to users	R, W, Cch, Qry, Req
editor	FieldDefinitionEditor		R, W, Cch, Qry, Req
externalAudience	String[]		R, W, Cch, Mv, Qry
externalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
id	String		R, W, Cch, Id, Qry, Req
indexing	FieldDefinitionIndexing		R, W, Cch, Qry, Req
internalAudience	String[]		R, W, Cch, Mv, Qry
internalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
internalModify	String[]		R, W, Cch, Mv, Qry
internalModifySorted	Object[]		R, Cch, Drv, Mv, Qry
multiValued	boolean	Set to true if the field instance can hold multiple values	R, W, Cch, Qry, Req
name	String	Immutable logical name of the field definition	R, W, Cch, Qry, Req
purpose	FieldDefinitionPurpose		R, W, Cch, Qry, Req
required	boolean	Set to true if the field instance should not allow null values	R, W, Cch, Qry, Req
segments	String[]		R, W, Cch, Mv, Qry
segmentsSorted	Object[]		R, Cch, Drv, Mv, Qry
type	FieldDefinitionType		R, W, Cch, Qry, Req
usage	FieldDefinitionUsage		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 default: boolean

Set to true if the field instance should set default values from the definition on create.
• Getter: FieldDefinition.isDefault()
• Setter: FieldDefinition.setDefault(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: default

Property displayName: String

Name displayed in UI to users
• Getter: FieldDefinition.getDisplayName()
• Setter: FieldDefinition.setDisplayName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: displayname

Property editor: FieldDefinitionEditor

• Getter: FieldDefinition.getEditor()
• Setter: FieldDefinition.setEditor(atg.svc.repository.beans.FieldDefinitionEditor)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: editor
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property externalAudience: String[]

• Getter: FieldDefinition.getExternalAudience()
• Setter: FieldDefinition.setExternalAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@2bfdff
• Type Name: array
• Sort String: externalaudience
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property externalAudienceSorted: Object[]

• Getter: FieldDefinition.getExternalAudienceSorted()
• Flags: readable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: externalaudiencesorted

Property id: String

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

Property indexing: FieldDefinitionIndexing

• Getter: FieldDefinition.getIndexing()
• Setter: FieldDefinition.setIndexing(atg.svc.repository.beans.FieldDefinitionIndexing)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: indexing
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property internalAudience: String[]

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

  Attribute Name	Attribute Value
  removeNullValues	true

Property internalAudienceSorted: Object[]

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

Property internalModify: String[]

• Getter: FieldDefinition.getInternalModify()
• Setter: FieldDefinition.setInternalModify(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@3fa6cd
• Type Name: array
• Sort String: internalmodify
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property internalModifySorted: Object[]

• Getter: FieldDefinition.getInternalModifySorted()
• Flags: readable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: internalmodifysorted

Property multiValued: boolean

Set to true if the field instance can hold multiple values
• Getter: FieldDefinition.isMultiValued()
• Setter: FieldDefinition.setMultiValued(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: multivalued

Property name: String

Immutable logical name of the field definition
• Getter: FieldDefinition.getName()
• Setter: FieldDefinition.setName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: name

Property purpose: FieldDefinitionPurpose

• Getter: FieldDefinition.getPurpose()
• Setter: FieldDefinition.setPurpose(atg.svc.repository.beans.FieldDefinitionPurpose)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: purpose
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property required: boolean

Set to true if the field instance should not allow null values
• Getter: FieldDefinition.isRequired()
• Setter: FieldDefinition.setRequired(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: required

Property segments: String[]

• Getter: getSegments()
• Setter: setSegments(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@9be2b5
• Type Name: array
• Sort String: segments
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property segmentsSorted: Object[]

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

Property type: FieldDefinitionType

• Getter: FieldDefinition.getType()
• Setter: FieldDefinition.setType(atg.svc.repository.beans.FieldDefinitionType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: type
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property usage: FieldDefinitionUsage

• Getter: FieldDefinition.getUsage()
• Setter: FieldDefinition.setUsage(atg.svc.repository.beans.FieldDefinitionUsage)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: usage
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Field Summary

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

CLASS_VERSION

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(UserFieldDefinition 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.lang.String[]	getSegments() Getter for property segments
java.lang.Object[]	getSegmentsSorted() Getter for property segmentsSorted
java.util.List	getUsersInSegments() Gets all user profiles that are members of the groups in the segments property of the given field definition
boolean	hasSegmentFilter() Returns true if a segment filter has been set on the given UserFieldDefinition
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	setSegments(java.lang.String[] value) Setter for property segments .
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 atg.svc.repository.beans.FieldDefinition

copyTo, createSolutionFieldValue, getDefaultValues, getDisplayName, getEditor, getExternalAudience, getExternalAudienceSorted, getHasDefault, getIndexing, getInternalAudience, getInternalAudienceSorted, getInternalModify, getInternalModifySorted, getIsEditable, getIsExternallyVisibleToEveryone, getIsExternallyVisibleToSegment, getIsInternalOnly, getIsMultiValued, getIsVisible, getName, getPurpose, getType, getUsage, isDefault, isMultiValued, isRequired, setDefault, setDefaultValues, setDisplayName, setEditor, setExternalAudience, setHasDefault, setIndexing, setInternalAudience, setInternalModify, setMultiValued, setName, setPurpose, setRequired, setType, setUsage

Method Detail

getId

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

Getter for property id

Specified by:

getId in interface atg.svc.repository.beans.FieldDefinition

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.

Specified by:

setId in interface atg.svc.repository.beans.FieldDefinition

Parameters:

value - String

Throws:

javax.ejb.EJBException

getSegments

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

Getter for property segments

Returns:

String[]

Throws:

javax.ejb.EJBException

setSegments

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

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

getSegmentsSorted

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

Getter for property segmentsSorted

Returns:

Object[]

Throws:

javax.ejb.EJBException

isRemoved

boolean isRemoved()
                  throws javax.ejb.EJBException

Returns true if the underlying object has been removed. False otherwise.

Specified by:

isRemoved in interface atg.svc.repository.beans.FieldDefinition

Throws:

javax.ejb.EJBException

copyTo

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

Specified by:

writeInstance in interface atg.svc.repository.beans.FieldDefinition

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.

Specified by:

prepareInstanceForWrite in interface atg.svc.repository.beans.FieldDefinition

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.

Specified by:

_isMutable in interface atg.svc.repository.beans.FieldDefinition

getUsersInSegments

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

Gets all user profiles that are members of the groups in the segments property of the given field definition

Returns:

A List of RepositoryItem for each group member sorted and with duplicates removed

Throws:

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

hasSegmentFilter

boolean hasSegmentFilter()
                         throws javax.ejb.EJBException

Returns true if a segment filter has been set on the given UserFieldDefinition

Returns:

True if a segment filter has been set else false

Throws:

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