lumis.doui.source.field.type
Class FilesDataType.Data

java.lang.Object
  lumis.portal.file.FilesConfig
      lumis.doui.source.field.type.FilesDataType.Data

All Implemented Interfaces:

IRenderable, ISearchable

Enclosing class:

FilesDataType

public static class FilesDataType.Data
extends FilesConfig
implements IRenderable, ISearchable

Data object for a field with data type files.

Since:

4.0.8

Constructor Summary

FilesDataType.Data(FilesConfig filesConfig)

Method Summary

String	getDisplayString(IRenderer renderer) Returns the display string, as defined in FileDataType.Data.getDisplayString(IRenderer), of each file in this files data, separated by comma.
String	getRenderData(IRenderer renderer) Returns the data of this object in a standard xml format.
Collection<SearchContentAttachment>	getSearchContentAttachments() Returns the search content attachments to be used for indexing this object.
List<SearchContentField>	getSearchContentFields() Returns the search content fields to be used for indexing this object.

Methods inherited from class lumis.portal.file.FilesConfig

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesDataType.Data

public FilesDataType.Data(FilesConfig filesConfig)

Method Detail

getRenderData

public String getRenderData(IRenderer renderer)
                     throws PortalException

Description copied from interface: IRenderable

Returns the data of this object in a standard xml format.

Specified by:

getRenderData in interface IRenderable

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the xml data for this object.

Throws:

PortalException

getDisplayString

public String getDisplayString(IRenderer renderer)
                        throws PortalException

Returns the display string, as defined in FileDataType.Data.getDisplayString(IRenderer), of each file in this files data, separated by comma.

Specified by:

getDisplayString in interface IRenderable

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the string to be used to friendly display this instance.

Throws:

PortalException

Since:

4.0.8

getSearchContentAttachments

public Collection<SearchContentAttachment> getSearchContentAttachments()

Description copied from interface: ISearchable

Returns the search content attachments to be used for indexing this object.

Must never return null. May return an empty collection if no attachment is to be used for indexing this object.

Specified by:

getSearchContentAttachments in interface ISearchable

Returns:

the search content attachments.

getSearchContentFields

public List<SearchContentField> getSearchContentFields()

Description copied from interface: ISearchable

Returns the search content fields to be used for indexing this object.

Note that the actual search content fields used are decided by the ISourceSearchContentFiller implementation used in the source. It may or may not use the fields returned by this method. This method provides only the default recommended search fields for this data.

Specified by:

getSearchContentFields in interface ISearchable

Returns:

the search content fields. Never returns null. May return an empty collection if no field is to be used for indexing this object.