com.citrix.sharefile.api.entities

Class SFAsyncOperationsEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFAsyncOperationsEntity

public class SFAsyncOperationsEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFAsyncOperationsEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFAsyncOperation>	cancel(java.net.URI url) Cancel AsyncOperation Cancels a single Async operation record
ISFQuery<SFODataFeed<SFAsyncOperation>>	cancelBatch(java.lang.String id) Cancel an Operation Batch Cancel an Async Operation batch - all unfinished Async Operation records in that batch will be moved to Cancelled state.
ISFQuery<SFAsyncOperation>	create(SFAsyncOperation asyncOp)
ISFQuery	delete(java.net.URI url) Delete AsyncOperation Cancels a single Async operation record (same as /Cancel)
ISFQuery<SFAsyncOperation>	get(java.net.URI url) Get AsyncOperation by ID Retrieve a single Async Op record by ID
ISFQuery<SFAsyncOperation>	getBatch(java.lang.String id) Get the progress of the AsyncOperations by Opertaion Batch ID
ISFQuery<SFODataFeed<SFAsyncOperation>>	getByBatch(java.lang.String id) Get List of AsyncOperations by Operation Batch ID Retrieves all AsyncOperations on the specified batch
ISFQuery<SFODataFeed<SFAsyncOperation>>	getByFolder(java.lang.String id) Get List of AsyncOperations by Folder Retrieves all AsyncOperations associated with the calling user and the Item ID
ISFQuery<SFAsyncOperation>	update(java.net.URI url, SFAsyncOperation newAsyncOp) Changes the state of an AsyncOperation { "State": "..." } Only the State parameter is updated, other fields are ignored

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFAsyncOperationsEntity

public SFAsyncOperationsEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFAsyncOperation> get(java.net.URI url)
                               throws InvalidOrMissingParameterException

Get AsyncOperation by ID Retrieve a single Async Op record by ID

Parameters:

url -

Returns:

A single Async Operation record

Throws:

InvalidOrMissingParameterException

getByBatch

public ISFQuery<SFODataFeed<SFAsyncOperation>> getByBatch(java.lang.String id)
                                                   throws InvalidOrMissingParameterException

Get List of AsyncOperations by Operation Batch ID Retrieves all AsyncOperations on the specified batch

Parameters:

id -

Returns:

A Feed of AsyncOperation objects, containing all items in the specified batch

Throws:

InvalidOrMissingParameterException

getBatch

public ISFQuery<SFAsyncOperation> getBatch(java.lang.String id)
                                    throws InvalidOrMissingParameterException

Get the progress of the AsyncOperations by Opertaion Batch ID

Parameters:

id -

Throws:

InvalidOrMissingParameterException

getByFolder

public ISFQuery<SFODataFeed<SFAsyncOperation>> getByFolder(java.lang.String id)
                                                    throws InvalidOrMissingParameterException

Get List of AsyncOperations by Folder Retrieves all AsyncOperations associated with the calling user and the Item ID

Parameters:

id -

Returns:

A Feed of AsyncOperation objects, containing all pending operations in the specific folder, for the authenticated SDK user

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFAsyncOperation> create(SFAsyncOperation asyncOp)
                                  throws InvalidOrMissingParameterException

Throws:

InvalidOrMissingParameterException

cancel

public ISFQuery<SFAsyncOperation> cancel(java.net.URI url)
                                  throws InvalidOrMissingParameterException

Cancel AsyncOperation Cancels a single Async operation record

Parameters:

url -

Returns:

The modified Async Operation record

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Delete AsyncOperation Cancels a single Async operation record (same as /Cancel)

Parameters:

url -

Throws:

InvalidOrMissingParameterException

cancelBatch

public ISFQuery<SFODataFeed<SFAsyncOperation>> cancelBatch(java.lang.String id)
                                                    throws InvalidOrMissingParameterException

Cancel an Operation Batch Cancel an Async Operation batch - all unfinished Async Operation records in that batch will be moved to Cancelled state.

Parameters:

id -

Returns:

A list of the modified Async Operations in the batch

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFAsyncOperation> update(java.net.URI url,
                                SFAsyncOperation newAsyncOp)
                                  throws InvalidOrMissingParameterException

Changes the state of an AsyncOperation { "State": "..." } Only the State parameter is updated, other fields are ignored

Parameters:

url -

newAsyncOp -

Returns:

The modified Async Operation

Throws:

InvalidOrMissingParameterException