net.worcade.client.api.WorkOrderApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation

A library for interacting with the Worcade API

There is a newer version: 1.1.2

// Copyright (c) 2017, Worcade. Please see the AUTHORS file for details.
// All rights reserved. Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package net.worcade.client.api;

import net.worcade.client.Result;
import net.worcade.client.api.mixin.RemoteIdsApi;
import net.worcade.client.create.WorkOrderCreate;
import net.worcade.client.get.Reference;
import net.worcade.client.get.WorkOrder;
import net.worcade.client.modify.WorkOrderModification;
import net.worcade.client.modify.WorkOrderRowModification;

import java.util.Collection;

public interface WorkOrderApi extends RemoteIdsApi {
    WorkOrderCreate createBuilder();

    Result get(String id);
    Result update(WorkOrderModification subject);
    /**
     * Create a new Work order in the given conversation. Use the {@link #createBuilder()} method for a new, empty template.
     */
    Result create(String conversationId, WorkOrderCreate subject);

    Result addRows(String id, WorkOrder.Row... rows);
    Result updateRow(String workOrderId, WorkOrderRowModification subject);
    Result removeRows(String id, String... rowIdsToRemove);
    Result removeRows(String id, Collection rowIdsToRemove);
}