Package lumis.doui.source.field
Interface ISourceField
-
- All Known Subinterfaces:
ITableSourceField
,ITabularSourceField
- All Known Implementing Classes:
BaseSourceField
,BaseTableSourceField
,BaseTabularSourceField
,CategorizationSourceField
,ChannelTableSourceField
,CommentContentLocaleField
,DocumentSourceField
,ExperimentalGenericTableSourceField
,FileSizeField
,FileTableSourceField
,GenericTableSourceField
,GroupConfigurationButtonField
,GroupTypeConfigurationButtonField
,HtmlTableSourceField
,LocaleMetaDataSourceField
,MediaSourceField
,MetaDataSourceField
,PageTableSourceField
,ParentContentSourceField
,SingleColumnTableSourceField
,TagSourceField
,UserField
,VersionActiveField
,WorkflowAssignedToSourceField
@StableMinor(version="14.2", sinceVersion="4.0") public interface ISourceField
The interface that defines the methods a source field provides.- Since:
- 4.0.4
- Version:
- $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description void
addDocumentFields(Document document, ISourceData data)
Adds document fields values relative to this field to a document.void
addDocumentTypeFields(IDocumentTypeBuilder<?> documentTypeBuilder)
Adds document type fields relative to this field to a document type.IConverter
getConverter()
Returns the default converter for this field's values.ISourceFieldDataType
getDataType()
Node
getDefaultControlDefinition()
Returns the default control definition to be used for this field.Node
getDefaultInputControlDefinition()
Returns the default input control definition to be used for editing this field's value.Object
getDefaultValue()
Node
getDefaultViewControlDefinition()
Returns the default control definition to be used for viewing this field's value.Node
getDefinitionNode()
Deprecated.hopefully this should not be used.String
getId()
Object
getMaximumValue()
Object
getMinimumValue()
String
getName()
Class<?>
getValueClass()
Returns the class this field's possible values are assignable to.void
init(Source<?> source, Node fieldNode)
Initializes this source field.boolean
isDisplay()
boolean
isExternalData()
boolean
isGetData()
boolean
isIntroduction()
boolean
isIntroductionImage()
Returns whether this field is the introduction image of the corresponding data.boolean
isKeywords()
boolean
isParentId()
boolean
isPrimaryName()
boolean
isPublishStartDate()
Returns whether this field is the publish start date of the corresponding data.boolean
isReadOnly()
Returns true if this field is read-only and should not be rendered editable.boolean
isRequired()
boolean
isRequiredWhenVisible()
boolean
isSearchable()
Returns whether this field included to be found in a simple search (search without specifying a field).default void
postAdd(SourcePostAddDataEvent event)
Method called for each source field after data is added.default void
postDelete(SourcePostDeleteDataEvent event)
Method called for each source field after data is deleted.default void
postUpdate(SourcePostUpdateDataEvent event)
Method called for each source field after data is updated.default void
preAdd(SourcePreAddDataEvent event)
Method called for each source field before data is added.default void
preDelete(SourcePreDeleteDataEvent event)
Method called for each source field before data is deleted.default void
preUpdate(SourcePreUpdateDataEvent event)
Method called for each source field before data is updated.
-
-
-
Method Detail
-
getDefinitionNode
Node getDefinitionNode()
Deprecated.hopefully this should not be used.- Returns:
- the field's definition node.
- Since:
- 4.0.4
-
getId
String getId()
-
getName
String getName()
-
isDisplay
boolean isDisplay()
-
isPrimaryName
boolean isPrimaryName()
-
isIntroduction
boolean isIntroduction()
-
isIntroductionImage
boolean isIntroductionImage()
Returns whether this field is the introduction image of the corresponding data.- Returns:
true
if this field is the introduction image,false
otherwise.- Since:
- 8.1.0
-
isPublishStartDate
boolean isPublishStartDate()
Returns whether this field is the publish start date of the corresponding data.- Returns:
true
if this field is the publish start date,false
otherwise.- Since:
- 8.1.0
-
isKeywords
boolean isKeywords()
-
isExternalData
boolean isExternalData()
-
isGetData
boolean isGetData()
-
isRequired
boolean isRequired()
-
isRequiredWhenVisible
boolean isRequiredWhenVisible()
-
isParentId
boolean isParentId()
-
getDataType
ISourceFieldDataType getDataType()
-
getDefaultValue
Object getDefaultValue()
-
getMinimumValue
Object getMinimumValue()
-
getMaximumValue
Object getMaximumValue()
-
isReadOnly
boolean isReadOnly()
Returns true if this field is read-only and should not be rendered editable.- Returns:
- true if this field is read-only, false otherwise.
- Since:
- 4.0.8
-
isSearchable
boolean isSearchable()
Returns whether this field included to be found in a simple search (search without specifying a field).- Returns:
true
if this field is included in simple search,false
otherwise.- Since:
- 8.1.0
-
getDefaultControlDefinition
Node getDefaultControlDefinition() throws PortalException
Returns the default control definition to be used for this field.- Returns:
- the control definition node.
- Throws:
PortalException
- Since:
- 4.0.8
- See Also:
getDefaultInputControlDefinition()
,getDefaultViewControlDefinition()
-
getDefaultInputControlDefinition
Node getDefaultInputControlDefinition() throws PortalException
Returns the default input control definition to be used for editing this field's value.- Returns:
- the control definition node.
- Throws:
PortalException
- Since:
- 4.0.4
- See Also:
getDefaultControlDefinition()
,getDefaultViewControlDefinition()
-
getDefaultViewControlDefinition
Node getDefaultViewControlDefinition() throws PortalException
Returns the default control definition to be used for viewing this field's value.- Returns:
- the control definition node.
- Throws:
PortalException
- Since:
- 4.0.8
- See Also:
getDefaultInputControlDefinition()
,getDefaultControlDefinition()
-
init
void init(Source<?> source, Node fieldNode) throws PortalException
Initializes this source field. This method is called by the source after the field is created and before it is used. The implementation of this method must initialize all of this instance's attributes.- Parameters:
source
- the source this field will belong to.fieldNode
- the xml node that contains this field's definition.- Throws:
PortalException
- if this field could not be initialized.- Since:
- 4.0.4
-
getValueClass
Class<?> getValueClass()
Returns the class this field's possible values are assignable to.- Returns:
- the class this field's possible values are assignable to.
- Since:
- 4.0.4
- See Also:
IDouiDataType.getValueClass()
-
getConverter
IConverter getConverter()
Returns the default converter for this field's values.- Returns:
- the default converter for this field's values.
- Since:
- 4.0.4
-
addDocumentTypeFields
void addDocumentTypeFields(IDocumentTypeBuilder<?> documentTypeBuilder)
Adds document type fields relative to this field to a document type.- Parameters:
documentType
- the document type builder where the fields are to be added to.- Since:
- 8.1.0
- See Also:
addDocumentFields(Document, ISourceData)
-
addDocumentFields
void addDocumentFields(Document document, ISourceData data)
Adds document fields values relative to this field to a document.- Parameters:
document
- the document.data
- the source data to be used to obtain the field value.- Since:
- 8.1.0
- See Also:
addDocumentTypeFields(IDocumentTypeBuilder)
-
preDelete
default void preDelete(SourcePreDeleteDataEvent event) throws PortalException
Method called for each source field before data is deleted.Default implementation calls
getDataType()
.preDelete(this, event)
.- Parameters:
event
- the event that contains information about the delete operation.- Throws:
PortalException
- Since:
- 10.4.0
-
postDelete
default void postDelete(SourcePostDeleteDataEvent event) throws PortalException
Method called for each source field after data is deleted.Default implementation calls
getDataType()
.preDelete(this, event)
.- Parameters:
event
- the event that contains information about the delete operation.- Throws:
PortalException
- Since:
- 10.4.0
-
preAdd
default void preAdd(SourcePreAddDataEvent event) throws PortalException
Method called for each source field before data is added.- Parameters:
event
- the event that contains information about the add operation.- Throws:
PortalException
- Since:
- 10.4.0
-
postAdd
default void postAdd(SourcePostAddDataEvent event) throws PortalException
Method called for each source field after data is added.- Parameters:
event
- the event that contains information about the add operation.- Throws:
PortalException
- Since:
- 10.4.0
-
preUpdate
default void preUpdate(SourcePreUpdateDataEvent event) throws PortalException
Method called for each source field before data is updated.- Parameters:
event
- the event that contains information about the update operation.- Throws:
PortalException
- Since:
- 10.4.0
-
postUpdate
default void postUpdate(SourcePostUpdateDataEvent event) throws PortalException
Method called for each source field after data is updated.- Parameters:
event
- the event that contains information about the update operation.- Throws:
PortalException
- Since:
- 10.4.0
-
-