Package org.nuxeo.ecm.core.scroll

Class ScrollDescriptor

java.lang.Object

org.nuxeo.ecm.core.scroll.ScrollDescriptor

All Implemented Interfaces:

Descriptor

public class ScrollDescriptor
extends Object
implements Descriptor

Since:

11.1

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isDefault
protected boolean	isEnabled
protected String	name
protected Map<String,String>	options
protected Map<String,String>	optionsReadOnly
protected Class<? extends Scroll>	scrollClass
protected String	type

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
ScrollDescriptor()

Method Summary

Modifier and Type	Method	Description
String	getId()	The descriptor id, descriptors with same id are merged.
String	getName()
Map<String,String>	getOptions()
String	getType()
boolean	isDefault()
boolean	isEnabled()
Scroll	newScrollInstance()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove, merge

Field Details

isEnabled

protected boolean isEnabled

type

protected String type

name

protected String name

isDefault

protected boolean isDefault

scrollClass

protected Class<? extends Scroll> scrollClass

options

protected Map<String,String> options

optionsReadOnly

protected Map<String,String> optionsReadOnly

Constructor Details

ScrollDescriptor

public ScrollDescriptor()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

newScrollInstance

public Scroll newScrollInstance()

getName

public String getName()

getType

public String getType()

isEnabled

public boolean isEnabled()

isDefault

public boolean isDefault()

getOptions

public Map<String,String> getOptions()