com.edorasware.one.frontendobject

Interface FrontendObjectManager

All Known Implementing Classes:

DefaultFrontendObjectManager

public interface FrontendObjectManager

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

Method Summary

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(String ambiguousId) Returns the current work item state.
FrontendObject	getByGlobalId(String globalId) Returns the current work item state.
void	move(String ambiguousId, String newParentAmbiguousId, boolean includeDescendants, boolean checkReferencedModelsConsistency, boolean copyDescendants, String comment) Moves a given work item to a new parent.
void	moveByGlobalId(String globalId, String newParentGlobalId, boolean includeDescendants, boolean checkReferencedModelsConsistency, boolean copyDescendants, 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(String 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(String ambiguousId)

Returns the current work item state.

Parameters:

ambiguousId - the work object ID (may either be a work object ID or a global ID)

Returns:

the frontend object

getByGlobalId

FrontendObject getByGlobalId(String globalId)

Returns the current work item state.

Parameters:

globalId - the work object global 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(String ambiguousId,
          String newParentAmbiguousId,
          boolean includeDescendants,
          boolean checkReferencedModelsConsistency,
          boolean copyDescendants,
          String comment)
   throws Exception

Moves a given work item to a new parent.

Parameters:

ambiguousId - the ID of the work object to be moved (either work object ID or global ID value)

newParentAmbiguousId - the new parent ID (either work object ID or global ID value)

includeDescendants - include referenced work objects into the move

checkReferencedModelsConsistency - check whether forms included in the move are not referenced from outside

copyDescendants - move work object and copy all descendants to the new parent

comment - the change comment

Throws:

Exception - if the work object could not be moved

moveByGlobalId

void moveByGlobalId(String globalId,
                    String newParentGlobalId,
                    boolean includeDescendants,
                    boolean checkReferencedModelsConsistency,
                    boolean copyDescendants,
                    String comment)
             throws Exception

Moves a given work item to a new parent.

Parameters:

globalId - the global ID of the work object to be moved

newParentGlobalId - the new parent work object global ID

includeDescendants - include referenced work objects into the move

checkReferencedModelsConsistency - check whether forms included in the move are not referenced from outside

copyDescendants - move work object and copy all descendants to the new parent

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(String processId)

Sends a signal to the given process.

Parameters:

processId - the process ID