Package omero.api

Interface _IShareOperations

    • Method Detail

      • activate_async

        void activate_async​(AMD_IShare_activate __cb,
                    long shareId,
                    Ice.Current __current)
             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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • deactivate_async

        void deactivate_async​(AMD_IShare_deactivate __cb,
                      Ice.Current __current)
               throws ServerError
        Turns off the access control lists with the current share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getShare_async

        void getShare_async​(AMD_IShare_getShare __cb,
                    long shareId,
                    Ice.Current __current)
             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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getMemberCount_async

        void getMemberCount_async​(AMD_IShare_getMemberCount __cb,
                          java.util.List<java.lang.Long> shareIds,
                          Ice.Current __current)
                   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.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if a given share does not exist
        ServerError

      • getOwnShares_async

        void getOwnShares_async​(AMD_IShare_getOwnShares __cb,
                        boolean active,
                        Ice.Current __current)
                 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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getMemberShares_async

        void getMemberShares_async​(AMD_IShare_getMemberShares __cb,
                           boolean active,
                           Ice.Current __current)
                    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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getSharesOwnedBy_async

        void getSharesOwnedBy_async​(AMD_IShare_getSharesOwnedBy __cb,
                            Experimenter user,
                            boolean active,
                            Ice.Current __current)
                     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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getMemberSharesFor_async

        void getMemberSharesFor_async​(AMD_IShare_getMemberSharesFor __cb,
                              Experimenter user,
                              boolean active,
                              Ice.Current __current)
                       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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getContents_async

        void getContents_async​(AMD_IShare_getContents __cb,
                       long shareId,
                       Ice.Current __current)
                throws ServerError
        Looks up all IObject items belong to the Session share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getContentSubList_async

        void getContentSubList_async​(AMD_IShare_getContentSubList __cb,
                             long shareId,
                             int start,
                             int finish,
                             Ice.Current __current)
                      throws ServerError
        Returns a range of items from the share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getContentSize_async

        void getContentSize_async​(AMD_IShare_getContentSize __cb,
                          long shareId,
                          Ice.Current __current)
                   throws ServerError
        Returns the number of items in the share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getContentMap_async

        void getContentMap_async​(AMD_IShare_getContentMap __cb,
                         long shareId,
                         Ice.Current __current)
                  throws ServerError
        Returns the contents of the share keyed by type.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        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,
                       Ice.Current __current)
                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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • closeShare_async

        void closeShare_async​(AMD_IShare_closeShare __cb,
                      long shareId,
                      Ice.Current __current)
               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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • addObjects_async

        void addObjects_async​(AMD_IShare_addObjects __cb,
                      long shareId,
                      java.util.List<IObject> iobjects,
                      Ice.Current __current)
               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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • addObject_async

        void addObject_async​(AMD_IShare_addObject __cb,
                     long shareId,
                     IObject iobject,
                     Ice.Current __current)
              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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • removeObjects_async

        void removeObjects_async​(AMD_IShare_removeObjects __cb,
                         long shareId,
                         java.util.List<IObject> iobjects,
                         Ice.Current __current)
                  throws ServerError
        Remove existing items from the share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • removeObject_async

        void removeObject_async​(AMD_IShare_removeObject __cb,
                        long shareId,
                        IObject iobject,
                        Ice.Current __current)
                 throws ServerError
        Removes existing IObject object from the Session share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getCommentCount_async

        void getCommentCount_async​(AMD_IShare_getCommentCount __cb,
                           java.util.List<java.lang.Long> shareIds,
                           Ice.Current __current)
                    throws ServerError
        Returns a map from share id to comment count.
        Parameters:
        __cb - The callback object for the operation.
        shareIds - Not null.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if a given share does not exist
        ServerError

      • getComments_async

        void getComments_async​(AMD_IShare_getComments __cb,
                       long shareId,
                       Ice.Current __current)
                throws ServerError
        Looks up all Annotation comments which belong to the Session share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • addComment_async

        void addComment_async​(AMD_IShare_addComment __cb,
                      long shareId,
                      java.lang.String comment,
                      Ice.Current __current)
               throws ServerError
        Creates TextAnnotation comment for Session share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • addReply_async

        void addReply_async​(AMD_IShare_addReply __cb,
                    long shareId,
                    java.lang.String comment,
                    TextAnnotation replyTo,
                    Ice.Current __current)
             throws ServerError
        Creates TextAnnotation comment which replies to an existing comment.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getAllMembers_async

        void getAllMembers_async​(AMD_IShare_getAllMembers __cb,
                         long shareId,
                         Ice.Current __current)
                  throws ServerError
        Get all Experimenter users who are a member of the share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getAllGuests_async

        void getAllGuests_async​(AMD_IShare_getAllGuests __cb,
                        long shareId,
                        Ice.Current __current)
                 throws ServerError
        Get the email addresses for all share guests.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getAllUsers_async

        void getAllUsers_async​(AMD_IShare_getAllUsers __cb,
                       long shareId,
                       Ice.Current __current)
                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 -
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if there is a conflict between email addresses and user names.
        ServerError

      • addGuests_async

        void addGuests_async​(AMD_IShare_addGuests __cb,
                     long shareId,
                     java.util.List<java.lang.String> emailAddresses,
                     Ice.Current __current)
              throws ServerError
        Adds guest email addresses to the share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • removeGuests_async

        void removeGuests_async​(AMD_IShare_removeGuests __cb,
                        long shareId,
                        java.util.List<java.lang.String> emailAddresses,
                        Ice.Current __current)
                 throws ServerError
        Removes guest email addresses from the share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • addGuest_async

        void addGuest_async​(AMD_IShare_addGuest __cb,
                    long shareId,
                    java.lang.String emailAddress,
                    Ice.Current __current)
             throws ServerError
        Adds guest email address to the share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • removeGuest_async

        void removeGuest_async​(AMD_IShare_removeGuest __cb,
                       long shareId,
                       java.lang.String emailAddress,
                       Ice.Current __current)
                throws ServerError
        Removes guest email address from share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getActiveConnections_async

        void getActiveConnections_async​(AMD_IShare_getActiveConnections __cb,
                                long shareId,
                                Ice.Current __current)
                         throws ServerError
        Gets actual active connections to Session share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getPastConnections_async

        void getPastConnections_async​(AMD_IShare_getPastConnections __cb,
                              long shareId,
                              Ice.Current __current)
                       throws ServerError
        Gets previous connections to Session share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • invalidateConnection_async

        void invalidateConnection_async​(AMD_IShare_invalidateConnection __cb,
                                long shareId,
                                Experimenter exp,
                                Ice.Current __current)
                         throws ServerError
        Makes the connection invalid for Session share for specified user.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • notifyMembersOfShare_async

        void notifyMembersOfShare_async​(AMD_IShare_notifyMembersOfShare __cb,
                                long shareId,
                                java.lang.String subject,
                                java.lang.String message,
                                boolean html,
                                Ice.Current __current)
                         throws ServerError
        Notifies via email selected members of share.
        Parameters:
        __cb - The callback object for the operation.
        __current - The Current object for the invocation.
        Throws:
        ServerError