Item Selector Criterion and Return Types

Liferay DXP bundles have apps and app suites containing ItemSelectorCriterion classes and ItemSelectorReturnType classes developers can use.

Item Selector Criterion Classes

Collaboration App Suite Modules:

• com.liferay.item.selector.criteria.api:

  • ImageItemSelectorCriterion: Image file entity type.

  • AudioItemSelectorCriterion: Audio file entity type.

  • FileItemSelectorCriterion: Document Library file entity type.

  • UploadItemSelectorCriterion: Uploadable file entity type.

  • URLItemSelectorCriterion: URL entity type.

  • VideoItemSelectorCriterion: Video file entity type.

• com.liferay.wiki.api has wiki criterion.

Web Experience App Suite Modules:

• com.liferay.site.item.selector.api has site criterion.

• com.liferay.layout.item.selector.api has layout criterion.

• com.liferay.journal.item.selector.api has web content criterion.

If there’s no criterion class for your entity, you can create your own ItemSelectorCriterion class (tutorial coming soon).

Item Selector Return Type Classes

The Liferay Collaboration app suite’s com.liferay.item.selector.criteria.api module includes the following return types:

• Base64ItemSelectorReturnType: Base64 encoding of the entity as a String.

• FileEntryItemSelectorReturnType: File entry information as a JSON object.

• URLItemSelectorReturnType: URL of the entity as a String.

• UUIDItemSelectorReturnType: Universally Unique Identifier (UUID) of the entity as a String.

If there’s no return type class that meets your needs, you can implement your own ItemSelectorReturnType class (tutorial coming soon).