com.edorasware.one.rest.manager

Interface WorkObjectManager

All Known Implementing Classes:

DefaultWorkObjectManager

public interface WorkObjectManager

Manages operations on WorkObjects

Method Summary

Modifier and Type	Method and Description
WorkObject	createWorkObject(String typeParam, ValueMap workObjectData) Creates work object
void	deleteWorkObject(String type, String workObjectId) Delete given work object
QueryResponse	findWorkObjectChildren(String parentId, String type, String query, Integer offset, Integer limit, ViewFilter view, Collection<String> fields) Finds child work objects of the given parent id and given type according to the query with offset and limit
QueryResponse	findWorkObjects(String type, String query, Integer offset, Integer limit, ViewFilter view, Collection<String> fields) Finds work objects of the given type according to the query with offset and limit
ValueMap	getWorkObject(String ambiguousId, ViewFilter view, Collection<String> fields, String... expectedTypes) Find the work object by ambiguousId
Map<String,Object>	getWorkObjectWorkForm(String workObjectAmbiguousId, Locale locale) Gets the work form of the work object by model global id or work object id
WorkObject	updateWorkObject(String type, String workObjectId, ValueMap workObjectData) Updates given values on the work object instance

Method Detail

getWorkObject

ValueMap getWorkObject(String ambiguousId,
                       ViewFilter view,
                       Collection<String> fields,
                       String... expectedTypes)

Find the work object by ambiguousId

Parameters:

ambiguousId - work object ambiguousId

view - view to apply to the response

fields - fields to add to the response

expectedTypes - types which the returned workObject is expected of. In the case of empty collection any type is acceptable

Returns:

response with meta information

findWorkObjects

QueryResponse findWorkObjects(String type,
                              String query,
                              Integer offset,
                              Integer limit,
                              ViewFilter view,
                              Collection<String> fields)

Finds work objects of the given type according to the query with offset and limit

Parameters:

type - work object type to search for

query - query to perform

offset - the start of the rows to fetch

limit - the size of fetched data

view - view to apply to the response

fields - fields to add to the response

Returns:

response with meta information

findWorkObjectChildren

QueryResponse findWorkObjectChildren(String parentId,
                                     String type,
                                     String query,
                                     Integer offset,
                                     Integer limit,
                                     ViewFilter view,
                                     Collection<String> fields)

Finds child work objects of the given parent id and given type according to the query with offset and limit

Parameters:

parentId - parent work object id

type - work object type to search for

query - query to perform

offset - the start of the rows to fetch

limit - the size of fetched data

view - view to apply to the response

fields - fields to add to the response

Returns:

response with meta information

getWorkObjectWorkForm

Map<String,Object> getWorkObjectWorkForm(String workObjectAmbiguousId,
                                         Locale locale)

Gets the work form of the work object by model global id or work object id

Parameters:

workObjectAmbiguousId - model global id or work object id

locale - the locale to be used for translation

Returns:

work form definition

createWorkObject

WorkObject createWorkObject(String typeParam,
                            ValueMap workObjectData)

Creates work object

Parameters:

typeParam - work object type

workObjectData - work object data template

Returns:

created work object

updateWorkObject

WorkObject updateWorkObject(String type,
                            String workObjectId,
                            ValueMap workObjectData)

Updates given values on the work object instance

Parameters:

type - work object type to update

workObjectId - work object Id

workObjectData - work object values to update

Returns:

updated work object

deleteWorkObject

void deleteWorkObject(String type,
                      String workObjectId)

Delete given work object

Parameters:

type - work object type to delete

workObjectId - work object identifier