omero.cmd.graphs

Interface WrappableRequest<X>

All Superinterfaces:

IRequest

All Known Implementing Classes:

Chgrp2I, Chmod2I, Chown2I, Delete2I, DuplicateI

public interface WrappableRequest<X>
extends IRequest

Requests that can be wrapped by a SkipHeadI request.

Since:

5.1.0

Author:

m.t.b.carroll@dundee.ac.uk

Method Summary

Modifier and Type	Method and Description
void	adjustGraphPolicy(com.google.common.base.Function<GraphPolicy,GraphPolicy> adjuster) Transform the currently applicable graph policy for this request by the given function.
void	copyFieldsTo(X request) Copy the fields of this request to that of the given request.
GraphPolicy.Action	getActionForStarting()
java.util.Map<java.lang.String,java.util.List<java.lang.Long>>	getStartFrom(omero.cmd.Response response) From the response of the head-skipping request, determine which model objects are the targets of the operation.
int	getStepProvidingCompleteResponse() Get the step of this request that suffices for assembling the request's response.

Methods inherited from interface omero.cmd.IRequest

buildResponse, finish, getCallContext, getResponse, init, step

Method Detail

copyFieldsTo

void copyFieldsTo(X request)

Copy the fields of this request to that of the given request.

Parameters:

request - the target of the field copy

adjustGraphPolicy

void adjustGraphPolicy(com.google.common.base.Function<GraphPolicy,GraphPolicy> adjuster)

Transform the currently applicable graph policy for this request by the given function. Must be called before IRequest.init(omero.cmd.Helper).

Parameters:

adjuster - a transformation function for graph policies

getStepProvidingCompleteResponse

int getStepProvidingCompleteResponse()

Get the step of this request that suffices for assembling the request's response. It is presumed that checking the permissibility of the planned operation occurs afterward.

Returns:

a step number

getActionForStarting

GraphPolicy.Action getActionForStarting()

Returns:

the action associated with nodes qualifying as start objects

getStartFrom

java.util.Map<java.lang.String,java.util.List<java.lang.Long>> getStartFrom(omero.cmd.Response response)

From the response of the head-skipping request, determine which model objects are the targets of the operation.

Parameters:

response - the head-skipping request's response

Returns:

the model objects to target