omero.api

Class _JobHandleTie

java.lang.Object

Ice.ObjectImpl

omero.api._JobHandleDisp

omero.api._JobHandleTie

All Implemented Interfaces:

Ice.Object, Ice.TieBase, java.io.Serializable, java.lang.Cloneable, _JobHandleOperations, _JobHandleOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperations, _StatefulServiceInterfaceOperationsNC, JobHandle, ServiceInterface, StatefulServiceInterface

public class _JobHandleTie
extends _JobHandleDisp
implements Ice.TieBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class omero.api._JobHandleDisp

__ids

Fields inherited from interface omero.api.JobHandle

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_JobHandleTie(_JobHandleOperations delegate)
_JobHandleTie()

Method Summary

Modifier and Type	Method and Description
void	activate_async(AMD_StatefulServiceInterface_activate __cb, Ice.Current __current) Load a service implementation from disk if it was previously passivated.
void	attach_async(AMD_JobHandle_attach __cb, long jobId, Ice.Current __current) Returns the current JobStatus for the Job id.
void	cancelJob_async(AMD_JobHandle_cancelJob __cb, Ice.Current __current) Marks a job for cancellation.
void	close_async(AMD_StatefulServiceInterface_close __cb, Ice.Current __current) Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter.
boolean	equals(java.lang.Object rhs)
void	getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb, Ice.Current __current) To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.
void	getJob_async(AMD_JobHandle_getJob __cb, Ice.Current __current) Returns the current Job
int	hashCode()
java.lang.Object	ice_delegate()
void	ice_delegate(java.lang.Object delegate)
void	jobError_async(AMD_JobHandle_jobError __cb, Ice.Current __current) Returns true if the Job has thrown an error.
void	jobFinished_async(AMD_JobHandle_jobFinished __cb, Ice.Current __current) Returns null if the Job is not finished, otherwise the RTime for when it completed.
void	jobMessage_async(AMD_JobHandle_jobMessage __cb, Ice.Current __current) Returns the current message for job.
void	jobRunning_async(AMD_JobHandle_jobRunning __cb, Ice.Current __current) Returns true if the Job is running, i.e.
void	jobStatus_async(AMD_JobHandle_jobStatus __cb, Ice.Current __current) Returns the current JobStatus.
void	passivate_async(AMD_StatefulServiceInterface_passivate __cb, Ice.Current __current) Causes the blitz server to store the service implementation to disk to free memory.
void	setMessage_async(AMD_JobHandle_setMessage __cb, java.lang.String message, Ice.Current __current) Sets the job's message string, and returns the previous value.
void	setStatus_async(AMD_JobHandle_setStatus __cb, java.lang.String status, Ice.Current __current) Updates the JobStatus for the current job.
void	setStatusAndMessage_async(AMD_JobHandle_setStatusAndMessage __cb, java.lang.String status, RString message, Ice.Current __current) Like setStatus but also sets the message.
void	submit_async(AMD_JobHandle_submit __cb, Job job, Ice.Current __current) Submits a Job and returns its database id.

Methods inherited from class omero.api._JobHandleDisp

___attach, ___cancelJob, ___getJob, ___jobError, ___jobFinished, ___jobMessage, ___jobRunning, ___jobStatus, ___setMessage, ___setStatus, ___setStatusAndMessage, ___submit, __dispatch, __readImpl, __writeImpl, activate_async, attach_async, cancelJob_async, close_async, getCurrentEventContext_async, getJob_async, ice_copyStateFrom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, jobError_async, jobFinished_async, jobMessage_async, jobRunning_async, jobStatus_async, passivate_async, setMessage_async, setStatus_async, setStatusAndMessage_async, submit_async

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_JobHandleTie

public _JobHandleTie()

_JobHandleTie

public _JobHandleTie(_JobHandleOperations delegate)

Method Detail

ice_delegate

public java.lang.Object ice_delegate()

Specified by:

ice_delegate in interface Ice.TieBase

ice_delegate

public void ice_delegate(java.lang.Object delegate)

Specified by:

ice_delegate in interface Ice.TieBase

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

attach_async

public void attach_async(AMD_JobHandle_attach __cb,
                         long jobId,
                         Ice.Current __current)
                  throws ServerError

Description copied from interface: _JobHandleOperations

Returns the current JobStatus for the Job id.

Specified by:

attach_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

cancelJob_async

public void cancelJob_async(AMD_JobHandle_cancelJob __cb,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _JobHandleOperations

Marks a job for cancellation. Not every processor will check for the cancelled flag for a running job, but no non-running job will start if it has been cancelled.

Specified by:

cancelJob_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getJob_async

public void getJob_async(AMD_JobHandle_getJob __cb,
                         Ice.Current __current)
                  throws ServerError

Description copied from interface: _JobHandleOperations

Returns the current Job

Specified by:

getJob_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

jobError_async

public void jobError_async(AMD_JobHandle_jobError __cb,
                           Ice.Current __current)
                    throws ServerError

Description copied from interface: _JobHandleOperations

Returns true if the Job has thrown an error.

Specified by:

jobError_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

jobFinished_async

public void jobFinished_async(AMD_JobHandle_jobFinished __cb,
                              Ice.Current __current)
                       throws ServerError

Description copied from interface: _JobHandleOperations

Returns null if the Job is not finished, otherwise the RTime for when it completed.

Specified by:

jobFinished_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

jobMessage_async

public void jobMessage_async(AMD_JobHandle_jobMessage __cb,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _JobHandleOperations

Returns the current message for job. May be set during processing.

Specified by:

jobMessage_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

jobRunning_async

public void jobRunning_async(AMD_JobHandle_jobRunning __cb,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _JobHandleOperations

Returns true if the Job is running, i.e. has an attached process.

Specified by:

jobRunning_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

jobStatus_async

public void jobStatus_async(AMD_JobHandle_jobStatus __cb,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _JobHandleOperations

Returns the current JobStatus. Will never return null.

Specified by:

jobStatus_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setMessage_async

public void setMessage_async(AMD_JobHandle_setMessage __cb,
                             java.lang.String message,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _JobHandleOperations

Sets the job's message string, and returns the previous value.

Specified by:

setMessage_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setStatus_async

public void setStatus_async(AMD_JobHandle_setStatus __cb,
                            java.lang.String status,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _JobHandleOperations

Updates the JobStatus for the current job. The previous status is returned as a string. If the status is CANCELLED, this method is equivalent to cancelJob.

Specified by:

setStatus_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setStatusAndMessage_async

public void setStatusAndMessage_async(AMD_JobHandle_setStatusAndMessage __cb,
                                      java.lang.String status,
                                      RString message,
                                      Ice.Current __current)
                               throws ServerError

Description copied from interface: _JobHandleOperations

Like setStatus but also sets the message.

Specified by:

setStatusAndMessage_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

submit_async

public void submit_async(AMD_JobHandle_submit __cb,
                         Job job,
                         Ice.Current __current)
                  throws ServerError

Description copied from interface: _JobHandleOperations

Submits a Job and returns its database id. The only fields directly on status which are editable are message, scheduledFor and status. The latter two must be sensible.

Specified by:

submit_async in interface _JobHandleOperations

Parameters:

__cb - The callback object for the operation.

job - Not null

__current - The Current object for the invocation.

Throws:

ServerError

activate_async

public void activate_async(AMD_StatefulServiceInterface_activate __cb,
                           Ice.Current __current)
                    throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

Load a service implementation from disk if it was previously passivated. It is unnecessary to call this method since activation happens automatically, but calling this may prevent a short lapse when the service is first accessed after passivation. It is safe to call this method at any time, even when the service is not passivated.

Specified by:

activate_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

close_async

public void close_async(AMD_StatefulServiceInterface_close __cb,
                        Ice.Current __current)
                 throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter. Any further method calls will fail with a Ice::NoSuchObjectException. Note: with JavaEE, the close method was called publicly, and internally this called destroy(). As of the OmeroBlitz migration, this functionality has been combined.

Specified by:

close_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getCurrentEventContext_async

public void getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb,
                                         Ice.Current __current)
                                  throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.

Specified by:

getCurrentEventContext_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

passivate_async

public void passivate_async(AMD_StatefulServiceInterface_passivate __cb,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

Causes the blitz server to store the service implementation to disk to free memory. This is typically done automatically by the server when a pre-defined memory limit is reached, but can be used by the client if it clear that a stateful service will not be used for some time. Activation will happen automatically whether passivation was done manually or automatically.

Specified by:

passivate_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError