com.edorasware.one.frontendobject

Interface FrontendObjectManager

public interface FrontendObjectManager

Manager interface for generic (@link FrontendObject} REST services.

Method Summary

Methods

Modifier and Type	Method and Description
long	count(String query) Returns the result count for the given search query.
FrontendObject	create(FrontendObject frontendObject, String comment) Creates a new work item from the given frontend object.
FrontendObject	get(com.edorasware.commons.core.entity.WorkObjectId id) Returns the current work item state.
void	move(com.edorasware.commons.core.entity.WorkObjectId id, com.edorasware.commons.core.entity.WorkObjectId newParentId, String comment) Moves a given work item to a new parent.
FrontendObject	save(FrontendObject frontendObject, String comment) Saves changes to a work item from a given frontend object.
List<FrontendObject>	search(String query, int offset, int limit) Executes the given search query.
void	signal(com.edorasware.gear.core.process.ProcessId processId) Sends a signal to the given process.

Method Detail

create

FrontendObject create(FrontendObject frontendObject,
                    String comment)
                      throws Exception

Creates a new work item from the given frontend object.

Parameters:

frontendObject - the frontend object

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the work item could not be created

get

FrontendObject get(com.edorasware.commons.core.entity.WorkObjectId id)

Returns the current work item state.

Parameters:

id - the work object ID

Returns:

the frontend object

save

FrontendObject save(FrontendObject frontendObject,
                  String comment)
                    throws Exception

Saves changes to a work item from a given frontend object.

Parameters:

frontendObject - the frontend object

comment - the change comment

Returns:

the new frontend object

Throws:

Exception

move

void move(com.edorasware.commons.core.entity.WorkObjectId id,
        com.edorasware.commons.core.entity.WorkObjectId newParentId,
        String comment)
          throws Exception

Moves a given work item to a new parent.

Parameters:

id - the ID of the work object to be moved

newParentId - the new parent work object ID

comment - the change comment

Throws:

Exception - if the work object could not be moved

search

List<FrontendObject> search(String query,
                          int offset,
                          int limit)

Executes the given search query.

Parameters:

query - the query to be executed

Returns:

the query results as frontend objects

count

long count(String query)

Returns the result count for the given search query.

Parameters:

query - the query to be executed

Returns:

the count of query results

signal

void signal(com.edorasware.gear.core.process.ProcessId processId)

Sends a signal to the given process.

Parameters:

processId - the process ID