Android Open Source - cloudmine-android Base Object Delete Request

From Project

License

The source code is released under:

Copyright (c) 2012 CloudMine LLC, http://cloudmine.me Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software")...

If you think the Android project cloudmine-android listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

package com.cloudmine.api.rest;
//from w  w  w  . j a v  a2 s  .c o  m
import com.android.volley.NetworkResponse;
import com.android.volley.Response;
import com.cloudmine.api.CMApiCredentials;
import com.cloudmine.api.CMSessionToken;
import com.cloudmine.api.rest.options.CMServerFunction;
import com.cloudmine.api.rest.response.ObjectModificationResponse;
import me.cloudmine.annotations.Expand;
import me.cloudmine.annotations.Optional;
import me.cloudmine.annotations.Single;

import java.util.Collection;

/**
 * A request for deleting one or more cloudmine objects
 * <br>
 * Copyright CloudMine LLC. All rights reserved<br>
 * See LICENSE file included with SDK for details.
 */
public class BaseObjectDeleteRequest extends CloudMineRequest<ObjectModificationResponse> {
    public static final int REQUEST_TYPE = 408;
    private static final CMURLBuilder BASE_URL = new CMURLBuilder("/data", true);

    /**
     * Delete all of the objects with the given ids
     * @param objectIds the ids of the objects to delete
     * @param sessionToken an optional sessionToken. If specified, it is assumed the objects are user level
     * @param apiCredentials
     * @param serverFunction
     * @param responseListener
     * @param errorListener
     */
    @Expand
    public BaseObjectDeleteRequest(@Single Collection<String> objectIds, @Optional CMSessionToken sessionToken, @Optional CMApiCredentials apiCredentials, @Optional CMServerFunction serverFunction, @Optional Response.Listener<ObjectModificationResponse> responseListener, @Optional Response.ErrorListener errorListener) {
        super(Method.DELETE, new CMURLBuilder("", true).delete(objectIds).user(sessionToken).serverFunction(serverFunction).asUrlString(), null, sessionToken, apiCredentials, responseListener, errorListener);
    }

    /**
     * Create a new ObjectDeleteRequest for deleting all objects. This request will do nothing
     * if deleteAll is equal to false
     * @param deleteAll True to delete all objects; if false, the request has no effect
     * @param sessionToken An optional session token. If specified, deletes all user level data for the user who is logged in
     * @param apiCredentials
     * @param serverFunction
     * @param responseListener
     * @param errorListener
     */
    @Expand
    public BaseObjectDeleteRequest(boolean deleteAll, @Optional CMSessionToken sessionToken, @Optional CMApiCredentials apiCredentials, @Optional CMServerFunction serverFunction, @Optional Response.Listener<ObjectModificationResponse> responseListener, @Optional Response.ErrorListener errorListener) {
        super(Method.DELETE,
                deleteAll ? BASE_URL.copy().deleteAll().user(sessionToken).serverFunction(serverFunction).asUrlString() : BASE_URL.copy().user(sessionToken).serverFunction(serverFunction).asUrlString(),
                null, sessionToken, apiCredentials, responseListener, errorListener);
    }

    @Override
    protected Response<ObjectModificationResponse> parseNetworkResponse(NetworkResponse networkResponse) {
        return Response.success(new ObjectModificationResponse(new String(networkResponse.data), networkResponse.statusCode), getCacheEntry());
    }

    @Override
    public int getRequestType() {
        return REQUEST_TYPE;
    }
}

Java Source Code List