def disableUser(self, organizationUser):
params = {
"deleted_at": getTime(),
}
user = User({"id": organizationUser.user['username']})
user.__user__ = organizationUser.__user__
return entityRepository.editEntity(user, params)
def cancel(self):
"""
Cancels the signature request.
Returns
-------
:class:`~labstep.entities.experimentSignatureRequest.model.ExperimentSignatureRequest`
An object representing the revoked signature.
"""
from labstep.generic.entity.repository import entityRepository
fields = {"deleted_at": getTime()}
return entityRepository.editEntity(self, fields)
def delete(self):
"""
Delete a DeviceData.
Example
-------
::
deviceData.delete()
"""
from labstep.generic.entity.repository import entityRepository
return entityRepository.editEntity(self, fields={"deleted_at": getTime()})
def delete(self):
"""
Delete an existing OrderRequest.
Example
-------
::
my_orderRequest = user.getOrderRequest(17000)
my_orderRequest.delete()
"""
from labstep.entities.orderRequest.repository import orderRequestRepository
return orderRequestRepository.editOrderRequest(self, deleted_at=getTime())
def delete(self):
"""
Delete an existing Resource.
Example
-------
::
my_resource = user.getResource(17000)
my_resource.delete()
"""
from labstep.entities.resource.repository import resourceRepository
return resourceRepository.editResource(self, deleted_at=getTime())
def delete(self):
"""
Delete an existing Experiment.
Example
-------
::
my_experiment = user.getExperiment(17000)
my_experiment.delete()
"""
from labstep.entities.experiment.repository import experimentRepository
return experimentRepository.editExperiment(self, deleted_at=getTime())
def delete(self):
"""
Delete an existing Data field.
Example
-------
::
data.delete()
"""
from labstep.entities.protocolDataField.repository import protocolDataFieldRepository
return protocolDataFieldRepository.editDataField(
self, extraParams={"deleted_at": getTime()})
def delete(self):
"""
Delete an existing Device.
Example
-------
::
my_device = user.getDevice(17000)
my_device.delete()
"""
from labstep.entities.device.repository import deviceRepository
return deviceRepository.editDevice(self, deleted_at=getTime())
def delete(self):
"""
Delete an existing Metadata field.
Example
-------
::
metadata.delete()
"""
from labstep.entities.metadata.repository import metadataRepository
return metadataRepository.editMetadata(
self, extraParams={"deleted_at": getTime()})
def delete(self):
"""
Delete the comment.
Example
-------
::
comment.delete()
"""
from labstep.entities.comment.repository import commentRepository
return commentRepository.editComment(
self, extraParams={"deleted_at": getTime()})
def delete(self):
"""
Delete an existing Workspace.
Example
-------
::
my_workspace = user.getWorkspace(17000)
my_workspace.delete()
"""
from labstep.entities.workspace.repository import workspaceRepository
return workspaceRepository.editWorkspace(self, deleted_at=getTime())
def delete(self):
"""
Delete an existing Protocol.
Example
-------
::
my_protocol = user.getProtocol(17000)
my_protocol.delete()
"""
from labstep.entities.protocol.repository import protocolRepository
return protocolRepository.editProtocol(self, deleted_at=getTime())
def delete(self):
"""
Delete an existing collection.
Parameters
----------
collection (obj)
The collection to delete.
Returns
-------
collection
An object representing the collection to delete.
"""
return self.edit(extraParams={"deleted_at": getTime()})
def complete(self):
"""
Mark an existing Experiment Step as 'Complete'.
Example
-------
::
experiment = user.getExperiment(17000)
exp_protocol = experiment.getProtocols()[0]
exp_protocol_steps = exp_protocol.getSteps()
exp_protocol_steps[0].complete()
exp_protocol_steps[1].complete()
exp_protocol_steps[2].complete()
"""
return self.edit(completed_at=getTime())
def delete(self):
"""
Delete an existing ResourceLocation.
Returns
-------
:class:`~labstep.entities.resourceLocation.model.ResourceLocation`
An object representing the deleted ResourceLocation.
Example
-------
::
resource_location = user.getResourceLocation(123)
resource_location.delete()
"""
return self.edit(extraParams={"deleted_at": getTime()})
def end(self):
"""
Update JupyterInstance to indicate that server instance has shutdown.
Parameters
----------
Returns
-------
:class:`~labstep.entities.jupyterInstance.model.JupyterInstance`
An object representing the edited JupyterInstance.
Example
-------
::
my_jupyterInstance = user.getJupyterInstance("872b3e7e-e21f-4403-9ef3-3650fe0d86ba")
my_jupyterInstance.end()
"""
from labstep.entities.jupyterInstance.repository import jupyterInstanceRepository
return jupyterInstanceRepository.editJupyterInstance(
self, endedAt=getTime()
)
