org.wso2.carbon.device.mgt.deviceagent.api.dto

Class Operation

java.lang.Object

org.wso2.carbon.device.mgt.deviceagent.api.dto.Operation

public class Operation
extends Object

Representation of a operation list

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Operation.ControlEnum How the operation should be executed.
static class	Operation.StatusEnum The status of the operation that has been carried out on a device.
static class	Operation.TypeEnum The operation type that was carried out on the device.

Constructor Summary

Constructors

Constructor and Description
Operation()

Method Summary

Modifier and Type	Method and Description
Operation	activityId(String activityId)
Operation	addPropertiesItem(Property propertiesItem)
Operation	addResponsesItem(OperationResponse responsesItem)
Operation	code(String code)
Operation	control(Operation.ControlEnum control)
Operation	createdTimeStamp(String createdTimeStamp)
boolean	equals(Object o)
String	getActivityId() The identifier used to identify the operation uniquely.
String	getCode() operation code
Operation.ControlEnum	getControl() How the operation should be executed.
String	getCreatedTimeStamp() The time when the operation was requested to be carried out
Integer	getId() The operations carried out on a device is recorded in a database table.
Boolean	getIsEnabled() If the assigned value is true it indicates that a policy is enforced on the device.
String	getOperationResponse() Response received from the device
Object	getPayLoad() Payload of the operation to be sent to the device
List<Property>	getProperties() Get properties
String	getReceivedTimeStamp() The time WSO2 EMM received the response from the device
List<OperationResponse>	getResponses() List of operation responses.
Operation.StatusEnum	getStatus() The status of the operation that has been carried out on a device.
Operation.TypeEnum	getType() The operation type that was carried out on the device.
int	hashCode()
Operation	id(Integer id)
Operation	isEnabled(Boolean isEnabled)
Operation	operationResponse(String operationResponse)
Operation	payLoad(Object payLoad)
Operation	properties(List<Property> properties)
Operation	receivedTimeStamp(String receivedTimeStamp)
Operation	responses(List<OperationResponse> responses)
void	setActivityId(String activityId)
void	setCode(String code)
void	setControl(Operation.ControlEnum control)
void	setCreatedTimeStamp(String createdTimeStamp)
void	setId(Integer id)
void	setIsEnabled(Boolean isEnabled)
void	setOperationResponse(String operationResponse)
void	setPayLoad(Object payLoad)
void	setProperties(List<Property> properties)
void	setReceivedTimeStamp(String receivedTimeStamp)
void	setResponses(List<OperationResponse> responses)
void	setStatus(Operation.StatusEnum status)
void	setType(Operation.TypeEnum type)
Operation	status(Operation.StatusEnum status)
String	toString()
Operation	type(Operation.TypeEnum type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Operation

public Operation()

Method Detail

id

public Operation id(Integer id)

getId

public Integer getId()

The operations carried out on a device is recorded in a database table.

Returns:

id

setId

public void setId(Integer id)

code

public Operation code(String code)

getCode

public String getCode()

operation code

Returns:

code

setCode

public void setCode(String code)

properties

public Operation properties(List<Property> properties)

addPropertiesItem

public Operation addPropertiesItem(Property propertiesItem)

getProperties

public List<Property> getProperties()

Get properties

Returns:

properties

setProperties

public void setProperties(List<Property> properties)

type

public Operation type(Operation.TypeEnum type)

getType

public Operation.TypeEnum getType()

The operation type that was carried out on the device.

Returns:

type

setType

public void setType(Operation.TypeEnum type)

status

public Operation status(Operation.StatusEnum status)

getStatus

public Operation.StatusEnum getStatus()

The status of the operation that has been carried out on a device. The operation status can be any one of the following; IN-PROGRESS - The operation is processing on the EMM server side and has not yet been delivered to the device. PENDING - The operation is delivered to the device but the response from the device is pending. COMPLETED - The operation is delivered to the device and the server has received a response back from the device. ERROR - An error has occurred while carrying out the operation.

Returns:

status

setStatus

public void setStatus(Operation.StatusEnum status)

control

public Operation control(Operation.ControlEnum control)

getControl

public Operation.ControlEnum getControl()

How the operation should be executed.

Returns:

control

setControl

public void setControl(Operation.ControlEnum control)

receivedTimeStamp

public Operation receivedTimeStamp(String receivedTimeStamp)

getReceivedTimeStamp

public String getReceivedTimeStamp()

The time WSO2 EMM received the response from the device

Returns:

receivedTimeStamp

setReceivedTimeStamp

public void setReceivedTimeStamp(String receivedTimeStamp)

createdTimeStamp

public Operation createdTimeStamp(String createdTimeStamp)

getCreatedTimeStamp

public String getCreatedTimeStamp()

The time when the operation was requested to be carried out

Returns:

createdTimeStamp

setCreatedTimeStamp

public void setCreatedTimeStamp(String createdTimeStamp)

isEnabled

public Operation isEnabled(Boolean isEnabled)

getIsEnabled

public Boolean getIsEnabled()

If the assigned value is true it indicates that a policy is enforced on the device. If the assigned value is false it indicates that a policy is not enforced on a device.

Returns:

isEnabled

setIsEnabled

public void setIsEnabled(Boolean isEnabled)

payLoad

public Operation payLoad(Object payLoad)

getPayLoad

public Object getPayLoad()

Payload of the operation to be sent to the device

Returns:

payLoad

setPayLoad

public void setPayLoad(Object payLoad)

operationResponse

public Operation operationResponse(String operationResponse)

getOperationResponse

public String getOperationResponse()

Response received from the device

Returns:

operationResponse

setOperationResponse

public void setOperationResponse(String operationResponse)

activityId

public Operation activityId(String activityId)

getActivityId

public String getActivityId()

The identifier used to identify the operation uniquely.

Returns:

activityId

setActivityId

public void setActivityId(String activityId)

responses

public Operation responses(List<OperationResponse> responses)

addResponsesItem

public Operation addResponsesItem(OperationResponse responsesItem)

getResponses

public List<OperationResponse> getResponses()

List of operation responses.

Returns:

responses

setResponses

public void setResponses(List<OperationResponse> responses)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object