net.bluemind.deferredaction.api

Interface IDeferredAction

All Superinterfaces:

IChangelogSupport, IDataShardSupport

All Known Implementing Classes:

DeferredActionService

@Path(value="/deferredaction/{containerUid}")
public interface IDeferredAction
extends IChangelogSupport, IDataShardSupport

Manages DeferredAction's which describe an action which will be executed at a specific date. This api works on a specific container exposed by IDeferredActionContainerUids

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String uid, DeferredAction deferredAction) Creates a new DeferredAction with the given uid.
void	delete(java.lang.String uid) Deletes a DeferredAction.
void	deleteAll() Deletes all DeferredAction.
java.util.List<ItemValue<DeferredAction>>	getByActionId(java.lang.String actionId, java.lang.Long to) Fetches a list of all DeferredActions matching an actionId and period of time
java.util.List<ItemValue<DeferredAction>>	getByReference(java.lang.String reference) Fetches a list of all DeferredActions matching a reference
ItemValue<DeferredAction>	getComplete(java.lang.String uid) Fetches a DeferredAction.
java.util.List<ItemValue<DeferredAction>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple DeferredActions by their uids.
void	update(java.lang.String uid, DeferredAction deferredAction) Updates a DeferredAction.

Methods inherited from interface net.bluemind.core.container.api.IChangelogSupport

allIds, changeset, changesetById, containerChangelog, filteredChangesetById, getVersion, itemChangelog

Methods inherited from interface net.bluemind.core.container.api.IDataShardSupport

xfer

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       DeferredAction deferredAction)
                                throws ServerFault

Creates a new DeferredAction with the given uid.

Parameters:

uid - the deferred action's unique id

deferredAction - deferred action data

Throws:

ServerFault - standard error object (unchecked exception)

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        DeferredAction deferredAction)
                                 throws ServerFault

Updates a DeferredAction.

Parameters:

uid - the deferred action's unique id

deferredAction - deferred action data

Throws:

ServerFault - standard error object (unchecked exception)

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Deletes a DeferredAction.

Parameters:

uid - the deferred action's unique id

Throws:

ServerFault - standard error object (unchecked exception)

deleteAll

@DELETE
 @Path(value="_deleteAll")
void deleteAll()
                                           throws ServerFault

Deletes all DeferredAction.

Throws:

ServerFault - standard error object (unchecked exception)

getComplete

@GET
 @Path(value="{uid}")
ItemValue<DeferredAction> getComplete(@PathParam(value="uid")
                                                                 java.lang.String uid)
                                                          throws ServerFault

Fetches a DeferredAction.

Parameters:

uid - the deferred action's unique id

Throws:

ServerFault - standard error object (unchecked exception)

getByActionId

@GET
 @Path(value="{actionId}/_byaction")
java.util.List<ItemValue<DeferredAction>> getByActionId(@PathParam(value="actionId")
                                                                                                  java.lang.String actionId,
                                                                                                  @QueryParam(value="to")
                                                                                                  java.lang.Long to)
                                                                                           throws ServerFault

Fetches a list of all DeferredActions matching an actionId and period of time

Parameters:

actionId - the actionId

from - fetches actions having date > from

to - fetches actions having date < to

Throws:

ServerFault - standard error object (unchecked exception)

getByReference

@GET
 @Path(value="{reference}/_byreference")
java.util.List<ItemValue<DeferredAction>> getByReference(@PathParam(value="reference")
                                                                                                       java.lang.String reference)
                                                                                                throws ServerFault

Fetches a list of all DeferredActions matching a reference

Parameters:

reference - the reference

Throws:

ServerFault - standard error object (unchecked exception)

multipleGet

@POST
 @Path(value="_mget")
java.util.List<ItemValue<DeferredAction>> multipleGet(java.util.List<java.lang.String> uids)
                                                                           throws ServerFault

Fetch multiple DeferredActions by their uids.

Parameters:

uids - the unique identifiers to fetch

Returns:

a list of ItemValue

Throws:

ServerFault - If anything goes wrong