com.citrix.sharefile.api.models

Class SFAsyncOperation

java.lang.Object

com.citrix.sharefile.api.models.SFODataObject

com.citrix.sharefile.api.models.SFAsyncOperation

public class SFAsyncOperation
extends SFODataObject

Constructor Summary

Constructors

Constructor and Description
SFAsyncOperation()

Method Summary

Methods

Modifier and Type	Method and Description
SFAccount	getAccount() ShareFile Account
SFZone	getAuthorityZone() Represents the Zone that is driving the asynchronous operation process.
java.lang.String	getBatchID() Batch Identifier for an asynchronous operation that includes multiple Items - for example, a recursive Copy will create a single AsyncOp instance per file, all sharing the same BatchID
java.lang.Double	getBatchProgress() BatchProgress indicates the progress of the Batch operation
java.lang.String	getBatchSourceID() Item ID used as source for the Batch operation
SFSafeEnum<SFAsyncOperationState>	getBatchState() Batch Operation state.
java.lang.String	getBatchTargetID() Item ID used as target for the Batch operation
java.lang.Integer	getBatchTotal()
java.util.Date	getCreationDate() Operation creation date
SFSafeEnum<SFAsyncOperationType>	getOperation() Operation type
SFItem	getSource() Source Item for the operation.
SFSafeEnum<SFAsyncOperationState>	getState() Operation state.
SFItem	getTarget() Target Item for the operation.
java.util.Date	getUpdateDate() Last time the operation state was modified
SFUser	getUser() User that initiated the operation
void	setAccount(SFAccount account) ShareFile Account
void	setAuthorityZone(SFZone authorityzone) Represents the Zone that is driving the asynchronous operation process.
void	setBatchID(java.lang.String batchid) Batch Identifier for an asynchronous operation that includes multiple Items - for example, a recursive Copy will create a single AsyncOp instance per file, all sharing the same BatchID
void	setBatchProgress(java.lang.Double batchprogress) BatchProgress indicates the progress of the Batch operation
void	setBatchSourceID(java.lang.String batchsourceid) Item ID used as source for the Batch operation
void	setBatchState(SFSafeEnum<SFAsyncOperationState> batchstate) Batch Operation state.
void	setBatchTargetID(java.lang.String batchtargetid) Item ID used as target for the Batch operation
void	setBatchTotal(java.lang.Integer batchtotal)
void	setCreationDate(java.util.Date creationdate) Operation creation date
void	setOperation(SFSafeEnum<SFAsyncOperationType> operation) Operation type
void	setSource(SFItem source) Source Item for the operation.
void	setState(SFSafeEnum<SFAsyncOperationState> state) Operation state.
void	setTarget(SFItem target) Target Item for the operation.
void	setUpdateDate(java.util.Date updatedate) Last time the operation state was modified
void	setUser(SFUser user) User that initiated the operation

Methods inherited from class com.citrix.sharefile.api.models.SFODataObject

addProperty, get__type, getId, getMetadataUrl, getProperties, geturl, set__type, setId, setMetadataUrl, setProperties, seturl

Methods inherited from class java.lang.Object

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

Constructor Detail

SFAsyncOperation

public SFAsyncOperation()

Method Detail

getOperation

public SFSafeEnum<SFAsyncOperationType> getOperation()

Operation type

setOperation

public void setOperation(SFSafeEnum<SFAsyncOperationType> operation)

Operation type

getAccount

public SFAccount getAccount()

ShareFile Account

setAccount

public void setAccount(SFAccount account)

ShareFile Account

getAuthorityZone

public SFZone getAuthorityZone()

Represents the Zone that is driving the asynchronous operation process. It may be null if the operation is driven by the control plane.

setAuthorityZone

public void setAuthorityZone(SFZone authorityzone)

Represents the Zone that is driving the asynchronous operation process. It may be null if the operation is driven by the control plane.

getSource

public SFItem getSource()

Source Item for the operation.

setSource

public void setSource(SFItem source)

Source Item for the operation.

getUser

public SFUser getUser()

User that initiated the operation

setUser

public void setUser(SFUser user)

User that initiated the operation

getCreationDate

public java.util.Date getCreationDate()

Operation creation date

setCreationDate

public void setCreationDate(java.util.Date creationdate)

Operation creation date

getState

public SFSafeEnum<SFAsyncOperationState> getState()

Operation state. States 'Created' and 'Scheduled' indicate the operation is in progress; States 'Success' and 'Failure' indicate the operatoin is finalized

setState

public void setState(SFSafeEnum<SFAsyncOperationState> state)

Operation state. States 'Created' and 'Scheduled' indicate the operation is in progress; States 'Success' and 'Failure' indicate the operatoin is finalized

getUpdateDate

public java.util.Date getUpdateDate()

Last time the operation state was modified

setUpdateDate

public void setUpdateDate(java.util.Date updatedate)

Last time the operation state was modified

getTarget

public SFItem getTarget()

Target Item for the operation.

setTarget

public void setTarget(SFItem target)

Target Item for the operation.

getBatchID

public java.lang.String getBatchID()

Batch Identifier for an asynchronous operation that includes multiple Items - for example, a recursive Copy will create a single AsyncOp instance per file, all sharing the same BatchID

setBatchID

public void setBatchID(java.lang.String batchid)

Batch Identifier for an asynchronous operation that includes multiple Items - for example, a recursive Copy will create a single AsyncOp instance per file, all sharing the same BatchID

getBatchSourceID

public java.lang.String getBatchSourceID()

Item ID used as source for the Batch operation

setBatchSourceID

public void setBatchSourceID(java.lang.String batchsourceid)

Item ID used as source for the Batch operation

getBatchTargetID

public java.lang.String getBatchTargetID()

Item ID used as target for the Batch operation

setBatchTargetID

public void setBatchTargetID(java.lang.String batchtargetid)

Item ID used as target for the Batch operation

getBatchProgress

public java.lang.Double getBatchProgress()

BatchProgress indicates the progress of the Batch operation

setBatchProgress

public void setBatchProgress(java.lang.Double batchprogress)

BatchProgress indicates the progress of the Batch operation

getBatchState

public SFSafeEnum<SFAsyncOperationState> getBatchState()

Batch Operation state. State 'Scheduled' indicate the operation is in progress; States 'Success' and 'Failure' indicate the operation is finalized

setBatchState

public void setBatchState(SFSafeEnum<SFAsyncOperationState> batchstate)

Batch Operation state. State 'Scheduled' indicate the operation is in progress; States 'Success' and 'Failure' indicate the operation is finalized

getBatchTotal

public java.lang.Integer getBatchTotal()

setBatchTotal

public void setBatchTotal(java.lang.Integer batchtotal)