com.anrisoftware.simplerest.owncloud.OwncloudShares Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simplerest-owncloud-ocs Show documentation

Access Owncloud OCS via REST API.

The newest version!

/*
 * Copyright 2016 Erwin Müller 
 *
 * This file is part of simplerest-owncloud-ocs.
 *
 * simplerest-owncloud-ocs is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * simplerest-owncloud-ocs is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with simplerest-owncloud-ocs. If not, see .
 */
package com.anrisoftware.simplerest.owncloud;

import java.util.concurrent.Callable;

import com.anrisoftware.simplerest.core.SimpleRestException;
import com.anrisoftware.simplerest.ocs.SharesMessage;

/**
 * Retrieves information about shares.
 *
 * @author Erwin Müller, [email protected]
 * @since 0.1
 */
public interface OwncloudShares extends Callable {

    /**
     * Returns the account required for authentication.
     *
     * @return the {@link OandaAccount}.
     */
    OwncloudAccount getAccount();

    /**
     * Sets the path to the file or folder.
     *
     * @param path
     *            the {@link String} path or {@code null}.
     */
    void setPath(String path);

    /**
     * Sets to return not only the shares from the current user but all shares
     * from the given file.
     *
     * @param reshares
     *            set to {@code true} to return all shares.
     */
    void setReshares(boolean reshares);

    /**
     * Sets to return all shares within a folder, given that path defines a
     * folder.
     *
     * @param subfiles
     *            set to {@code true} to return all shares within a folder.
     */
    void setSubfiles(boolean subfiles);

    /**
     * Retrieves information about shares.
     *
     * @return this {@link SharesMessage}.
     */
    @Override
    SharesMessage call() throws SimpleRestException;

}