com.edorasware.one.modeler

Interface ModelerManager

All Known Implementing Classes:

DefaultModelerManager

public interface ModelerManager

Exposes API to retrieve modeler information.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModelerManager.Option

Method Summary

Modifier and Type	Method and Description
List<ModelerManager.Option>	getCaseModels(String ambiguousAppId) Get all Case models for the given App ID.
FrontendObject	getCurrentUser() Get the details of the current user.
List<ModelerManager.Option>	getDmnModels(String ambiguousAppId) Get all dmn models for the given App ID.
List<ModelerManager.Option>	getDocumentModels(String ambiguousAppId) Get all Document models for the given App ID.
List<ModelerManager.Option>	getMailModels(String ambiguousAppId) Get all mail models for the given App ID.
List<ModelerManager.Option>	getModelerUsers() Get all modeler users.
ModelerManager.Option	getOneGroup(String ambiguousId) Get group for the given groupID.
List<ModelerManager.Option>	getOneGroups(String typedText) Get all groups matching the typed text.
ModelerManager.Option	getOneUser(String ambiguousId) Get user for the given user ID.
List<ModelerManager.Option>	getOneUsers(String typedText, String groupIds) Get all users for given group (when group is missing ("", null) do not filter according to groupIds).
List<ModelerManager.Option>	getVisModels(String ambiguousAppId) Get all Vis models for the given App ID.

Method Detail

getModelerUsers

List<ModelerManager.Option> getModelerUsers()

Get all modeler users.

Returns:

list of modeler users

getVisModels

List<ModelerManager.Option> getVisModels(String ambiguousAppId)

Get all Vis models for the given App ID.

Parameters:

ambiguousAppId - the ID of the App (either work object ID value or global ID value)

Returns:

list of Case models

getCaseModels

List<ModelerManager.Option> getCaseModels(String ambiguousAppId)

Get all Case models for the given App ID.

Parameters:

ambiguousAppId - the ID of the App (either work object ID value or global ID value)

Returns:

list of Case models

getDocumentModels

List<ModelerManager.Option> getDocumentModels(String ambiguousAppId)

Get all Document models for the given App ID.

Parameters:

ambiguousAppId - the ID of the App (either work object ID value or global ID value)

Returns:

list of Document models

getMailModels

List<ModelerManager.Option> getMailModels(String ambiguousAppId)

Get all mail models for the given App ID.

Parameters:

ambiguousAppId - the ID of the App (either work object ID value or global ID value)

Returns:

list of Mail models

getDmnModels

List<ModelerManager.Option> getDmnModels(String ambiguousAppId)

Get all dmn models for the given App ID.

Parameters:

ambiguousAppId - the ID of the App (either work object ID value or global ID value)

Returns:

list of Dmn models

getOneGroups

List<ModelerManager.Option> getOneGroups(String typedText)

Get all groups matching the typed text. Typed text is filtering like names

Parameters:

typedText - name like filter

Returns:

list of groups

getOneGroup

ModelerManager.Option getOneGroup(String ambiguousId)

Get group for the given groupID.

Parameters:

ambiguousId - the ID of the group (either object ID value or global ID value)

Returns:

group info

getOneUsers

List<ModelerManager.Option> getOneUsers(String typedText,
                                        String groupIds)

Get all users for given group (when group is missing ("", null) do not filter according to groupIds). Typed text is filtering like names

Parameters:

typedText - name like filter

groupIds - return only users in this group list (comma separated list of groupIds)

Returns:

list of users

getOneUser

ModelerManager.Option getOneUser(String ambiguousId)

Get user for the given user ID.

Parameters:

ambiguousId - the ID of the user (either object ID value or global ID value)

Returns:

user info

getCurrentUser

FrontendObject getCurrentUser()
                       throws Exception

Get the details of the current user.

Returns:

info of the current user

Throws:

Exception - on error