com.citrix.sharefile.api.entities.SFFileLockEntity Maven / Gradle / Ivy

Go to download

// ------------------------------------------------------------------------------
// 
//     This code was generated by a tool.
//  
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
//     
//	   Copyright (c) 2017 Citrix ShareFile. All rights reserved.
// 
// ------------------------------------------------------------------------------

package com.citrix.sharefile.api.entities;

import com.citrix.sharefile.api.*;
import com.citrix.sharefile.api.entities.*;
import com.citrix.sharefile.api.models.*;
import com.citrix.sharefile.api.SFApiQuery;
import com.citrix.sharefile.api.interfaces.ISFQuery;


import java.io.InputStream;
import java.util.ArrayList;
import java.net.URI;
import java.util.Date;
 
import com.google.gson.annotations.SerializedName;
import com.citrix.sharefile.api.enumerations.SFSafeEnum;
import com.citrix.sharefile.api.enumerations.SFSafeEnumFlags;
import com.citrix.sharefile.api.interfaces.ISFApiClient;
import com.citrix.sharefile.api.exceptions.InvalidOrMissingParameterException;

public class SFFileLockEntity extends SFEntitiesBase
{
	public SFFileLockEntity(ISFApiClient client) {
		super(client);
	}

	/**
	* Get Item Lock info
	* Retrieves the lock info for a given Item.
	* @param url 	 	
	* @return Lock info
	*/
	public ISFQuery getByItem(URI url) throws InvalidOrMissingParameterException 	{
		if (url == null) {
			throw new InvalidOrMissingParameterException("url");
		}

		SFApiQuery sfApiQuery = new SFApiQuery(this.client);
		sfApiQuery.setFrom("Items");
		sfApiQuery.setAction("FileLock");
		sfApiQuery.addIds(url);
		sfApiQuery.setHttpMethod("GET");
		return sfApiQuery;
	}

	/**
	* Create Lock
    * {
    * "Owner":{Id:"ownerid"},
    * "ExpirationTimeInMinutes":180
    * }
	* Expiration can be set either using ExpirationDate or ExpirationTimeInMinutes. If both are provided
	* ExpirationDate takes precedence.
	* @param url 	 	
	* @param fileLock 	 	
	* @return The created item Lock object
	*/
	public ISFQuery createByItem(URI url, SFFileLock fileLock) throws InvalidOrMissingParameterException 	{
		if (url == null) {
			throw new InvalidOrMissingParameterException("url");
		}
		if (fileLock == null) {
			throw new InvalidOrMissingParameterException("fileLock");
		}

		SFApiQuery sfApiQuery = new SFApiQuery(this.client);
		sfApiQuery.setFrom("Items");
		sfApiQuery.setAction("FileLock");
		sfApiQuery.addIds(url);
		sfApiQuery.setBody(fileLock);
		sfApiQuery.setHttpMethod("POST");
		return sfApiQuery;
	}

	/**
	* Update FileLock. Updates expiration time and/or LockType
    * {
    * "LockId":"lockid",
    * "Owner":{Id:"ownerid"},
    * "ExpirationDate": "2016-02-18T21:23:53.373Z"
    * }
	* Expiration can be set either using ExpirationDate or ExpirationTimeInMinutes. If both are provided
	* ExpirationDate takes precedence.
	* @param url 	 	
	* @param fileLock 	 	
	* @return The updated lock object
	*/
	public ISFQuery updateByItem(URI url, SFFileLock fileLock) throws InvalidOrMissingParameterException 	{
		if (url == null) {
			throw new InvalidOrMissingParameterException("url");
		}
		if (fileLock == null) {
			throw new InvalidOrMissingParameterException("fileLock");
		}

		SFApiQuery sfApiQuery = new SFApiQuery(this.client);
		sfApiQuery.setFrom("Items");
		sfApiQuery.setAction("FileLock");
		sfApiQuery.addIds(url);
		sfApiQuery.setBody(fileLock);
		sfApiQuery.setHttpMethod("PATCH");
		return sfApiQuery;
	}

	/**
	* Unlock File
	* Unlock a locked file.
	* @param url 	 	
	*/
	public ISFQuery deleteByItem(URI url, String lockid) throws InvalidOrMissingParameterException 	{
		if (url == null) {
			throw new InvalidOrMissingParameterException("url");
		}
		if (lockid == null) {
			throw new InvalidOrMissingParameterException("lockid");
		}

		SFApiQuery sfApiQuery = new SFApiQuery(this.client);
		sfApiQuery.setFrom("Items");
		sfApiQuery.setAction("FileLock");
		sfApiQuery.addIds(url);
		sfApiQuery.addActionIds(lockid);
		sfApiQuery.setHttpMethod("DELETE");
		return sfApiQuery;
	}

	/**
	* Discard checkout on a File
	* Discard a checkout on a file
	* @param url 	 	
	*/
	public ISFQuery discard(URI url, String lockid) throws InvalidOrMissingParameterException 	{
		if (url == null) {
			throw new InvalidOrMissingParameterException("url");
		}
		if (lockid == null) {
			throw new InvalidOrMissingParameterException("lockid");
		}

		SFApiQuery sfApiQuery = new SFApiQuery(this.client);
		sfApiQuery.setFrom("Items");
		sfApiQuery.setAction("FileLock");
		sfApiQuery.addIds(url);
		sfApiQuery.addActionIds(lockid);
		sfApiQuery.addSubAction("Discard");
		sfApiQuery.setHttpMethod("POST");
		return sfApiQuery;
	}

}