ShareI (omero-blitz 5.5.3 API)

java.lang.Object
- Ice.ObjectImpl
- - omero.model.IObject
  - - omero.model.Session
    - - omero.model.Share
      - omero.model.ShareI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IObjectOperations, _IObjectOperationsNC, _SessionOperations, _SessionOperationsNC, _ShareOperations, _ShareOperationsNC
```
public class ShareI
extends Share
implements ome.model.ModelBased
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTIVE`
`static java.lang.String`	`ANNOTATIONLINKS`
`static java.lang.String`	`CLOSED`
`static java.lang.String`	`DATA`
`static java.lang.String`	`DEFAULTEVENTTYPE`
`static java.lang.String`	`DETAILS`
`static java.lang.String`	`EVENTS`
`static java.lang.String`	`GROUP`
`static java.lang.String`	`ITEMCOUNT`
`static java.lang.String`	`MESSAGE`
`static java.lang.String`	`NODE`
`static java.lang.String`	`OWNER`
`static java.lang.String`	`STARTED`
`static java.lang.String`	`SUDOER`
`static java.lang.String`	`TIMETOIDLE`
`static java.lang.String`	`TIMETOLIVE`
`static java.lang.String`	`USERAGENT`
`static java.lang.String`	`USERIP`
`static java.lang.String`	`UUID`

Fields inherited from class omero.model.Share
__ids, active, data, group, itemCount, serialVersionUID

Fields inherited from class omero.model.Session
annotationLinksCountPerOwner, annotationLinksLoaded, annotationLinksSeq, closed, defaultEventType, eventsLoaded, eventsSeq, message, node, owner, started, sudoer, timeToIdle, timeToLive, userAgent, userIP, uuid, version

Fields inherited from class omero.model.IObject
details, id, loaded

Fields inherited from interface Ice.Object
ice_staticId

Constructor Summary

Constructors
Constructor and Description

ShareI()

ShareI(long id, boolean loaded)

ShareI(RLong id, boolean loaded)

Constructors
Constructor and Description
`ShareI()`
`ShareI(long id, boolean loaded)`
`ShareI(RLong id, boolean loaded)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllEventSet(java.util.List<Event> targets, Ice.Current current)`
`void`	`addAllSessionAnnotationLinkSet(java.util.List<SessionAnnotationLink> targets, Ice.Current current)`
`void`	`addEvent(Event target, Ice.Current current)`
`void`	`addSessionAnnotationLink(SessionAnnotationLink target, Ice.Current current)`
`void`	`addSessionAnnotationLinkToBoth(SessionAnnotationLink link, boolean bothSides, Ice.Current current)`
`static java.util.List<ShareI>`	`cast(java.util.List list)` Casts (without warning) the given list to a list of the current type.
`void`	`clearAnnotationLinks(Ice.Current current)`
`void`	`clearEvents(Ice.Current current)`
`java.util.List`	`copyAnnotationLinks(Ice.Current current)`
`java.util.List`	`copyEvents(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.
`java.util.List<SessionAnnotationLink>`	`findSessionAnnotationLink(Annotation removal, Ice.Current current)`
`RBool`	`getActive(Ice.Current current)`
`protected java.util.List`	`getAnnotationLinks(Ice.Current current)`
`java.util.Map<java.lang.Long,java.lang.Long>`	`getAnnotationLinksCountPerOwner(Ice.Current current)`
`RTime`	`getClosed(Ice.Current current)`
`byte[]`	`getData(Ice.Current current)`
`RString`	`getDefaultEventType(Ice.Current current)`
`Details`	`getDetails(Ice.Current current)`
`protected java.util.List`	`getEvents(Ice.Current current)`
`ExperimenterGroup`	`getGroup(Ice.Current current)`
`RLong`	`getId(Ice.Current current)`
`RLong`	`getItemCount(Ice.Current current)`
`RString`	`getMessage(Ice.Current current)`
`Node`	`getNode(Ice.Current current)`
`Experimenter`	`getOwner(Ice.Current current)`
`RTime`	`getStarted(Ice.Current current)`
`Experimenter`	`getSudoer(Ice.Current current)`
`RLong`	`getTimeToIdle(Ice.Current current)`
`RLong`	`getTimeToLive(Ice.Current current)`
`RString`	`getUserAgent(Ice.Current current)`
`RString`	`getUserIP(Ice.Current current)`
`RString`	`getUuid(Ice.Current current)`
`RInt`	`getVersion(Ice.Current current)`
`boolean`	`isAnnotated(Ice.Current current)` Allows for the attachment of any omero.model.Annotation subclasses.
`boolean`	`isAnnotationLinksLoaded()`
`boolean`	`isEventsLoaded()`
`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`	`isMutable(Ice.Current current)` The server will persist changes made to these types.
`java.util.Iterator`	`iterateAnnotationLinks()`
`java.util.Iterator`	`iterateEvents()`
`SessionAnnotationLink`	`linkAnnotation(Annotation addition, Ice.Current current)`
`java.util.List<Annotation>`	`linkedAnnotationList(Ice.Current current)`
`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`	`reloadAnnotationLinks(Session toCopy, Ice.Current current)`
`void`	`reloadEvents(Session toCopy, Ice.Current current)`
`void`	`removeAllEventSet(java.util.List<Event> targets, Ice.Current current)`
`void`	`removeAllSessionAnnotationLinkSet(java.util.List<SessionAnnotationLink> targets, Ice.Current current)`
`void`	`removeEvent(Event target, Ice.Current current)`
`void`	`removeSessionAnnotationLink(SessionAnnotationLink target, Ice.Current current)`
`void`	`removeSessionAnnotationLinkFromBoth(SessionAnnotationLink link, boolean bothSides, Ice.Current current)`
`void`	`setActive(RBool active, Ice.Current current)`
`protected void`	`setAnnotationLinks(java.util.List annotationLinks, Ice.Current current)`
`void`	`setClosed(RTime closed, Ice.Current current)`
`void`	`setData(byte[] data, Ice.Current current)`
`void`	`setDefaultEventType(RString defaultEventType, Ice.Current current)`
`protected void`	`setEvents(java.util.List events, Ice.Current current)`
`void`	`setGroup(ExperimenterGroup group, Ice.Current current)`
`void`	`setId(RLong id, Ice.Current current)`
`void`	`setItemCount(RLong itemCount, Ice.Current current)`
`void`	`setMessage(RString message, Ice.Current current)`
`void`	`setNode(Node node, Ice.Current current)`
`void`	`setOwner(Experimenter owner, Ice.Current current)`
`void`	`setStarted(RTime started, Ice.Current current)`
`void`	`setSudoer(Experimenter sudoer, Ice.Current current)`
`void`	`setTimeToIdle(RLong timeToIdle, Ice.Current current)`
`void`	`setTimeToLive(RLong timeToLive, Ice.Current current)`
`void`	`setUserAgent(RString userAgent, Ice.Current current)`
`void`	`setUserIP(RString userIP, Ice.Current current)`
`void`	`setUuid(RString uuid, Ice.Current current)`
`void`	`setVersion(RInt version, 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`	`sizeOfAnnotationLinks(Ice.Current current)`
`int`	`sizeOfEvents(Ice.Current current)`
`protected void`	`throwNullCollectionException(java.lang.String propertyName)`
`protected void`	`toggleCollectionsLoaded(boolean load)`
`void`	`unlinkAnnotation(Annotation removal, Ice.Current current)`
`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`	`unloadActive()`
`void`	`unloadAnnotationLinks(Ice.Current current)`
`void`	`unloadClosed()`
`void`	`unloadCollections(Ice.Current current)` Each collection can also be unloaded, independently of the object itself.
`void`	`unloadData()`
`void`	`unloadDefaultEventType()`
`void`	`unloadDetails(Ice.Current current)` As with collections, the objects under details can link to many other objects.
`void`	`unloadEvents(Ice.Current current)`
`void`	`unloadGroup()`
`void`	`unloadItemCount()`
`void`	`unloadMessage()`
`void`	`unloadNode()`
`void`	`unloadOwner()`
`void`	`unloadStarted()`
`void`	`unloadSudoer()`
`void`	`unloadTimeToIdle()`
`void`	`unloadTimeToLive()`
`void`	`unloadUserAgent()`
`void`	`unloadUserIP()`
`void`	`unloadUuid()`

Methods inherited from class omero.model.Share
___getActive, ___getData, ___getGroup, ___getItemCount, ___setActive, ___setData, ___setGroup, ___setItemCount, __dispatch, __readImpl, __writeImpl, clone, getActive, getData, getGroup, getItemCount, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setActive, setData, setGroup, setItemCount

Methods inherited from class omero.model.Session
___addAllEventSet, ___addAllSessionAnnotationLinkSet, ___addEvent, ___addSessionAnnotationLink, ___addSessionAnnotationLinkToBoth, ___clearAnnotationLinks, ___clearEvents, ___copyAnnotationLinks, ___copyEvents, ___findSessionAnnotationLink, ___getAnnotationLinksCountPerOwner, ___getClosed, ___getDefaultEventType, ___getMessage, ___getNode, ___getOwner, ___getStarted, ___getSudoer, ___getTimeToIdle, ___getTimeToLive, ___getUserAgent, ___getUserIP, ___getUuid, ___getVersion, ___linkAnnotation, ___linkedAnnotationList, ___reloadAnnotationLinks, ___reloadEvents, ___removeAllEventSet, ___removeAllSessionAnnotationLinkSet, ___removeEvent, ___removeSessionAnnotationLink, ___removeSessionAnnotationLinkFromBoth, ___setClosed, ___setDefaultEventType, ___setMessage, ___setNode, ___setOwner, ___setStarted, ___setSudoer, ___setTimeToIdle, ___setTimeToLive, ___setUserAgent, ___setUserIP, ___setUuid, ___setVersion, ___sizeOfAnnotationLinks, ___sizeOfEvents, ___unlinkAnnotation, ___unloadAnnotationLinks, ___unloadEvents, addAllEventSet, addAllSessionAnnotationLinkSet, addEvent, addSessionAnnotationLink, addSessionAnnotationLinkToBoth, clearAnnotationLinks, clearEvents, copyAnnotationLinks, copyEvents, findSessionAnnotationLink, getAnnotationLinksCountPerOwner, getClosed, getDefaultEventType, getMessage, getNode, getOwner, getStarted, getSudoer, getTimeToIdle, getTimeToLive, getUserAgent, getUserIP, getUuid, getVersion, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, reloadEvents, removeAllEventSet, removeAllSessionAnnotationLinkSet, removeEvent, removeSessionAnnotationLink, removeSessionAnnotationLinkFromBoth, setClosed, setDefaultEventType, setMessage, setNode, setOwner, setStarted, setSudoer, setTimeToIdle, setTimeToLive, setUserAgent, setUserIP, setUuid, setVersion, sizeOfAnnotationLinks, sizeOfEvents, unlinkAnnotation, unloadAnnotationLinks, unloadEvents

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._SessionOperationsNC
addAllEventSet, addAllSessionAnnotationLinkSet, addEvent, addSessionAnnotationLink, addSessionAnnotationLinkToBoth, clearAnnotationLinks, clearEvents, copyAnnotationLinks, copyEvents, findSessionAnnotationLink, getAnnotationLinksCountPerOwner, getClosed, getDefaultEventType, getMessage, getNode, getOwner, getStarted, getSudoer, getTimeToIdle, getTimeToLive, getUserAgent, getUserIP, getUuid, getVersion, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, reloadEvents, removeAllEventSet, removeAllSessionAnnotationLinkSet, removeEvent, removeSessionAnnotationLink, removeSessionAnnotationLinkFromBoth, setClosed, setDefaultEventType, setMessage, setNode, setOwner, setStarted, setSudoer, setTimeToIdle, setTimeToLive, setUserAgent, setUserIP, setUuid, setVersion, sizeOfAnnotationLinks, sizeOfEvents, unlinkAnnotation, unloadAnnotationLinks, unloadEvents

Methods inherited from interface omero.model._IObjectOperationsNC
getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Field Detail

GROUP

public static final java.lang.String GROUP

See Also:: Constant Field Values

ITEMCOUNT

public static final java.lang.String ITEMCOUNT

See Also:: Constant Field Values

ACTIVE

public static final java.lang.String ACTIVE

See Also:: Constant Field Values

DATA

public static final java.lang.String DATA

See Also:: Constant Field Values

NODE

public static final java.lang.String NODE

See Also:: Constant Field Values

UUID

public static final java.lang.String UUID

See Also:: Constant Field Values

OWNER

public static final java.lang.String OWNER

See Also:: Constant Field Values

SUDOER

public static final java.lang.String SUDOER

See Also:: Constant Field Values

TIMETOIDLE

public static final java.lang.String TIMETOIDLE

See Also:: Constant Field Values

TIMETOLIVE

public static final java.lang.String TIMETOLIVE

See Also:: Constant Field Values

STARTED

public static final java.lang.String STARTED

See Also:: Constant Field Values

CLOSED

public static final java.lang.String CLOSED

See Also:: Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE

See Also:: Constant Field Values

DEFAULTEVENTTYPE

public static final java.lang.String DEFAULTEVENTTYPE

See Also:: Constant Field Values

USERAGENT

public static final java.lang.String USERAGENT

See Also:: Constant Field Values

USERIP

public static final java.lang.String USERIP

See Also:: Constant Field Values

EVENTS

public static final java.lang.String EVENTS

See Also:: Constant Field Values

ANNOTATIONLINKS

public static final java.lang.String ANNOTATIONLINKS

See Also:: Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:: Constant Field Values

Constructor Detail

ShareI
```
public ShareI()
```

ShareI

public ShareI(long id,
              boolean loaded)

ShareI

public ShareI(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.

getVersion
```
public RInt getVersion(Ice.Current current)
```
Specified by:

getVersion in interface _SessionOperations

setVersion

public void setVersion(RInt version,
                       Ice.Current current)

Specified by:: setVersion in interface _SessionOperations

unloadGroup
```
public void unloadGroup()
```

getGroup

public ExperimenterGroup getGroup(Ice.Current current)
                           throws UnloadedEntityException

Specified by:: getGroup in interface _ShareOperations
Throws:: UnloadedEntityException

setGroup

public void setGroup(ExperimenterGroup group,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:: setGroup in interface _ShareOperations
Throws:: UnloadedEntityException

unloadItemCount
```
public void unloadItemCount()
```

getItemCount

public RLong getItemCount(Ice.Current current)
                   throws UnloadedEntityException

Specified by:: getItemCount in interface _ShareOperations
Throws:: UnloadedEntityException

setItemCount

public void setItemCount(RLong itemCount,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:: setItemCount in interface _ShareOperations
Throws:: UnloadedEntityException

unloadActive
```
public void unloadActive()
```

getActive

public RBool getActive(Ice.Current current)
                throws UnloadedEntityException

Specified by:: getActive in interface _ShareOperations
Throws:: UnloadedEntityException

setActive

public void setActive(RBool active,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:: setActive in interface _ShareOperations
Throws:: UnloadedEntityException

unloadData
```
public void unloadData()
```

getData

public byte[] getData(Ice.Current current)
               throws UnloadedEntityException

Specified by:: getData in interface _ShareOperations
Throws:: UnloadedEntityException

setData

public void setData(byte[] data,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:: setData in interface _ShareOperations
Throws:: UnloadedEntityException

unloadNode
```
public void unloadNode()
```

getNode

public Node getNode(Ice.Current current)
             throws UnloadedEntityException

Specified by:: getNode in interface _SessionOperations
Throws:: UnloadedEntityException

setNode

public void setNode(Node node,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:: setNode in interface _SessionOperations
Throws:: UnloadedEntityException

unloadUuid
```
public void unloadUuid()
```

getUuid

public RString getUuid(Ice.Current current)
                throws UnloadedEntityException

Specified by:: getUuid in interface _SessionOperations
Throws:: UnloadedEntityException

setUuid

public void setUuid(RString uuid,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:: setUuid in interface _SessionOperations
Throws:: UnloadedEntityException

unloadOwner
```
public void unloadOwner()
```

getOwner

public Experimenter getOwner(Ice.Current current)
                      throws UnloadedEntityException

Specified by:: getOwner in interface _SessionOperations
Throws:: UnloadedEntityException

setOwner

public void setOwner(Experimenter owner,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:: setOwner in interface _SessionOperations
Throws:: UnloadedEntityException

unloadSudoer
```
public void unloadSudoer()
```

getSudoer

public Experimenter getSudoer(Ice.Current current)
                       throws UnloadedEntityException

Specified by:: getSudoer in interface _SessionOperations
Throws:: UnloadedEntityException

setSudoer

public void setSudoer(Experimenter sudoer,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:: setSudoer in interface _SessionOperations
Throws:: UnloadedEntityException

unloadTimeToIdle
```
public void unloadTimeToIdle()
```

getTimeToIdle

public RLong getTimeToIdle(Ice.Current current)
                    throws UnloadedEntityException

Specified by:: getTimeToIdle in interface _SessionOperations
Throws:: UnloadedEntityException

setTimeToIdle

public void setTimeToIdle(RLong timeToIdle,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:: setTimeToIdle in interface _SessionOperations
Throws:: UnloadedEntityException

unloadTimeToLive
```
public void unloadTimeToLive()
```

getTimeToLive

public RLong getTimeToLive(Ice.Current current)
                    throws UnloadedEntityException

Specified by:: getTimeToLive in interface _SessionOperations
Throws:: UnloadedEntityException

setTimeToLive

public void setTimeToLive(RLong timeToLive,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:: setTimeToLive in interface _SessionOperations
Throws:: UnloadedEntityException

unloadStarted
```
public void unloadStarted()
```

getStarted

public RTime getStarted(Ice.Current current)
                 throws UnloadedEntityException

Specified by:: getStarted in interface _SessionOperations
Throws:: UnloadedEntityException

setStarted

public void setStarted(RTime started,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:: setStarted in interface _SessionOperations
Throws:: UnloadedEntityException

unloadClosed
```
public void unloadClosed()
```

getClosed

public RTime getClosed(Ice.Current current)
                throws UnloadedEntityException

Specified by:: getClosed in interface _SessionOperations
Throws:: UnloadedEntityException

setClosed

public void setClosed(RTime closed,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:: setClosed in interface _SessionOperations
Throws:: UnloadedEntityException

unloadMessage
```
public void unloadMessage()
```

getMessage

public RString getMessage(Ice.Current current)
                   throws UnloadedEntityException

Specified by:: getMessage in interface _SessionOperations
Throws:: UnloadedEntityException

setMessage

public void setMessage(RString message,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:: setMessage in interface _SessionOperations
Throws:: UnloadedEntityException

unloadDefaultEventType
```
public void unloadDefaultEventType()
```

getDefaultEventType

public RString getDefaultEventType(Ice.Current current)
                            throws UnloadedEntityException

Specified by:: getDefaultEventType in interface _SessionOperations
Throws:: UnloadedEntityException

setDefaultEventType

public void setDefaultEventType(RString defaultEventType,
                                Ice.Current current)
                         throws UnloadedEntityException

Specified by:: setDefaultEventType in interface _SessionOperations
Throws:: UnloadedEntityException

unloadUserAgent
```
public void unloadUserAgent()
```

getUserAgent

public RString getUserAgent(Ice.Current current)
                     throws UnloadedEntityException

Specified by:: getUserAgent in interface _SessionOperations
Throws:: UnloadedEntityException

setUserAgent

public void setUserAgent(RString userAgent,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:: setUserAgent in interface _SessionOperations
Throws:: UnloadedEntityException

unloadUserIP
```
public void unloadUserIP()
```

getUserIP

public RString getUserIP(Ice.Current current)
                  throws UnloadedEntityException

Specified by:: getUserIP in interface _SessionOperations
Throws:: UnloadedEntityException

setUserIP

public void setUserIP(RString userIP,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:: setUserIP in interface _SessionOperations
Throws:: UnloadedEntityException

unloadEvents
```
public void unloadEvents(Ice.Current current)
```
Specified by:

unloadEvents in interface _SessionOperations

getEvents

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

Throws:: UnloadedEntityException

setEvents

protected void setEvents(java.util.List events,
                         Ice.Current current)
                  throws UnloadedEntityException

Throws:: UnloadedEntityException

isEventsLoaded
```
public boolean isEventsLoaded()
```

sizeOfEvents
```
public int sizeOfEvents(Ice.Current current)
                 throws UnloadedEntityException
```
Specified by:

sizeOfEvents in interface _SessionOperations

Throws:

UnloadedEntityException

copyEvents

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

Specified by:: copyEvents in interface _SessionOperations
Throws:: UnloadedEntityException

iterateEvents

public java.util.Iterator iterateEvents()
                                 throws UnloadedEntityException

Throws:: UnloadedEntityException

addEvent

public void addEvent(Event target,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:: addEvent in interface _SessionOperations
Throws:: UnloadedEntityException

addAllEventSet

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

Specified by:: addAllEventSet in interface _SessionOperations
Throws:: UnloadedEntityException

removeEvent

public void removeEvent(Event target,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:: removeEvent in interface _SessionOperations
Throws:: UnloadedEntityException

removeAllEventSet

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

Specified by:: removeAllEventSet in interface _SessionOperations
Throws:: UnloadedEntityException

clearEvents

public void clearEvents(Ice.Current current)
                 throws UnloadedEntityException

Specified by:: clearEvents in interface _SessionOperations
Throws:: UnloadedEntityException

reloadEvents

public void reloadEvents(Session toCopy,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:: reloadEvents in interface _SessionOperations
Throws:: UnloadedEntityException

unloadAnnotationLinks
```
public void unloadAnnotationLinks(Ice.Current current)
```
Specified by:

unloadAnnotationLinks in interface _SessionOperations

getAnnotationLinks

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

Throws:: UnloadedEntityException

setAnnotationLinks

protected void setAnnotationLinks(java.util.List annotationLinks,
                                  Ice.Current current)
                           throws UnloadedEntityException

Throws:: UnloadedEntityException

isAnnotationLinksLoaded

public boolean isAnnotationLinksLoaded()

sizeOfAnnotationLinks
```
public int sizeOfAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException
```
Specified by:

sizeOfAnnotationLinks in interface _SessionOperations

Throws:

UnloadedEntityException

copyAnnotationLinks

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

Specified by:: copyAnnotationLinks in interface _SessionOperations
Throws:: UnloadedEntityException

iterateAnnotationLinks

public java.util.Iterator iterateAnnotationLinks()
                                          throws UnloadedEntityException

Throws:: UnloadedEntityException

addSessionAnnotationLink

public void addSessionAnnotationLink(SessionAnnotationLink target,
                                     Ice.Current current)
                              throws UnloadedEntityException

Specified by:: addSessionAnnotationLink in interface _SessionOperations
Throws:: UnloadedEntityException

addAllSessionAnnotationLinkSet

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

Specified by:: addAllSessionAnnotationLinkSet in interface _SessionOperations
Throws:: UnloadedEntityException

removeSessionAnnotationLink

public void removeSessionAnnotationLink(SessionAnnotationLink target,
                                        Ice.Current current)
                                 throws UnloadedEntityException

Specified by:: removeSessionAnnotationLink in interface _SessionOperations
Throws:: UnloadedEntityException

removeAllSessionAnnotationLinkSet

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

Specified by:: removeAllSessionAnnotationLinkSet in interface _SessionOperations
Throws:: UnloadedEntityException

clearAnnotationLinks

public void clearAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:: clearAnnotationLinks in interface _SessionOperations
Throws:: UnloadedEntityException

reloadAnnotationLinks

public void reloadAnnotationLinks(Session toCopy,
                                  Ice.Current current)
                           throws UnloadedEntityException

Specified by:: reloadAnnotationLinks in interface _SessionOperations
Throws:: UnloadedEntityException

getAnnotationLinksCountPerOwner

public java.util.Map<java.lang.Long,java.lang.Long> getAnnotationLinksCountPerOwner(Ice.Current current)

Specified by:: getAnnotationLinksCountPerOwner in interface _SessionOperations

linkAnnotation

public SessionAnnotationLink linkAnnotation(Annotation addition,
                                            Ice.Current current)
                                     throws UnloadedEntityException

Specified by:: linkAnnotation in interface _SessionOperations
Throws:: UnloadedEntityException

addSessionAnnotationLinkToBoth

public void addSessionAnnotationLinkToBoth(SessionAnnotationLink link,
                                           boolean bothSides,
                                           Ice.Current current)
                                    throws UnloadedEntityException

Specified by:: addSessionAnnotationLinkToBoth in interface _SessionOperations
Throws:: UnloadedEntityException

findSessionAnnotationLink

public java.util.List<SessionAnnotationLink> findSessionAnnotationLink(Annotation removal,
                                                                       Ice.Current current)
                                                                throws UnloadedEntityException

Specified by:: findSessionAnnotationLink in interface _SessionOperations
Throws:: UnloadedEntityException

unlinkAnnotation

public void unlinkAnnotation(Annotation removal,
                             Ice.Current current)
                      throws UnloadedEntityException

Specified by:: unlinkAnnotation in interface _SessionOperations
Throws:: UnloadedEntityException

removeSessionAnnotationLinkFromBoth

public void removeSessionAnnotationLinkFromBoth(SessionAnnotationLink link,
                                                boolean bothSides,
                                                Ice.Current current)
                                         throws UnloadedEntityException,
                                                UnloadedCollectionException

Specified by:: removeSessionAnnotationLinkFromBoth in interface _SessionOperations
Throws:: UnloadedEntityException; UnloadedCollectionException

linkedAnnotationList

public java.util.List<Annotation> linkedAnnotationList(Ice.Current current)
                                                throws UnloadedEntityException

Specified by:: linkedAnnotationList in interface _SessionOperations
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<ShareI> cast(java.util.List list)
```
Casts (without warning) the given list to a list of the current type.

Throws:

java.lang.ClassCastException

Class ShareI

Field Summary

Fields inherited from class omero.model.Share

Fields inherited from class omero.model.Session

Fields inherited from class omero.model.IObject

Fields inherited from interface Ice.Object

Constructor Summary

Method Summary

Methods inherited from class omero.model.Share

Methods inherited from class omero.model.Session

Methods inherited from class omero.model.IObject

Methods inherited from class Ice.ObjectImpl

Methods inherited from class java.lang.Object

Methods inherited from interface omero.model._SessionOperationsNC

Methods inherited from interface omero.model._IObjectOperationsNC

Field Detail

GROUP

ITEMCOUNT

ACTIVE

DATA

NODE

UUID

OWNER

SUDOER

TIMETOIDLE

TIMETOLIVE

STARTED

CLOSED

MESSAGE

DEFAULTEVENTTYPE

USERAGENT

USERIP

EVENTS

ANNOTATIONLINKS

DETAILS

Constructor Detail

ShareI

ShareI

ShareI

Method Detail

errorIfUnloaded

throwNullCollectionException

toggleCollectionsLoaded

unload

isLoaded

unloadCollections

isGlobal

isMutable

isAnnotated

isLink

shallowCopy

proxy

getId

setId

getDetails

unloadDetails

getVersion

setVersion

unloadGroup

getGroup

setGroup

unloadItemCount

getItemCount

setItemCount

unloadActive

getActive

setActive

unloadData

getData

setData

unloadNode

getNode

setNode

unloadUuid

getUuid

setUuid

unloadOwner

getOwner

setOwner

unloadSudoer