AbstractUMRootObject (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>
- - org.nuxeo.ecm.webengine.model.impl.DefaultObject
  - - org.nuxeo.ecm.restapi.server.jaxrs.PaginableObject<T>
    - - org.nuxeo.ecm.restapi.server.jaxrs.usermanager.AbstractUMRootObject<T>

All Implemented Interfaces:

Resource, Adaptable

Direct Known Subclasses:

GroupRootObject, UserRootObject
```
public abstract class AbstractUMRootObject<T>
extends PaginableObject<T>
```

Field Summary

Fields
Modifier and Type Field Description

protected String query

protected UserManager um
- Fields inherited from class org.nuxeo.ecm.restapi.server.jaxrs.PaginableObject
  currentPageIndex, maxResults, offset, pageSize
- Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
  ctx, next, path, prev, type

Constructor Summary

Constructors
Constructor Description

AbstractUMRootObject()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`checkCurrentUserCanCreateArtifact(T artifact)`
`protected abstract void`	`checkPrecondition(T artifact)`	Checks the precondition to create an artifact (for instance validity, duplicate detection, guards...).
`protected abstract T`	`createArtifact(T artifact)`	Persist an artifact in the underlying persistence system.
`javax.ws.rs.core.Response`	`createNew(T artifact)`
`protected abstract T`	`getArtifact(String id)`	Returns the artifact given its id.
`protected abstract String`	`getArtifactType()`	Returns the type of the current artifact needed for `AbstractResource.newObject(String, Object...)`.
`Object`	`getArtifactWebObject(String artName)`
`protected Object[]`	`getParams()`
`protected void`	`initialize(Object... args)`
`List<T>`	`search()`

Methods inherited from class org.nuxeo.ecm.restapi.server.jaxrs.PaginableObject
extractLongParam, getPageProviderDefinition, getPaginableEntries, getPaginableEntries, getSearchDocument

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject
disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

query
```
protected String query
```

um
```
protected UserManager um
```

Constructor Detail
- AbstractUMRootObject
```
public AbstractUMRootObject()
```

Method Detail
- initialize
```
protected void initialize(Object... args)
```
  Overrides:
  
  initialize in class PaginableObject<T>
- getArtifactWebObject
```
public Object getArtifactWebObject(String artName)
```
- createNew
```
public javax.ws.rs.core.Response createNew(T artifact)
```
- search
```
public List<T> search()
```
- getParams
```
protected Object[] getParams()
```
  Overrides:
  
  getParams in class PaginableObject<T>
- getArtifact
```
protected abstract T getArtifact(String id)
```
  Returns the artifact given its id.
- getArtifactType
```
protected abstract String getArtifactType()
```
  Returns the type of the current artifact needed for AbstractResource.newObject(String, Object...).
- checkPrecondition
```
protected abstract void checkPrecondition(T artifact)
```
  Checks the precondition to create an artifact (for instance validity, duplicate detection, guards...).
- createArtifact
```
protected abstract T createArtifact(T artifact)
```
  Persist an artifact in the underlying persistence system.
- checkCurrentUserCanCreateArtifact
```
protected void checkCurrentUserCanCreateArtifact(T artifact)
```