public interface UserService
Modifier and Type | Method and Description |
---|---|
void |
clearCache()
Clear all cached stores.
|
void |
closeTask(Task task)
Close a running task and remove all task attributes from the associated StoreElement.
|
Task |
createTask(StoreElement storeElement,
Workflowable flowable,
Workflow workflow,
String comment)
Create task on Workflowable.
|
Task |
createTask(StoreElement storeElement,
Workflow workflow,
String comment)
Create task on StoreElement.
|
Task |
createTask(StoreElement storeElement,
Workflow workflow,
Task task)
Clone a existing task on a StoreElement.
|
void |
exportStoreElements(OutputStream out,
StoreElement[] elements,
ExportHandler exportHandler) |
Connection |
getConnection() |
ConversionTable |
getConversionTable(String name) |
String[] |
getConversionTableNames() |
List<DeletedElementsInfo> |
getDeletedElementInfos(long startRevisionId,
int resultCount,
Filter<ElementInfo> filter)
Get a list of information objects for deleted elements matching the given filter.
|
Project |
getProject()
Returns the project this userservice belongs to.
|
UserService |
getRemoteUserService(String symbolicName)
Connects the project defined in specified
RemoteProjectConfiguration and returns it's UserService . |
Revision |
getRevision() |
SecurityManager |
getSecurityManager() |
Store |
getStore(Store.Type storeType,
boolean release)
|
Store |
getStore(Store.Type storeType,
boolean forceRefresh,
boolean release) |
Task |
getTask(long taskId)
Returns the task specified by the given task id or
null if no task exists with the given id. |
TemplateStoreRoot |
getTemplateStore()
Shortcut for
getStore(de.espirit.firstspirit.access.store.Store.Type, boolean) getStore(Store.Type.TEMPLATESTORE, false)} |
User |
getUser()
Shortcut for
getConnection().getUser() |
void |
importStoreElements(ZipFile exportFile,
StoreElement parent,
ImportHandler importHandler) |
void |
setTask(Task task) |
@NotNull Store getStore(@NotNull Store.Type storeType, boolean release)
storeType
- store typerelease
- false
for current (work) or true
for release state.@NotNull Store getStore(@NotNull Store.Type storeType, boolean forceRefresh, boolean release)
storeType
- store typeforceRefresh
- if true
the server is queried for a new versionrelease
- false
for current (work) or true
for release state.TemplateStoreRoot getTemplateStore()
getStore(de.espirit.firstspirit.access.store.Store.Type, boolean)
getStore(Store.Type.TEMPLATESTORE, false)}Project getProject()
User getUser()
getConnection().getUser()
SecurityManager getSecurityManager()
Task createTask(StoreElement storeElement, Workflow workflow, String comment)
storeElement
- The element to start the workflow onworkflow
- The Workflow to startcomment
- The workflow start transition commentTask createTask(StoreElement storeElement, Workflowable flowable, Workflow workflow, String comment)
storeElement
- The context element. Used for calculating permissions.flowable
- The Workflowable to start the workflow onworkflow
- The Workflow to startcomment
- The workflow start transition commentTask createTask(StoreElement storeElement, Workflow workflow, Task task)
storeElement
- The element to start the workflow on.workflow
- The Workflow to starttask
- The source task.void closeTask(Task task)
@Nullable Task getTask(long taskId)
null
if no task exists with the given id.taskId
- the id to get the task fornull
void setTask(Task task)
void exportStoreElements(OutputStream out, StoreElement[] elements, @Nullable ExportHandler exportHandler) throws IOException
IOException
void importStoreElements(ZipFile exportFile, StoreElement parent, ImportHandler importHandler) throws IOException, ElementDeletedException, WorkflowLockException
IOException
ElementDeletedException
WorkflowLockException
List<DeletedElementsInfo> getDeletedElementInfos(long startRevisionId, int resultCount, Filter<ElementInfo> filter)
startRevisionId
- The ID of the revision to start taking into account.resultCount
- The (maximum) number of results to collect.filter
- The filter to be applied.DeletedElementsInfo
s.void clearCache()
String[] getConversionTableNames()
ConversionTable getConversionTable(String name)
@Nullable UserService getRemoteUserService(String symbolicName)
RemoteProjectConfiguration
and returns it's UserService
.
Returns null
if the configuration couldn't be found or if the connection couldn't be established.symbolicName
- specifies the RemoteProjectConfiguration
by it's symbolic-name
.UserService
or null
if it couldn't be found or accessed.Connection getConnection()
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500