lumis.doui.source.field
Interface ISourceField

All Known Subinterfaces:

ITableSourceField, ITabularSourceField

All Known Implementing Classes:

BaseSourceField, BaseTableSourceField, BaseTabularSourceField, ChannelTableSourceField, CommentContentLocaleField, DocumentSourceField, FileSizeField, FileTableSourceField, GenericTableSourceField, GroupConfigurationButtonField, GroupTypeConfigurationButtonField, ImageSourceField, MetaDataSourceField, PageTableSourceField, ParentContentSourceField, SingleColumnTableSourceField, VersionActiveField, WorkflowAssignedToSourceField

@StableMinor(version="5.5",
             sinceVersion="4.0")
public interface ISourceField

The interface that defines the methods a source field provides.

Since:

4.0.4

Method Summary

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	isKeywords()
boolean	isParentId()
boolean	isPrimaryName()
boolean	isReadOnly() Returns true if this field is read-only and should not be rendered editable.
boolean	isRequired()
boolean	isRequiredWhenVisible()

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()

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

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