omero.api

Interface _IShareOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC

All Known Subinterfaces:

IShare

All Known Implementing Classes:

_IShareDisp, _IShareTie

public interface _IShareOperationsNC
extends _ServiceInterfaceOperationsNC

Provides method for sharing - collaboration process for images, datasets, projects.

Method Summary

Modifier and Type	Method and Description
void	activate_async(AMD_IShare_activate __cb, long shareId) Turns on the access control lists attached to the given share for the current session.
void	addComment_async(AMD_IShare_addComment __cb, long shareId, java.lang.String comment) Creates TextAnnotation comment for Session share.
void	addGuest_async(AMD_IShare_addGuest __cb, long shareId, java.lang.String emailAddress) Adds guest email address to the share.
void	addGuests_async(AMD_IShare_addGuests __cb, long shareId, java.util.List<java.lang.String> emailAddresses) Adds guest email addresses to the share.
void	addObject_async(AMD_IShare_addObject __cb, long shareId, IObject iobject) Adds new IObject item to Session share.
void	addObjects_async(AMD_IShare_addObjects __cb, long shareId, java.util.List<IObject> iobjects) Adds new IObject items to Session share.
void	addReply_async(AMD_IShare_addReply __cb, long shareId, java.lang.String comment, TextAnnotation replyTo) Creates TextAnnotation comment which replies to an existing comment.
void	addUser_async(AMD_IShare_addUser __cb, long shareId, Experimenter exp) Adds Experimenter experimenter to Session share.
void	addUsers_async(AMD_IShare_addUsers __cb, long shareId, java.util.List<Experimenter> exps) Adds Experimenter experimenters to Session share.
void	closeShare_async(AMD_IShare_closeShare __cb, long shareId) Closes Session share.
void	createShare_async(AMD_IShare_createShare __cb, java.lang.String description, RTime expiration, java.util.List<IObject> items, java.util.List<Experimenter> exps, java.util.List<java.lang.String> guests, boolean enabled) Creates Session share with all related: IObject itmes, Experimenter members, and guests.
void	deactivate_async(AMD_IShare_deactivate __cb) Turns off the access control lists with the current share.
void	deleteComment_async(AMD_IShare_deleteComment __cb, Annotation comment) Deletes Annotation comment from the database.
void	getActiveConnections_async(AMD_IShare_getActiveConnections __cb, long shareId) Gets actual active connections to Session share.
void	getAllGuests_async(AMD_IShare_getAllGuests __cb, long shareId) Get the email addresses for all share guests.
void	getAllMembers_async(AMD_IShare_getAllMembers __cb, long shareId) Get all Experimenter users who are a member of the share.
void	getAllUsers_async(AMD_IShare_getAllUsers __cb, long shareId) Get a single set containing the omero.model.Experimenter.getOmeName login names of the users as well email addresses for guests.
void	getCommentCount_async(AMD_IShare_getCommentCount __cb, java.util.List<java.lang.Long> shareIds) Returns a map from share id to comment count.
void	getComments_async(AMD_IShare_getComments __cb, long shareId) Looks up all Annotation comments which belong to the Session share.
void	getContentMap_async(AMD_IShare_getContentMap __cb, long shareId) Returns the contents of the share keyed by type.
void	getContents_async(AMD_IShare_getContents __cb, long shareId) Looks up all IObject items belong to the Session share.
void	getContentSize_async(AMD_IShare_getContentSize __cb, long shareId) Returns the number of items in the share.
void	getContentSubList_async(AMD_IShare_getContentSubList __cb, long shareId, int start, int finish) Returns a range of items from the share.
void	getEvents_async(AMD_IShare_getEvents __cb, long shareId, Experimenter exp, RTime from, RTime to) Gets events for Session share per Experimenter experimenter for period of time.
void	getMemberCount_async(AMD_IShare_getMemberCount __cb, java.util.List<java.lang.Long> shareIds) Returns a map from share id to the count of total members (including the owner).
void	getMemberShares_async(AMD_IShare_getMemberShares __cb, boolean active) Gets all shares where current Experimenter is a member.
void	getMemberSharesFor_async(AMD_IShare_getMemberSharesFor __cb, Experimenter user, boolean active) Gets all shares where given Experimenter is a member.
void	getOwnShares_async(AMD_IShare_getOwnShares __cb, boolean active) Gets all owned shares for the current Experimenter.
void	getPastConnections_async(AMD_IShare_getPastConnections __cb, long shareId) Gets previous connections to Session share.
void	getShare_async(AMD_IShare_getShare __cb, long shareId) Gets a share as a Session with all related: Annotation comments, Experimenter members, fully loaded.
void	getSharesOwnedBy_async(AMD_IShare_getSharesOwnedBy __cb, Experimenter user, boolean active) Gets all shares owned by the given Experimenter.
void	invalidateConnection_async(AMD_IShare_invalidateConnection __cb, long shareId, Experimenter exp) Makes the connection invalid for Session share for specified user.
void	notifyMembersOfShare_async(AMD_IShare_notifyMembersOfShare __cb, long shareId, java.lang.String subject, java.lang.String message, boolean html) Notifies via email selected members of share.
void	removeGuest_async(AMD_IShare_removeGuest __cb, long shareId, java.lang.String emailAddress) Removes guest email address from share.
void	removeGuests_async(AMD_IShare_removeGuests __cb, long shareId, java.util.List<java.lang.String> emailAddresses) Removes guest email addresses from the share.
void	removeObject_async(AMD_IShare_removeObject __cb, long shareId, IObject iobject) Removes existing IObject object from the Session share.
void	removeObjects_async(AMD_IShare_removeObjects __cb, long shareId, java.util.List<IObject> iobjects) Remove existing items from the share.
void	removeUser_async(AMD_IShare_removeUser __cb, long shareId, Experimenter exp) Removes Experimenter experimenter from Session share.
void	removeUsers_async(AMD_IShare_removeUsers __cb, long shareId, java.util.List<Experimenter> exps) Removes Experimenter experimenters from Session share.
void	setActive_async(AMD_IShare_setActive __cb, long shareId, boolean active)
void	setDescription_async(AMD_IShare_setDescription __cb, long shareId, java.lang.String description)
void	setExpiration_async(AMD_IShare_setExpiration __cb, long shareId, RTime expiration)

Method Detail

activate_async

void activate_async(AMD_IShare_activate __cb,
                    long shareId)
             throws ServerError

Turns on the access control lists attached to the given share for the current session. Warning: this will slow down the execution of the current session for all database reads. Writing to the database will not be allowed. If share does not exist or is not accessible (non-members) or is disabled, then an ValidationException is thrown.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

deactivate_async

void deactivate_async(AMD_IShare_deactivate __cb)
               throws ServerError

Turns off the access control lists with the current share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getShare_async

void getShare_async(AMD_IShare_getShare __cb,
                    long shareId)
             throws ServerError

Gets a share as a Session with all related: Annotation comments, Experimenter members, fully loaded. Unlike the other methods on this interface, if the sessionId is unknown, does not throw a ValidationException.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMemberCount_async

void getMemberCount_async(AMD_IShare_getMemberCount __cb,
                          java.util.List<java.lang.Long> shareIds)
                   throws ServerError

Returns a map from share id to the count of total members (including the owner). This is represented by ShareMember links.

Parameters:

__cb - The callback object for the operation.

shareIds - Not null.

Throws:

ValidationException - if a given share does not exist

ServerError

getOwnShares_async

void getOwnShares_async(AMD_IShare_getOwnShares __cb,
                        boolean active)
                 throws ServerError

Gets all owned shares for the current Experimenter.

Parameters:

__cb - The callback object for the operation.

active - if true, then only shares which can be used for login will be returned. All draft shares (see createShare) and closed shares (see closeShare) will be filtered.

Throws:

ServerError

getMemberShares_async

void getMemberShares_async(AMD_IShare_getMemberShares __cb,
                           boolean active)
                    throws ServerError

Gets all shares where current Experimenter is a member.

Parameters:

__cb - The callback object for the operation.

active - if true, then only shares which can be used for login will be returned. All draft shares (see createShare) and closed shares (see closeShare) will be filtered.

Throws:

ServerError

getSharesOwnedBy_async

void getSharesOwnedBy_async(AMD_IShare_getSharesOwnedBy __cb,
                            Experimenter user,
                            boolean active)
                     throws ServerError

Gets all shares owned by the given Experimenter.

Parameters:

__cb - The callback object for the operation.

user - the experimenter

active - if true, then only shares which can be used for login will be returned. All draft shares (see createShare) and closed shares (see closeShare) will be filtered.

Throws:

ServerError

getMemberSharesFor_async

void getMemberSharesFor_async(AMD_IShare_getMemberSharesFor __cb,
                              Experimenter user,
                              boolean active)
                       throws ServerError

Gets all shares where given Experimenter is a member.

Parameters:

__cb - The callback object for the operation.

user - the experimenter

active - if true, then only shares which can be used for login will be returned. All draft shares (see createShare) and closed shares (see closeShare) will be filtered.

Throws:

ServerError

getContents_async

void getContents_async(AMD_IShare_getContents __cb,
                       long shareId)
                throws ServerError

Looks up all IObject items belong to the Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getContentSubList_async

void getContentSubList_async(AMD_IShare_getContentSubList __cb,
                             long shareId,
                             int start,
                             int finish)
                      throws ServerError

Returns a range of items from the share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getContentSize_async

void getContentSize_async(AMD_IShare_getContentSize __cb,
                          long shareId)
                   throws ServerError

Returns the number of items in the share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getContentMap_async

void getContentMap_async(AMD_IShare_getContentMap __cb,
                         long shareId)
                  throws ServerError

Returns the contents of the share keyed by type.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

createShare_async

void createShare_async(AMD_IShare_createShare __cb,
                       java.lang.String description,
                       RTime expiration,
                       java.util.List<IObject> items,
                       java.util.List<Experimenter> exps,
                       java.util.List<java.lang.String> guests,
                       boolean enabled)
                throws ServerError

Creates Session share with all related: IObject itmes, Experimenter members, and guests.

Parameters:

__cb - The callback object for the operation.

enabled - if true, then the share is immediately available for use. If false, then the share is in draft state. All methods on this interface will work for shares except activate. Similarly, the share password cannot be used by guests to login.

Throws:

ServerError

setDescription_async

void setDescription_async(AMD_IShare_setDescription __cb,
                          long shareId,
                          java.lang.String description)
                   throws ServerError

Throws:

ServerError

setExpiration_async

void setExpiration_async(AMD_IShare_setExpiration __cb,
                         long shareId,
                         RTime expiration)
                  throws ServerError

Throws:

ServerError

setActive_async

void setActive_async(AMD_IShare_setActive __cb,
                     long shareId,
                     boolean active)
              throws ServerError

Throws:

ServerError

closeShare_async

void closeShare_async(AMD_IShare_closeShare __cb,
                      long shareId)
               throws ServerError

Closes Session share. No further logins will be possible and all getters (e.g. getMemberShares, getOwnShares, ...) will filter these results if onlyActive is true.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

addObjects_async

void addObjects_async(AMD_IShare_addObjects __cb,
                      long shareId,
                      java.util.List<IObject> iobjects)
               throws ServerError

Adds new IObject items to Session share. Conceptually calls addObjects for every argument passed, but the graphs will be merged.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

addObject_async

void addObject_async(AMD_IShare_addObject __cb,
                     long shareId,
                     IObject iobject)
              throws ServerError

Adds new IObject item to Session share. The entire object graph with the exception of all Details will be loaded into the share. If you would like to load a single object, then pass an unloaded reference.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

removeObjects_async

void removeObjects_async(AMD_IShare_removeObjects __cb,
                         long shareId,
                         java.util.List<IObject> iobjects)
                  throws ServerError

Remove existing items from the share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

removeObject_async

void removeObject_async(AMD_IShare_removeObject __cb,
                        long shareId,
                        IObject iobject)
                 throws ServerError

Removes existing IObject object from the Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getCommentCount_async

void getCommentCount_async(AMD_IShare_getCommentCount __cb,
                           java.util.List<java.lang.Long> shareIds)
                    throws ServerError

Returns a map from share id to comment count.

Parameters:

__cb - The callback object for the operation.

shareIds - Not null.

Throws:

ValidationException - if a given share does not exist

ServerError

getComments_async

void getComments_async(AMD_IShare_getComments __cb,
                       long shareId)
                throws ServerError

Looks up all Annotation comments which belong to the Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

addComment_async

void addComment_async(AMD_IShare_addComment __cb,
                      long shareId,
                      java.lang.String comment)
               throws ServerError

Creates TextAnnotation comment for Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

addReply_async

void addReply_async(AMD_IShare_addReply __cb,
                    long shareId,
                    java.lang.String comment,
                    TextAnnotation replyTo)
             throws ServerError

Creates TextAnnotation comment which replies to an existing comment.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

deleteComment_async

void deleteComment_async(AMD_IShare_deleteComment __cb,
                         Annotation comment)
                  throws ServerError

Deletes Annotation comment from the database.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getAllMembers_async

void getAllMembers_async(AMD_IShare_getAllMembers __cb,
                         long shareId)
                  throws ServerError

Get all Experimenter users who are a member of the share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getAllGuests_async

void getAllGuests_async(AMD_IShare_getAllGuests __cb,
                        long shareId)
                 throws ServerError

Get the email addresses for all share guests.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getAllUsers_async

void getAllUsers_async(AMD_IShare_getAllUsers __cb,
                       long shareId)
                throws ServerError,
                       ValidationException

Get a single set containing the omero.model.Experimenter.getOmeName login names of the users as well email addresses for guests.

Parameters:

__cb - The callback object for the operation.

shareId -

Throws:

ValidationException - if there is a conflict between email addresses and user names.

ServerError

addUsers_async

void addUsers_async(AMD_IShare_addUsers __cb,
                    long shareId,
                    java.util.List<Experimenter> exps)
             throws ServerError

Adds Experimenter experimenters to Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

addGuests_async

void addGuests_async(AMD_IShare_addGuests __cb,
                     long shareId,
                     java.util.List<java.lang.String> emailAddresses)
              throws ServerError

Adds guest email addresses to the share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

removeUsers_async

void removeUsers_async(AMD_IShare_removeUsers __cb,
                       long shareId,
                       java.util.List<Experimenter> exps)
                throws ServerError

Removes Experimenter experimenters from Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

removeGuests_async

void removeGuests_async(AMD_IShare_removeGuests __cb,
                        long shareId,
                        java.util.List<java.lang.String> emailAddresses)
                 throws ServerError

Removes guest email addresses from the share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

addUser_async

void addUser_async(AMD_IShare_addUser __cb,
                   long shareId,
                   Experimenter exp)
            throws ServerError

Adds Experimenter experimenter to Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

addGuest_async

void addGuest_async(AMD_IShare_addGuest __cb,
                    long shareId,
                    java.lang.String emailAddress)
             throws ServerError

Adds guest email address to the share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

removeUser_async

void removeUser_async(AMD_IShare_removeUser __cb,
                      long shareId,
                      Experimenter exp)
               throws ServerError

Removes Experimenter experimenter from Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

removeGuest_async

void removeGuest_async(AMD_IShare_removeGuest __cb,
                       long shareId,
                       java.lang.String emailAddress)
                throws ServerError

Removes guest email address from share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getActiveConnections_async

void getActiveConnections_async(AMD_IShare_getActiveConnections __cb,
                                long shareId)
                         throws ServerError

Gets actual active connections to Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getPastConnections_async

void getPastConnections_async(AMD_IShare_getPastConnections __cb,
                              long shareId)
                       throws ServerError

Gets previous connections to Session share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

invalidateConnection_async

void invalidateConnection_async(AMD_IShare_invalidateConnection __cb,
                                long shareId,
                                Experimenter exp)
                         throws ServerError

Makes the connection invalid for Session share for specified user.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getEvents_async

void getEvents_async(AMD_IShare_getEvents __cb,
                     long shareId,
                     Experimenter exp,
                     RTime from,
                     RTime to)
              throws ServerError

Gets events for Session share per Experimenter experimenter for period of time.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

notifyMembersOfShare_async

void notifyMembersOfShare_async(AMD_IShare_notifyMembersOfShare __cb,
                                long shareId,
                                java.lang.String subject,
                                java.lang.String message,
                                boolean html)
                         throws ServerError

Notifies via email selected members of share.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError