omero.model

Class EventI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.Event

omero.model.EventI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _EventOperations, _EventOperationsNC, _IObjectOperations, _IObjectOperationsNC

public class EventI
extends Event
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTAININGEVENT
static java.lang.String	DETAILS
static java.lang.String	EXPERIMENTER
static java.lang.String	EXPERIMENTERGROUP
static java.lang.String	LOGS
static java.lang.String	SESSION
static java.lang.String	STATUS
static java.lang.String	TIME
static java.lang.String	TYPE

Fields inherited from class omero.model.Event

__ids, containingEvent, experimenter, experimenterGroup, logsLoaded, logsSeq, serialVersionUID, session, status, time, type

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
EventI()
EventI(long id, boolean loaded)
EventI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
void	addAllEventLogSet(java.util.List<EventLog> targets, Ice.Current current)
void	addEventLog(EventLog target, Ice.Current current)
static java.util.List<EventI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
void	clearLogs(Ice.Current current)
java.util.List	copyLogs(Ice.Current current)
void	copyObject(ome.util.Filterable model, ome.util.ModelMapper _mapper) Used by IceMapper to inject an "ome.model" object into this "omero.model" object.
protected void	errorIfUnloaded()
ome.util.Filterable	fillObject(ome.util.ReverseModelMapper _mapper) Used by IceMapper produce an "ome.model" object from this "omero.model" object.
Event	getContainingEvent(Ice.Current current)
Details	getDetails(Ice.Current current)
Experimenter	getExperimenter(Ice.Current current)
ExperimenterGroup	getExperimenterGroup(Ice.Current current)
RLong	getId(Ice.Current current)
protected java.util.List	getLogs(Ice.Current current)
Session	getSession(Ice.Current current)
RString	getStatus(Ice.Current current)
RTime	getTime(Ice.Current current)
EventType	getType(Ice.Current current)
boolean	isAnnotated(Ice.Current current) Allows for the attachment of any omero.model.Annotation subclasses.
boolean	isGlobal(Ice.Current current) Marker interface which means that special rules apply for both reading and writing these instances.
boolean	isLink(Ice.Current current) A link between two other types.
boolean	isLoaded(Ice.Current current) Tests if the objects are loaded or not.
boolean	isLogsLoaded()
boolean	isMutable(Ice.Current current) The server will persist changes made to these types.
java.util.Iterator	iterateLogs()
IObject	proxy(Ice.Current current) Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );
void	reloadLogs(Event toCopy, Ice.Current current)
void	removeAllEventLogSet(java.util.List<EventLog> targets, Ice.Current current)
void	removeEventLog(EventLog target, Ice.Current current)
void	setContainingEvent(Event containingEvent, Ice.Current current)
void	setExperimenter(Experimenter experimenter, Ice.Current current)
void	setExperimenterGroup(ExperimenterGroup experimenterGroup, Ice.Current current)
void	setId(RLong id, Ice.Current current)
protected void	setLogs(java.util.List logs, Ice.Current current)
void	setSession(Session session, Ice.Current current)
void	setStatus(RString status, Ice.Current current)
void	setTime(RTime time, Ice.Current current)
void	setType(EventType type, Ice.Current current)
IObject	shallowCopy(Ice.Current current) Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.
int	sizeOfLogs(Ice.Current current)
protected void	throwNullCollectionException(java.lang.String propertyName)
protected void	toggleCollectionsLoaded(boolean load)
void	unload(Ice.Current current) Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.
void	unloadCollections(Ice.Current current) Each collection can also be unloaded, independently of the object itself.
void	unloadContainingEvent()
void	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadExperimenter()
void	unloadExperimenterGroup()
void	unloadLogs(Ice.Current current)
void	unloadSession()
void	unloadStatus()
void	unloadTime()
void	unloadType()

Methods inherited from class omero.model.Event

___addAllEventLogSet, ___addEventLog, ___clearLogs, ___copyLogs, ___getContainingEvent, ___getExperimenter, ___getExperimenterGroup, ___getSession, ___getStatus, ___getTime, ___getType, ___reloadLogs, ___removeAllEventLogSet, ___removeEventLog, ___setContainingEvent, ___setExperimenter, ___setExperimenterGroup, ___setSession, ___setStatus, ___setTime, ___setType, ___sizeOfLogs, ___unloadLogs, __dispatch, __readImpl, __writeImpl, addAllEventLogSet, addEventLog, clearLogs, clone, copyLogs, getContainingEvent, getExperimenter, getExperimenterGroup, getSession, getStatus, getTime, getType, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, reloadLogs, removeAllEventLogSet, removeEventLog, setContainingEvent, setExperimenter, setExperimenterGroup, setSession, setStatus, setTime, setType, sizeOfLogs, unloadLogs

Methods inherited from class omero.model.IObject

___getDetails, ___getId, ___isAnnotated, ___isGlobal, ___isLink, ___isLoaded, ___isMutable, ___proxy, ___setId, ___shallowCopy, ___unload, ___unloadCollections, ___unloadDetails, getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Methods inherited from class Ice.ObjectImpl

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface omero.model._IObjectOperationsNC

getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Field Detail

STATUS

public static final java.lang.String STATUS

See Also:

Constant Field Values

TIME

public static final java.lang.String TIME

See Also:

Constant Field Values

EXPERIMENTER

public static final java.lang.String EXPERIMENTER

See Also:

Constant Field Values

EXPERIMENTERGROUP

public static final java.lang.String EXPERIMENTERGROUP

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

CONTAININGEVENT

public static final java.lang.String CONTAININGEVENT

See Also:

Constant Field Values

LOGS

public static final java.lang.String LOGS

See Also:

Constant Field Values

SESSION

public static final java.lang.String SESSION

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

EventI

public EventI()

EventI

public EventI(long id,
              boolean loaded)

EventI

public EventI(RLong id,
              boolean loaded)

Method Detail

errorIfUnloaded

protected void errorIfUnloaded()
                        throws UnloadedEntityException

Throws:

UnloadedEntityException

throwNullCollectionException

protected void throwNullCollectionException(java.lang.String propertyName)
                                     throws UnloadedCollectionException

Throws:

UnloadedCollectionException

toggleCollectionsLoaded

protected void toggleCollectionsLoaded(boolean load)

unload

public void unload(Ice.Current current)

Description copied from interface: _IObjectOperations

Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.

Specified by:

unload in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLoaded

public boolean isLoaded(Ice.Current current)

Description copied from interface: _IObjectOperations

Tests if the objects are loaded or not. If this value is false, then any method call on this instance other than getId or setId will result in an exception.

Specified by:

isLoaded in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

unloadCollections

public void unloadCollections(Ice.Current current)

Description copied from interface: _IObjectOperations

Each collection can also be unloaded, independently of the object itself. To unload all collections, use: object.unloadCollections(); This is useful when it is possible that a collection no longer represents the state in the database, and passing the collections back to the server might delete some entities. Sending back empty collections can also save a significant amount of bandwidth, when working with large data graphs.

Specified by:

unloadCollections in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isGlobal

public boolean isGlobal(Ice.Current current)

Description copied from interface: _IObjectOperations

Marker interface which means that special rules apply for both reading and writing these instances.

Specified by:

isGlobal in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isMutable

public boolean isMutable(Ice.Current current)

Description copied from interface: _IObjectOperations

The server will persist changes made to these types. Methods provided: - getVersion() - setVersion()

Specified by:

isMutable in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isAnnotated

public boolean isAnnotated(Ice.Current current)

Description copied from interface: _IObjectOperations

Allows for the attachment of any omero.model.Annotation subclasses. Methods provided are: - linkAnnotation(Annotation) -

Specified by:

isAnnotated in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLink

public boolean isLink(Ice.Current current)

Description copied from interface: _IObjectOperations

A link between two other types. Methods provided: - getParent() - getChild()

Specified by:

isLink in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

shallowCopy

public IObject shallowCopy(Ice.Current current)

Description copied from interface: _IObjectOperations

Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.

Specified by:

shallowCopy in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

proxy

public IObject proxy(Ice.Current current)

Description copied from interface: _IObjectOperations

Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );

Specified by:

proxy in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

getId

public RLong getId(Ice.Current current)

Specified by:

getId in interface _IObjectOperations

setId

public void setId(RLong id,
                  Ice.Current current)

Specified by:

setId in interface _IObjectOperations

getDetails

public Details getDetails(Ice.Current current)

Specified by:

getDetails in interface _IObjectOperations

unloadDetails

public void unloadDetails(Ice.Current current)

Description copied from interface: _IObjectOperations

As with collections, the objects under details can link to many other objects. Unloading the details can same bandwidth and simplify the server logic.

Specified by:

unloadDetails in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

unloadStatus

public void unloadStatus()

getStatus

public RString getStatus(Ice.Current current)
                  throws UnloadedEntityException

Specified by:

getStatus in interface _EventOperations

Throws:

UnloadedEntityException

setStatus

public void setStatus(RString status,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:

setStatus in interface _EventOperations

Throws:

UnloadedEntityException

unloadTime

public void unloadTime()

getTime

public RTime getTime(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getTime in interface _EventOperations

Throws:

UnloadedEntityException

setTime

public void setTime(RTime time,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setTime in interface _EventOperations

Throws:

UnloadedEntityException

unloadExperimenter

public void unloadExperimenter()

getExperimenter

public Experimenter getExperimenter(Ice.Current current)
                             throws UnloadedEntityException

Specified by:

getExperimenter in interface _EventOperations

Throws:

UnloadedEntityException

setExperimenter

public void setExperimenter(Experimenter experimenter,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:

setExperimenter in interface _EventOperations

Throws:

UnloadedEntityException

unloadExperimenterGroup

public void unloadExperimenterGroup()

getExperimenterGroup

public ExperimenterGroup getExperimenterGroup(Ice.Current current)
                                       throws UnloadedEntityException

Specified by:

getExperimenterGroup in interface _EventOperations

Throws:

UnloadedEntityException

setExperimenterGroup

public void setExperimenterGroup(ExperimenterGroup experimenterGroup,
                                 Ice.Current current)
                          throws UnloadedEntityException

Specified by:

setExperimenterGroup in interface _EventOperations

Throws:

UnloadedEntityException

unloadType

public void unloadType()

getType

public EventType getType(Ice.Current current)
                  throws UnloadedEntityException

Specified by:

getType in interface _EventOperations

Throws:

UnloadedEntityException

setType

public void setType(EventType type,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setType in interface _EventOperations

Throws:

UnloadedEntityException

unloadContainingEvent

public void unloadContainingEvent()

getContainingEvent

public Event getContainingEvent(Ice.Current current)
                         throws UnloadedEntityException

Specified by:

getContainingEvent in interface _EventOperations

Throws:

UnloadedEntityException

setContainingEvent

public void setContainingEvent(Event containingEvent,
                               Ice.Current current)
                        throws UnloadedEntityException

Specified by:

setContainingEvent in interface _EventOperations

Throws:

UnloadedEntityException

unloadLogs

public void unloadLogs(Ice.Current current)

Specified by:

unloadLogs in interface _EventOperations

getLogs

protected java.util.List getLogs(Ice.Current current)
                          throws UnloadedEntityException

Throws:

UnloadedEntityException

setLogs

protected void setLogs(java.util.List logs,
                       Ice.Current current)
                throws UnloadedEntityException

Throws:

UnloadedEntityException

isLogsLoaded

public boolean isLogsLoaded()

sizeOfLogs

public int sizeOfLogs(Ice.Current current)
               throws UnloadedEntityException

Specified by:

sizeOfLogs in interface _EventOperations

Throws:

UnloadedEntityException

copyLogs

public java.util.List copyLogs(Ice.Current current)
                        throws UnloadedEntityException

Specified by:

copyLogs in interface _EventOperations

Throws:

UnloadedEntityException

iterateLogs

public java.util.Iterator iterateLogs()
                               throws UnloadedEntityException

Throws:

UnloadedEntityException

addEventLog

public void addEventLog(EventLog target,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:

addEventLog in interface _EventOperations

Throws:

UnloadedEntityException

addAllEventLogSet

public void addAllEventLogSet(java.util.List<EventLog> targets,
                              Ice.Current current)
                       throws UnloadedEntityException

Specified by:

addAllEventLogSet in interface _EventOperations

Throws:

UnloadedEntityException

removeEventLog

public void removeEventLog(EventLog target,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

removeEventLog in interface _EventOperations

Throws:

UnloadedEntityException

removeAllEventLogSet

public void removeAllEventLogSet(java.util.List<EventLog> targets,
                                 Ice.Current current)
                          throws UnloadedEntityException

Specified by:

removeAllEventLogSet in interface _EventOperations

Throws:

UnloadedEntityException

clearLogs

public void clearLogs(Ice.Current current)
               throws UnloadedEntityException

Specified by:

clearLogs in interface _EventOperations

Throws:

UnloadedEntityException

reloadLogs

public void reloadLogs(Event toCopy,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:

reloadLogs in interface _EventOperations

Throws:

UnloadedEntityException

unloadSession

public void unloadSession()

getSession

public Session getSession(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getSession in interface _EventOperations

Throws:

UnloadedEntityException

setSession

public void setSession(Session session,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:

setSession in interface _EventOperations

Throws:

UnloadedEntityException

copyObject

public void copyObject(ome.util.Filterable model,
                       ome.util.ModelMapper _mapper)

Used by IceMapper to inject an "ome.model" object into this "omero.model" object.

Specified by:

copyObject in interface ome.model.ModelBased

fillObject

public ome.util.Filterable fillObject(ome.util.ReverseModelMapper _mapper)

Used by IceMapper produce an "ome.model" object from this "omero.model" object.

Specified by:

fillObject in interface ome.model.ModelBased

cast

public static java.util.List<EventI> cast(java.util.List list)

Casts (without warning) the given list to a list of the current type.

Throws:

java.lang.ClassCastException