atg.svc.repository.beans
Class _UserFieldDefinition_Impl

java.lang.Object
  atg.svc.repository.beans._UserFieldDefinition_Impl

All Implemented Interfaces:

FieldDefinition, atg.svc.repository.beans.pv.FieldDefinition_PV, atg.svc.repository.beans.pv.UserFieldDefinition_PV, SecuredItem, UserFieldDefinition, java.io.Serializable, javax.ejb.EJBLocalObject

Direct Known Subclasses:

_UserFieldDefinition_BeanImpl, _UserFieldDefinition_ReposImpl

public abstract class _UserFieldDefinition_Impl
extends java.lang.Object
implements atg.svc.repository.beans.pv.UserFieldDefinition_PV, java.io.Serializable

See Also:

Serialized Form

Field Summary

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

CLASS_VERSION

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

CLASS_VERSION

Constructor Summary

_UserFieldDefinition_Impl()

Method Summary

java.lang.String	_getItemDescriptorName()
java.lang.Class	_getObjectInterfaceClass()
void	copyTo(FieldDefinition destination) Copies the property values of this instance to another instance of the same data type.
void	copyTo(UserFieldDefinition destination) Copies the property values of this instance to another instance of the same data type.
SolutionFieldValue	createSolutionFieldValue()
java.util.List	getDefaultValues()
boolean	getIsEditable()
boolean	getIsExternallyVisible()
boolean	getIsExternallyVisible(java.lang.String segmentName)
boolean	getIsInternalOnly()
boolean	getIsMultiValued()
boolean	getIsVisible() Returns true if the object is visible for the current user.
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	setDefaultValues(java.util.List value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.svc.repository.beans.pv.UserFieldDefinition_PV

_isMutable, getId, getSegments, getSegmentsSorted, prepareInstanceForWrite, setId, setSegments, writeInstance

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Methods inherited from interface atg.svc.repository.beans.pv.FieldDefinition_PV

getDisplayName, getEditor, getExternalAudience, getExternalAudienceSorted, getHasDefault, getIndexing, getInternalAudience, getInternalAudienceSorted, getInternalModify, getInternalModifySorted, getName, getPurpose, getType, getUsage, isDefault, isMultiValued, isRequired, setDefault, setDisplayName, setEditor, setExternalAudience, setHasDefault, setIndexing, setInternalAudience, setInternalModify, setMultiValued, setName, setPurpose, setRequired, setType, setUsage

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Constructor Detail

_UserFieldDefinition_Impl

public _UserFieldDefinition_Impl()

Method Detail

isRemoved

public boolean isRemoved()
                  throws javax.ejb.EJBException

Description copied from interface: FieldDefinition

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

Specified by:

isRemoved in interface FieldDefinition

Specified by:

isRemoved in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Specified by:

isRemoved in interface atg.svc.repository.beans.pv.UserFieldDefinition_PV

Specified by:

isRemoved in interface UserFieldDefinition

Throws:

javax.ejb.EJBException

_getItemDescriptorName

public java.lang.String _getItemDescriptorName()

_getObjectInterfaceClass

public java.lang.Class _getObjectInterfaceClass()

copyTo

public void copyTo(UserFieldDefinition destination)
            throws javax.ejb.EJBException

Description copied from interface: atg.svc.repository.beans.pv.UserFieldDefinition_PV

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.

Specified by:

copyTo in interface atg.svc.repository.beans.pv.UserFieldDefinition_PV

Specified by:

copyTo in interface UserFieldDefinition

Throws:

javax.ejb.EJBException

copyTo

public void copyTo(FieldDefinition destination)
            throws javax.ejb.EJBException

Description copied from interface: FieldDefinition

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.

Specified by:

copyTo in interface FieldDefinition

Specified by:

copyTo in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Throws:

javax.ejb.EJBException

getUsersInSegments

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

Description copied from interface: atg.svc.repository.beans.pv.UserFieldDefinition_PV

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

Specified by:

getUsersInSegments in interface atg.svc.repository.beans.pv.UserFieldDefinition_PV

Specified by:

getUsersInSegments in interface UserFieldDefinition

Returns:

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

Throws:

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

hasSegmentFilter

public boolean hasSegmentFilter()
                         throws javax.ejb.EJBException

Description copied from interface: atg.svc.repository.beans.pv.UserFieldDefinition_PV

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

Specified by:

hasSegmentFilter in interface atg.svc.repository.beans.pv.UserFieldDefinition_PV

Specified by:

hasSegmentFilter in interface UserFieldDefinition

Returns:

True if a segment filter has been set else false

Throws:

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

getIsMultiValued

public boolean getIsMultiValued()
                         throws javax.ejb.EJBException

Specified by:

getIsMultiValued in interface FieldDefinition

Specified by:

getIsMultiValued in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Returns:

Returns true if the field definition is multi-valued

Throws:

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

getIsVisible

public boolean getIsVisible()
                     throws javax.ejb.EJBException

Description copied from interface: SecuredItem

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

Specified by:

getIsVisible in interface FieldDefinition

Specified by:

getIsVisible in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Specified by:

getIsVisible in interface SecuredItem

Returns:

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

Throws:

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

getIsExternallyVisible

public boolean getIsExternallyVisible()
                               throws javax.ejb.EJBException

Specified by:

getIsExternallyVisible in interface FieldDefinition

Specified by:

getIsExternallyVisible in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Returns:

Returns true if this field is visible for everyone external.

Throws:

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

getIsExternallyVisible

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

Specified by:

getIsExternallyVisible in interface FieldDefinition

Specified by:

getIsExternallyVisible in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Returns:

Returns true if this field is internally visible for the given segment.

Throws:

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

getIsEditable

public boolean getIsEditable()
                      throws javax.ejb.EJBException

Specified by:

getIsEditable in interface FieldDefinition

Specified by:

getIsEditable in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Returns:

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

Throws:

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

getIsInternalOnly

public boolean getIsInternalOnly()
                          throws javax.ejb.EJBException

Specified by:

getIsInternalOnly in interface FieldDefinition

Specified by:

getIsInternalOnly in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Returns:

Returns true if this field is for internal use only.

Throws:

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

createSolutionFieldValue

public SolutionFieldValue createSolutionFieldValue()
                                            throws javax.ejb.CreateException,
                                                   javax.ejb.EJBException

Specified by:

createSolutionFieldValue in interface FieldDefinition

Specified by:

createSolutionFieldValue in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Returns:

Creates and returns a new SolutionFieldValue with this FieldDefinition as the metadata

Throws:

javax.ejb.CreateException

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

setDefaultValues

public void setDefaultValues(java.util.List value)
                      throws javax.ejb.CreateException,
                             javax.ejb.FinderException,
                             PersistenceException,
                             javax.ejb.RemoveException,
                             javax.ejb.EJBException

Specified by:

setDefaultValues in interface FieldDefinition

Specified by:

setDefaultValues in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Throws:

javax.ejb.CreateException

javax.ejb.FinderException

PersistenceException

javax.ejb.RemoveException

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

getDefaultValues

public java.util.List getDefaultValues()
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException

Specified by:

getDefaultValues in interface FieldDefinition

Specified by:

getDefaultValues in interface atg.svc.repository.beans.pv.FieldDefinition_PV

Returns:

Gets the default values for this field definition in the correct display order

Throws:

javax.ejb.FinderException

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