Package de.elo.ix.client.feed

Interface FeedService

All Superinterfaces:
byps.BRemote, byps.Remote, de.elo.utils.net.Remote, java.rmi.Remote
public interface FeedService
extends byps.BRemote
This interface provides functions to access document feeds.
Since:
9.00.000.003

  • Method Details

    • findFirstActions

      FindResult findFirstActions​(ClientInfo ci, FindActionsInfo findInfo, int max, ActionZ actionZ) throws byps.RemoteException
      Find actions of document feeds.

      In order to receive all actions for a document feed, call this function with FindActionsInfo.objId set to a Sord ID, GUID, etc. The results are returned in FindResult.getActions(). The Feed object associated to the Sord is returned in FindResult.getFeeds().

      Call IXServicePortIF.findClose to release internal resources when finished.

      Parameters:
      ci - ClientInfo object with session information.
      findInfo - Describes the search criteria.
      max - Maximum number of actions that should be returned by this call. This number might be passed over because the function always returns also all subordinated actions of the selected actions.
      actionZ - Element selector, defines the Action members to be returned.
      Returns:
      FindResult object, FindResult#actions contains the results.
      Throws:
      byps.RemoteException

    • findNextActions

      FindResult findNextActions​(ClientInfo ci, java.lang.String searchId, int idx, int max, ActionZ actionZ) throws byps.RemoteException
      Continue reading results from a search started with findFirstActions.
      Parameters:
      ci - ClientInfo object with session information.
      searchId - Search ID returned in FindResult.getSearchId() by a previous call to findFirstActions(ClientInfo, FindActionsInfo, int, ActionZ).
      idx - Start index to read from.
      max - Maximum number of actions that should be returned by this call, see findFirstActions(ClientInfo, FindActionsInfo, int, ActionZ).
      actionZ - Element selector, defines the Action members to be returned.
      Returns:
      FindResult object, FindResult#actions contains the results.
      Throws:
      byps.RemoteException

    • createAction

      Action createAction​(ClientInfo ci, EActionType type, java.lang.String parentGuid) throws byps.RemoteException
      Initialize a document feed item object. This function does not store the created action in the database. Use checkinAction(ClientInfo, Action, ActionZ) to make an Action object persistent. The returned object allows read access for everyone.
      Parameters:
      ci - ClientInfo object with session information.
      type - Action type, must be EActionType.UserComment or EActionType.AutoComment.
      parentGuid - GUID of an existing action, document feed or Sord object.
      Returns:
      Action object
      Throws:
      byps.RemoteException
      Since:
      9.00.000.034

    • checkinAction

      java.lang.String checkinAction​(ClientInfo ci, Action action, ActionZ actionZ) throws byps.RemoteException
      Create or update a document feed entry.
      Parameters:
      ci - ClientInfo object with session information.
      action - Action object, Action.type must be EActionType.UserComment or EActionType.AutoComment.
      actionZ - Members to be written.
      Returns:
      GUID of the Action object.
      Throws:
      byps.RemoteException

    • checkoutAction

      Action checkoutAction​(ClientInfo ci, java.lang.String actionGuid, ActionZ actionZ) throws byps.RemoteException
      Read a document feed entry.
      Parameters:
      ci - ClientInfo object with session information.
      actionGuid - Action GUID.
      actionZ - Members to be read.
      Returns:
      Action object.
      Throws:
      byps.RemoteException

    • registerNotify

      void registerNotify​(ClientInfo ci, java.lang.String feedGuid, FeedNotification notify) throws byps.RemoteException
      Register a callback interface. The server calls functions of this interface if the document feed is modified.
      Parameters:
      ci - ClientInfo object with session information.
      feedGuid - Document feed GUID.
      notify - Callback interface implementation.
      Throws:
      byps.RemoteException

    • unregisterNotify

      void unregisterNotify​(ClientInfo ci, java.lang.String feedGuid) throws byps.RemoteException
      Unregister a callback interface. Remove callback interface from internal list.
      Parameters:
      ci - ClientInfo object with session information.
      feedGuid - Document feed GUID.
      Throws:
      byps.RemoteException

    • internalInsertSystemAction

      Action internalInsertSystemAction​(ClientInfo ci, Action action) throws byps.RemoteException
      Reserved.
      Parameters:
      ci - reserved
      action - reserved
      Returns:
      Action object.
      Throws:
      byps.RemoteException
      Since:
      9.00.012.001

    • checkoutHashTag

      HashTag checkoutHashTag​(ClientInfo ci, java.lang.String hashtagGuidOrName, HashTagZ hstgZ) throws byps.RemoteException
      Read a HashTag Object from Database
      Parameters:
      ci - ClientInfo object with session information.
      hashtagGuidOrName - HashTag GUID or Name
      hstgZ - Element selector, defines the members to be returned.
      Returns:
      HashTag Object
      Throws:
      byps.RemoteException
      Since:
      9.00.022.013

    • findFirstHashTagRelation

      FindResult findFirstHashTagRelation​(ClientInfo ci, FindHashTagInfo findInfo, int max, HashTagZ hashTagZ) throws byps.RemoteException
      Parameters:
      ci - ClientInfo object with session information.
      findInfo - - FindHashTagInfo
      max - Maximum number of actions that should be returned by this call.
      hashTagZ - Element selector, defines the members to be returned.
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      9.00.022.013

    • findNextHashTagRelation

      FindResult findNextHashTagRelation​(ClientInfo ci, java.lang.String searchId, int idx, int max, HashTagZ hashTagZ) throws byps.RemoteException
      Parameters:
      ci - ClientInfo object with session information.
      searchId - Search ID returned in FindResult.getSearchId() by a previous call of findFirstHashTagRelation
      idx - Start index to read from.
      max - Maximum number of actions that should be returned by this call.
      hashTagZ - Element selector, defines the members to be returned.
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      9.00.022.013

    • findHashTagByActions

      java.util.HashSet<HashTag> findHashTagByActions​(ClientInfo ci, java.lang.String[] actionGuids, HashTagZ hashTagZ) throws byps.RemoteException
      Returns all HashTags which occurs in a given Array of Actions
      Parameters:
      ci - ClientInfo object with session information.
      actionGuids - String[] guids of Actions
      hashTagZ - Element selector, defines the members to be returned.
      Returns:
      HashSet
      Throws:
      byps.RemoteException
      Since:
      9.00.022.014

    • findHashTags

      java.util.HashMap<java.lang.String,​HashTag> findHashTags​(ClientInfo ci, FindHashTagInfo findInfo) throws byps.RemoteException
      Returns all HashTags. FindHashTagInfo filter the result by, createDateIso, lastUsedIso and minCount
      Parameters:
      ci - ClientInfo object with session information.
      findInfo - - FindHashTagInfo
      Returns:
      HashMap -
      Throws:
      byps.RemoteException
      Since:
      9.00.030.004

    • findFirstNotification

      FindResult findFirstNotification​(ClientInfo ci, FindNotificationInfo findInfo, int max) throws byps.RemoteException
      Parameters:
      ci - ClientInfo object with session information.
      findInfo - - FindNotificationInfo
      max - - int Maximum number of Notifications that should be returned by this call.
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      9.00.030.006

    • findNextNotification

      FindResult findNextNotification​(ClientInfo ci, java.lang.String searchId, int idx, int max) throws byps.RemoteException
      Parameters:
      ci - ClientInfo object with session information
      searchId - Search ID returned in FindResult.getSearchId() by a previous call of findFirstNotificaion
      idx - Start index to read from.
      max - int Maximum number of Notifications that should be returned by this call.
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      9.00.030.008

    • findPostActions

      java.util.List<Action> findPostActions​(ClientInfo ci, java.lang.String actionGuid, ActionZ actionZ) throws byps.RemoteException
      Returns a Feedpost with all comments.
      Parameters:
      ci - ci ClientInfo object with session information
      actionGuid - parent or comment Guid
      actionZ - Element selector, defines the Action members to be returned.
      Returns:
      List
      Throws:
      byps.RemoteException
      Since:
      11.00.000.005

    • createHashTagSubscription

      Subscription createHashTagSubscription​(ClientInfo ci, java.lang.String hashtagGuidOrName, java.lang.String userGuidOrId) throws byps.RemoteException
      Creates a HashTag Subscription
      Parameters:
      ci - ClientInfo object with session information
      hashtagGuidOrName -
      userGuidOrId - or null
      Returns:
      Subscription
      Throws:
      IXException
      byps.RemoteException
      Since:
      9.00.030.011