Package de.uplanet.lucy.server.auxiliaries.share.velocity

Class ShareCallable

  • @VelocityCallable("singleton")
public final class ShareCallable
extends Object

    • Constructor Summary

      Constructors 
      Constructor Description
      ShareCallable()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean addFeedComment​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFeedRecId, String p_strComment, String p_strMediaData, String p_strPluginGuid, String p_strPluginRecId)  
      static boolean canAccessModule​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strTargetPageGuid, String p_strModuleKey)
      Check the module permission and status
      static boolean canAddFile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFolderId, String p_strProfileId)  
      static boolean canRequestReadConfirmation​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strProfileId)  
      boolean canWriteFeeds​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strCurrentProfileId, String p_strVisitedProfileId)
      Returns true if the current profile is allowed to write feeds on the visited profile.
      static int countFeedReads​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFeedId)  
      static int getAddOnVersion​(String p_strAppGuid)
      Get the version of an AddOn application.
      static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.mailsettings.VcAdminSetting> getAdminMailSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)  
      static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.pushnotificationsettings.VcAdminPushNotificationSetting> getAdminPushNotificationSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)  
      de.uplanet.lucy.server.auxiliaries.share.velocity.advertising.VcAdvertisings getAdvertisings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcAdvertisings object, all methods to manipulate and get info about events
      static String getColor​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strType, String p_strDefault)
      Get defined colors
      de.uplanet.lucy.server.auxiliaries.share.velocity.contact.VcContacts getContacts​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcContacts object, all methods to manipulate contacts
      String getControlGuidBySetting​(String p_strPageGuid, String p_strSetting)
      Returns Control-GUID of a datarange, if the given page has a datarange control with name SHARE.IDENTIFIER this setting, otherwise null.
      int getCountFileStoreFiles​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns count of files.
      long getCountOfNewSystemMessagesForCurrentUser​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns count of new system messages for current user.
      de.uplanet.lucy.share.constants.MODE getDataRangeConfigurationModeByName​(String p_strMode)  
      de.uplanet.lucy.server.auxiliaries.share.velocity.event.VcEvents getEvents​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcEvents object, all methods to manipulate and get info about events
      static List<de.uplanet.lucy.server.share.velocity.feed.VcComment> getFeedComments​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFeedId)  
      de.uplanet.lucy.server.auxiliaries.share.velocity.feed.VcFeedInformation getFeedInformation​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)  
      static String getFeedLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strLinkText, String p_strRecId, String p_strTargetSettingKey, String p_strLinkType, String p_strStyleClass, String p_strHijaxTooltipProps, String p_strFeedTableMode)
      Constructs a feed link.
      de.uplanet.lucy.server.share.velocity.feed.VcFeedPermission getFeedPermission​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, de.uplanet.lucy.server.share.velocity.feed.VcFeed p_feed)
      Returns a VcFeedPermission object, containing information about abilities for deleting and editing feeds
      de.uplanet.lucy.server.share.velocity.feed.VcFeedPermission getFeedPermission​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, de.uplanet.lucy.server.share.velocity.feed.VcFeedRow p_feed)
      Returns a VcFeedPermission object, containing information about abilities for deleting and editing feeds
      static String getFeedRecId​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strPluginGuid, String p_strPluginDgGuid, String p_strPluginRecId)  
      de.uplanet.lucy.server.auxiliaries.share.velocity.feed.VcFeeds getFeeds​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns the feed callable object providing methods in the context of feeds.
      String getFeedTableModeByFeedClass​(String p_strFeedClass)  
      String getFileFolderName​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFileRecId)  
      static String getFilter​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strKey, String p_strUserGuid, String p_strDefault)  
      String getFolderName​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFolderRecId)  
      de.uplanet.lucy.server.auxiliaries.share.velocity.group.VcGroups getGroups​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcGroups object, all methods to manipulate and get info about groups
      static String getImageLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strImageStyleClass, de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage, String p_strRecId, String p_strTargetSettingKey, String p_strAlt, boolean p_bTooltip)
      Constructs an image link.
      static String getImageLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strImageStyleClass, de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage, String p_strRecId, String p_strTargetSettingKey, String p_strAlt, boolean p_bTooltip, int p_bWidth, int p_bHeight)
      Constructs an image link.
      static String getImageLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strImageStyleClass, de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage, String p_strRecId, String p_strTargetSettingKey, String p_strAlt, boolean p_bTooltip, int p_iWidth, int p_iHeight, List<String> p_attributes)
      Constructs an image link.
      static String getImageWithoutLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strImageStyleClass, de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage, String p_strRecId, String p_strAlt, int p_bWidth, int p_bHeight)
      Constructs an image link.
      de.uplanet.lucy.server.auxiliaries.share.velocity.interest.VcInterests getInterests​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcInterests object, all methods to manipulate and get info about interests
      de.uplanet.lucy.server.auxiliaries.share.velocity.feed.VcLikes getLikes​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcLikes object, all methods to manipulate and get info about likes
      static String getLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strLinkText, int p_iRecId, String p_strTargetSettingKey, String p_strLinkType, String p_strStyleClass, String p_strHijaxTooltipProps)
      Constructs a link.
      static String getLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strLinkText, String p_strRecId, String p_strTargetSettingKey, String p_strLinkType, String p_strStyleClass, String p_strHijaxTooltipProps)
      Constructs a link.
      de.uplanet.lucy.server.auxiliaries.share.velocity.message.VcMessages getMessages​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns a ShareMessages object, containing all methods to manipulate and get info about messages.
      de.uplanet.lucy.server.share.velocity.feed.VcFeedSetting getMySetting​(List<de.uplanet.lucy.server.share.velocity.feed.VcFeedSetting> p_lstSettings, String p_strFeedRecId)  
      de.uplanet.lucy.server.auxiliaries.share.velocity.photoalbum.VcPhotoAlbums getPhotoAlbums​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcPhotoAlbums object, all methods to manipulate and get info about photo albums.
      static de.uplanet.lucy.server.auxiliaries.share.velocity.plugin.VcPluginHelper getPlugins​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strLang)
      Returns VcPluginHelper object - get info about the users and the systems plugins
      de.uplanet.lucy.server.auxiliaries.share.velocity.pokes.VcPokes getPokes​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcPokes object, all methods to manipulate and get info about pokes
      de.uplanet.lucy.server.auxiliaries.share.velocity.poll.VcPolls getPolls​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcPolls object, all methods to manipulate and get info about polls
      de.uplanet.lucy.server.auxiliaries.share.velocity.profile.VcProfile getProfileFromGuid​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strProfileId)
      Returns a profile from a given GUID.
      static String getProfileId​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Gets the profile ID of the current user.
      static String getProfileId​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strUserGuid)
      Gets the profile ID of the given user.
      de.uplanet.lucy.server.auxiliaries.share.velocity.profile.VcProfiles getProfiles​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns a ShareProfiles object, containing all methods to manipulate and get info about profiles.
      String getProfileSummary​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strProfileId, String p_strSeperator)
      Returns the profile summary.
      de.uplanet.lucy.server.auxiliaries.share.velocity.project.VcProjects getProjects​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns VcProjects object, all methods to manipulate and get info about projects
      static int getRefreshInterval()  
      de.uplanet.lucy.server.auxiliaries.share.velocity.relationship.VcRelations getRelations​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Returns the relationship callable object providing methods in the context of relationship models.
      de.uplanet.lucy.server.share.businesslogic.connection.ShareConnections getShareConnections​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)  
      static int getShareVersion()  
      static de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.VcSystemMessages getSystemMessages​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, boolean p_bMobile)  
      static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.mailsettings.VcUserSetting> getUserMailSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)  
      static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.pushnotificationsettings.VcUserPushNotificationSetting> getUserPushNotificationSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)  
      boolean hasPagePermission​(String p_strGuid)
      Checks access permissions to a given page
      boolean hasProfile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strProfileId)
      Returns true, if the given Profile id is in share present
      static boolean isMyProfile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strOtherProfileId)
      Returns true, if the profile belongs to the current user.
      boolean isProfileComplete​(String p_strProfileId)
      Checks if the profile is complete and contains all necessary information.
      boolean isShareAdministrator​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strProfileId)  
      static boolean isUserBlocked​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strUserId, String p_strBlockedUserId)  
      boolean markSystemMessageAsRead​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strSystemMessageId)
      Marks a system message as read by the current user.
      boolean markSystemMessagesAsRead​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
      Marks all system messages as read by the current user.
      static boolean removeFilter​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strUserGuid, String p_strJSON)  
      static String[] renderComment​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strOriginalComment, String p_strMediaData, int p_iMaxCommentLength, int p_iTruncateThreshold)  
      static String[] renderCommentForMobile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strOriginalComment, String p_strMediaData, int p_iMaxCommentLength, int p_iTruncateThreshold)  
      static boolean saveFilter​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strUserGuid, String p_strJSON)  
      static void saveSortOrder​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strProfileId, String p_strSortOrder)  
      static String setFavorite​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFeedId, boolean p_bIsFavorite)
      Sets the is favorite of a given feed for the current logged-in user.
      static String setImportance​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFeedId, boolean p_importance)
      Sets the importance of a given feed for the current logged-in user.
      static String setRead​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFeedId, boolean p_bIsRead)
      Sets the is read of a given feed for the current logged-in user.
      static String setUrgency​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx, String p_strFeedId, boolean p_bUrgency)
      Sets the urgency of a given feed for the current logged-in user.
      static boolean shouldTruncate​(String p_strText, int p_iLen)  

    • Constructor Detail

      • ShareCallable

        public ShareCallable()

    • Method Detail

      • getRefreshInterval

        public static int getRefreshInterval()

      • countFeedReads

        public static int countFeedReads​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                 String p_strFeedId)
                          throws de.uplanet.lucy.server.businesslogic.BlException
        Throws:
        de.uplanet.lucy.server.businesslogic.BlException

      • getFeedComments

        public static List<de.uplanet.lucy.server.share.velocity.feed.VcComment> getFeedComments​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                                                                         String p_strFeedId)
                                                                                  throws de.uplanet.lucy.server.businesslogic.BlException
        Throws:
        de.uplanet.lucy.server.businesslogic.BlException

      • addFeedComment

        public static boolean addFeedComment​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                     String p_strFeedRecId,
                                     String p_strComment,
                                     String p_strMediaData,
                                     String p_strPluginGuid,
                                     String p_strPluginRecId)
                              throws Exception
        Throws:
        Exception

      • renderComment

        public static String[] renderComment​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                     String p_strOriginalComment,
                                     String p_strMediaData,
                                     int p_iMaxCommentLength,
                                     int p_iTruncateThreshold)

      • renderCommentForMobile

        public static String[] renderCommentForMobile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                              String p_strOriginalComment,
                                              String p_strMediaData,
                                              int p_iMaxCommentLength,
                                              int p_iTruncateThreshold)

      • getPlugins

        public static de.uplanet.lucy.server.auxiliaries.share.velocity.plugin.VcPluginHelper getPlugins​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                                                                                 String p_strLang)
                                                                                          throws Exception
        Returns VcPluginHelper object - get info about the users and the systems plugins
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        p_strLang - The language of the current user.
        Returns:
        The VcPluginHelper object
        Throws:
        Exception

      • getAdvertisings

        public de.uplanet.lucy.server.auxiliaries.share.velocity.advertising.VcAdvertisings getAdvertisings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
        Returns VcAdvertisings object, all methods to manipulate and get info about events
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcAdvertisings object

      • getEvents

        public de.uplanet.lucy.server.auxiliaries.share.velocity.event.VcEvents getEvents​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                           throws Exception
        Returns VcEvents object, all methods to manipulate and get info about events
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcEvents object
        Throws:
        Exception

      • getGroups

        public de.uplanet.lucy.server.auxiliaries.share.velocity.group.VcGroups getGroups​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                           throws Exception
        Returns VcGroups object, all methods to manipulate and get info about groups
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcGroups object
        Throws:
        Exception

      • getFeeds

        public de.uplanet.lucy.server.auxiliaries.share.velocity.feed.VcFeeds getFeeds​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                        throws Exception
        Returns the feed callable object providing methods in the context of feeds.
        Parameters:
        p_ctx - The processing context of the business logic.
        Returns:
        The feed callable.
        Throws:
        Exception

      • getPhotoAlbums

        public de.uplanet.lucy.server.auxiliaries.share.velocity.photoalbum.VcPhotoAlbums getPhotoAlbums​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
        Returns VcPhotoAlbums object, all methods to manipulate and get info about photo albums.
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcPhotoAlbums object.

      • getRelations

        public de.uplanet.lucy.server.auxiliaries.share.velocity.relationship.VcRelations getRelations​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
        Returns the relationship callable object providing methods in the context of relationship models.
        Parameters:
        p_ctx - The processing context of the business logic.
        Returns:
        The relationship callable.

      • hasPagePermission

        public boolean hasPagePermission​(String p_strGuid)
        Checks access permissions to a given page
        Parameters:
        p_strGuid - The ID of the page.
        Returns:
        true if the permission is granted.

      • getContacts

        public de.uplanet.lucy.server.auxiliaries.share.velocity.contact.VcContacts getContacts​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                 throws Exception
        Returns VcContacts object, all methods to manipulate contacts
        Returns:
        The VcContacts object
        Throws:
        Exception

      • getInterests

        public de.uplanet.lucy.server.auxiliaries.share.velocity.interest.VcInterests getInterests​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                    throws Exception
        Returns VcInterests object, all methods to manipulate and get info about interests
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcInterests object
        Throws:
        Exception

      • getLikes

        public de.uplanet.lucy.server.auxiliaries.share.velocity.feed.VcLikes getLikes​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
        Returns VcLikes object, all methods to manipulate and get info about likes
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcLikes object

      • getPokes

        public de.uplanet.lucy.server.auxiliaries.share.velocity.pokes.VcPokes getPokes​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                         throws Exception
        Returns VcPokes object, all methods to manipulate and get info about pokes
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcPokes object
        Throws:
        Exception

      • getProjects

        public de.uplanet.lucy.server.auxiliaries.share.velocity.project.VcProjects getProjects​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                 throws Exception
        Returns VcProjects object, all methods to manipulate and get info about projects
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcProjects object
        Throws:
        Exception

      • getPolls

        public de.uplanet.lucy.server.auxiliaries.share.velocity.poll.VcPolls getPolls​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                        throws Exception
        Returns VcPolls object, all methods to manipulate and get info about polls
        Parameters:
        p_ctx - The IBusinessLogicProcessingContext.
        Returns:
        The VcPolls object
        Throws:
        Exception

      • getFeedInformation

        public de.uplanet.lucy.server.auxiliaries.share.velocity.feed.VcFeedInformation getFeedInformation​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)

      • getControlGuidBySetting

        public String getControlGuidBySetting​(String p_strPageGuid,
                                      String p_strSetting)
        Returns Control-GUID of a datarange, if the given page has a datarange control with name SHARE.IDENTIFIER this setting, otherwise null.
        Parameters:
        p_strPageGuid - The page.
        p_strSetting - The Setting.
        Returns:
        The GUID of the control

      • getMySetting

        public de.uplanet.lucy.server.share.velocity.feed.VcFeedSetting getMySetting​(List<de.uplanet.lucy.server.share.velocity.feed.VcFeedSetting> p_lstSettings,
                                                                             String p_strFeedRecId)
                                                                      throws Exception
        Throws:
        Exception

      • isMyProfile

        public static boolean isMyProfile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                  String p_strOtherProfileId)
        Returns true, if the profile belongs to the current user.
        Parameters:
        p_ctx - The processing context of the business logic.
        p_strOtherProfileId - The other profile ID.
        Returns:
        True, if the profile belongs to the current user.

      • getProfileId

        public static String getProfileId​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
        Gets the profile ID of the current user.
        Parameters:
        p_ctx - The processing context of the business logic.
        Returns:
        The profile ID of current user.

      • getProfileId

        public static String getProfileId​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                  String p_strUserGuid)
                           throws Exception
        Gets the profile ID of the given user.
        Parameters:
        p_ctx - The processing context of the business logic.
        p_strUserGuid - The GUID of the user.
        Returns:
        The profile ID of the user.
        Throws:
        Exception - Thrown on error.

      • isProfileComplete

        public boolean isProfileComplete​(String p_strProfileId)
                          throws de.uplanet.lucy.server.businesslogic.BlException
        Checks if the profile is complete and contains all necessary information.
        Parameters:
        p_strProfileId - The ID of the user profile.
        Returns:
        true if the profile is complete and contains all necessary information.
        Throws:
        de.uplanet.lucy.server.businesslogic.BlException - Thrown if checking the profile failed.

      • hasProfile

        public boolean hasProfile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                          String p_strProfileId)
                   throws Exception
        Returns true, if the given Profile id is in share present
        Parameters:
        p_ctx - The context.
        p_strProfileId - The profile ID.
        Returns:
        true, if the profile is present, false otherwise
        Throws:
        Exception - If operation failed.

      • getProfileFromGuid

        public de.uplanet.lucy.server.auxiliaries.share.velocity.profile.VcProfile getProfileFromGuid​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                                                                              String p_strProfileId)
                                                                                       throws Exception
        Returns a profile from a given GUID.
        Parameters:
        p_ctx - The context.
        p_strProfileId - The profile ID.
        Returns:
        The desired profile.
        Throws:
        Exception - If operation failed.

      • isShareAdministrator

        public boolean isShareAdministrator​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                    String p_strProfileId)
                             throws Exception
        Throws:
        Exception

      • markSystemMessagesAsRead

        public boolean markSystemMessagesAsRead​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                 throws Exception
        Marks all system messages as read by the current user.
        Parameters:
        p_ctx - The processing context.
        Returns:
        True if the system messages were successfully marked as read.
        Throws:
        Exception

      • markSystemMessageAsRead

        public boolean markSystemMessageAsRead​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                       String p_strSystemMessageId)
                                throws Exception
        Marks a system message as read by the current user.
        Parameters:
        p_ctx - The processing context.
        p_strSystemMessageId - The system message id.
        Returns:
        True if the system message was successfully marked as read.
        Throws:
        Exception

      • getProfileSummary

        public String getProfileSummary​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                String p_strProfileId,
                                String p_strSeperator)
                         throws Exception
        Returns the profile summary.
        Parameters:
        p_ctx - The context.
        p_strProfileId - The profile ID.
        p_strSeperator - The separator.
        Returns:
        The profile summary.
        Throws:
        Exception - If operation failed.

      • getImageLink

        public static String getImageLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                  String p_strImageStyleClass,
                                  de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage,
                                  String p_strRecId,
                                  String p_strTargetSettingKey,
                                  String p_strAlt,
                                  boolean p_bTooltip)
                           throws Exception
        Constructs an image link.
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_vhImage - The ValueHolder of the Image
        p_strRecId - The PK of the Target
        p_strTargetSettingKey - The Setting-Key of the TargetPageGuid
        p_strAlt - The alt-text of the image
        p_bTooltip - True, if target should be opened in an tooltip
        Returns:
        The complete - tag
        Throws:
        Exception

      • getImageLink

        public static String getImageLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                  String p_strImageStyleClass,
                                  de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage,
                                  String p_strRecId,
                                  String p_strTargetSettingKey,
                                  String p_strAlt,
                                  boolean p_bTooltip,
                                  int p_bWidth,
                                  int p_bHeight)
                           throws Exception
        Constructs an image link.
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_vhImage - The ValueHolder of the Image
        p_strRecId - The PK of the Target
        p_strTargetSettingKey - The Setting-Key of the TargetPageGuid
        p_strAlt - The alt-text of the image
        p_bTooltip - True, if target should be opened in an tooltip
        Returns:
        The complete - tag
        Throws:
        Exception

      • getImageLink

        public static String getImageLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                  String p_strImageStyleClass,
                                  de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage,
                                  String p_strRecId,
                                  String p_strTargetSettingKey,
                                  String p_strAlt,
                                  boolean p_bTooltip,
                                  int p_iWidth,
                                  int p_iHeight,
                                  List<String> p_attributes)
                           throws Exception
        Constructs an image link.
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_vhImage - The ValueHolder of the Image
        p_strRecId - The PK of the Target
        p_strTargetSettingKey - The Setting-Key of the TargetPageGuid
        p_strAlt - The alt-text of the image
        p_bTooltip - True, if target should be opened in an tooltip
        Returns:
        The complete - tag
        Throws:
        Exception

      • getLink

        public static String getLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                             String p_strLinkText,
                             int p_iRecId,
                             String p_strTargetSettingKey,
                             String p_strLinkType,
                             String p_strStyleClass,
                             String p_strHijaxTooltipProps)
                      throws de.uplanet.lucy.server.businesslogic.BlException
        Constructs a link.
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_strLinkText - Text to be shown
        p_iRecId - The PK of the Target
        p_strTargetSettingKey - The Setting-Key of the TargetPageGuid
        p_strLinkType - stage if target should be opened in the stage, tooltip if target should be opened in an tooltip, tooltipModal if target should be opened in an modal tooltip.
        p_strStyleClass - The style class to be used for the link.
        p_strHijaxTooltipProps - The Hijax tooltip properties.
        Returns:
        The complete - tag
        Throws:
        de.uplanet.lucy.server.businesslogic.BlException - Thrown on error.

      • getLink

        public static String getLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                             String p_strLinkText,
                             String p_strRecId,
                             String p_strTargetSettingKey,
                             String p_strLinkType,
                             String p_strStyleClass,
                             String p_strHijaxTooltipProps)
                      throws de.uplanet.lucy.server.businesslogic.BlException
        Constructs a link.
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_strLinkText - Text to be shown
        p_strRecId - The PK of the Target
        p_strTargetSettingKey - The Setting-Key of the TargetPageGuid
        p_strLinkType - stage if target should be opened in the stage, tooltip if target should be opened in an tooltip, tooltipModal if target should be opened in an modal tooltip.
        p_strStyleClass - The style class to be used for the link.
        p_strHijaxTooltipProps - The Hijax tooltip properties.
        Returns:
        The complete - tag
        Throws:
        de.uplanet.lucy.server.businesslogic.BlException - Thrown on error.

      • getFeedLink

        public static String getFeedLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                 String p_strLinkText,
                                 String p_strRecId,
                                 String p_strTargetSettingKey,
                                 String p_strLinkType,
                                 String p_strStyleClass,
                                 String p_strHijaxTooltipProps,
                                 String p_strFeedTableMode)
                          throws de.uplanet.lucy.server.businesslogic.BlException
        Constructs a feed link.
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_strLinkText - Text to be shown
        p_strRecId - The PK of the Target
        p_strTargetSettingKey - The Setting-Key of the TargetPageGuid
        p_strLinkType - stage if target should be opened in the stage, tooltip if target should be opened in an tooltip, tooltipModal if target should be opened in an modal tooltip.
        p_strStyleClass - The style class to be used for the link.
        p_strHijaxTooltipProps - The Hijax tooltip properties.
        p_strFeedTableMode - The feed table mode or null.
        Returns:
        The complete - tag
        Throws:
        de.uplanet.lucy.server.businesslogic.BlException - Thrown on error.

      • getColor

        public static String getColor​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                              String p_strType,
                              String p_strDefault)
        Get defined colors
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_strType - The key to access the systemdatagroup
        p_strDefault - The default value
        Returns:
        The color, if defined, otherwise the given default value

      • canAccessModule

        public static boolean canAccessModule​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                      String p_strTargetPageGuid,
                                      String p_strModuleKey)
        Check the module permission and status
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_strTargetPageGuid - The GUID of the Startpage of the Module
        p_strModuleKey - The module key to access the systemdatagroup
        Returns:
        true, if the user has page permission and the module is enabled

      • getSystemMessages

        public static de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.VcSystemMessages getSystemMessages​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                                                                                                 boolean p_bMobile)
                                                                                                          throws Exception
        Throws:
        Exception

      • getProfiles

        public de.uplanet.lucy.server.auxiliaries.share.velocity.profile.VcProfiles getProfiles​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                 throws Exception
        Returns a ShareProfiles object, containing all methods to manipulate and get info about profiles.
        Parameters:
        p_ctx - The business logic processing context.
        Returns:
        The ShareProfiles object.
        Throws:
        Exception

      • getCountFileStoreFiles

        public int getCountFileStoreFiles​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                           throws Exception
        Returns count of files.
        Returns:
        Count of files.
        Throws:
        Exception

      • getFeedPermission

        public de.uplanet.lucy.server.share.velocity.feed.VcFeedPermission getFeedPermission​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                                                                     de.uplanet.lucy.server.share.velocity.feed.VcFeedRow p_feed)
                                                                              throws Exception
        Returns a VcFeedPermission object, containing information about abilities for deleting and editing feeds
        Parameters:
        p_ctx - The business logic processing context.
        p_feed - The Feed.
        Returns:
        The VcFeedPermission object.
        Throws:
        Exception

      • getFeedPermission

        public de.uplanet.lucy.server.share.velocity.feed.VcFeedPermission getFeedPermission​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                                                                     de.uplanet.lucy.server.share.velocity.feed.VcFeed p_feed)
                                                                              throws Exception
        Returns a VcFeedPermission object, containing information about abilities for deleting and editing feeds
        Parameters:
        p_ctx - The business logic processing context.
        p_feed - The Feed.
        Returns:
        The VcFeedPermission object.
        Throws:
        Exception

      • canWriteFeeds

        public boolean canWriteFeeds​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                             String p_strCurrentProfileId,
                             String p_strVisitedProfileId)
                      throws Exception
        Returns true if the current profile is allowed to write feeds on the visited profile.
        Parameters:
        p_ctx - The BL processing context.
        p_strCurrentProfileId - The current profile ID.
        p_strVisitedProfileId - The visited profile ID.
        Returns:
        true if the current profile is allowed to write feeds on the visited profile, otherwise false.
        Throws:
        Exception

      • getMessages

        public de.uplanet.lucy.server.auxiliaries.share.velocity.message.VcMessages getMessages​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
        Returns a ShareMessages object, containing all methods to manipulate and get info about messages.
        Parameters:
        p_ctx - The business logic processing context.
        Returns:
        The ShareProfiles object.

      • getCountOfNewSystemMessagesForCurrentUser

        public long getCountOfNewSystemMessagesForCurrentUser​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                               throws Exception
        Returns count of new system messages for current user.
        Returns:
        The count of new system messages.
        Throws:
        Exception

      • getAdminMailSettings

        public static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.mailsettings.VcAdminSetting> getAdminMailSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                                                              throws Exception
        Throws:
        Exception

      • getUserMailSettings

        public static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.mailsettings.VcUserSetting> getUserMailSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                                                            throws Exception
        Throws:
        Exception

      • getAdminPushNotificationSettings

        public static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.pushnotificationsettings.VcAdminPushNotificationSetting> getAdminPushNotificationSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                                                                                                      throws Exception
        Throws:
        Exception

      • getUserPushNotificationSettings

        public static List<de.uplanet.lucy.server.auxiliaries.share.velocity.systemmessage.pushnotificationsettings.VcUserPushNotificationSetting> getUserPushNotificationSettings​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)
                                                                                                                                                                    throws Exception
        Throws:
        Exception

      • getFeedTableModeByFeedClass

        public String getFeedTableModeByFeedClass​(String p_strFeedClass)

      • getDataRangeConfigurationModeByName

        public de.uplanet.lucy.share.constants.MODE getDataRangeConfigurationModeByName​(String p_strMode)

      • saveFilter

        public static boolean saveFilter​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                 String p_strUserGuid,
                                 String p_strJSON)

      • saveSortOrder

        public static void saveSortOrder​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                 String p_strProfileId,
                                 String p_strSortOrder)
                          throws Exception
        Throws:
        Exception

      • removeFilter

        public static boolean removeFilter​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                   String p_strUserGuid,
                                   String p_strJSON)

      • getFilter

        public static String getFilter​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                               String p_strKey,
                               String p_strUserGuid,
                               String p_strDefault)

      • isUserBlocked

        public static boolean isUserBlocked​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                    String p_strUserId,
                                    String p_strBlockedUserId)
                             throws Exception
        Throws:
        Exception

      • getFeedRecId

        public static String getFeedRecId​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                  String p_strPluginGuid,
                                  String p_strPluginDgGuid,
                                  String p_strPluginRecId)
                           throws Exception
        Throws:
        Exception

      • getImageWithoutLink

        public static String getImageWithoutLink​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                         String p_strImageStyleClass,
                                         de.uplanet.lucy.server.dataobjects.IFileValueHolder p_vhImage,
                                         String p_strRecId,
                                         String p_strAlt,
                                         int p_bWidth,
                                         int p_bHeight)
                                  throws Exception
        Constructs an image link.
        Parameters:
        p_ctx - The BusinessLogicProcessingContext
        p_vhImage - The ValueHolder of the Image
        p_strRecId - The PK of the Target
        p_strAlt - The alt-text of the image
        Returns:
        The complete img - tag
        Throws:
        Exception

      • setImportance

        public static String setImportance​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                   String p_strFeedId,
                                   boolean p_importance)
                            throws Exception
        Sets the importance of a given feed for the current logged-in user. Besides the default feed configuration applicable for all users, feeds can be labeled in a two-state scale as either important or not on a per user basis. This per-user configuration, if present, takes precedence over the default feed state.
        Parameters:
        p_ctx - The business logic processing context.
        p_strFeedId - The feed ID to be processed.
        p_importance - If set to true, the feed is important, if set to false, it is unimportant.
        Returns:
        The feed ID.
        Throws:
        Exception

      • setUrgency

        public static String setUrgency​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                String p_strFeedId,
                                boolean p_bUrgency)
                         throws Exception
        Sets the urgency of a given feed for the current logged-in user. Besides the default feed configuration applicable for all users, feeds can be labeled in a two-state scale as either urgent or not on a per user basis. This per-user configuration, if present, takes precedence over the default feed state.
        Parameters:
        p_ctx - The business logic processing context.
        p_strFeedId - The feed ID to be processed.
        p_bUrgency - If set to true, the feed is urgent, if set to false, it is not urgent.
        Returns:
        The feed ID.
        Throws:
        Exception

      • setRead

        public static String setRead​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                             String p_strFeedId,
                             boolean p_bIsRead)
                      throws Exception
        Sets the is read of a given feed for the current logged-in user.
        Parameters:
        p_ctx - The business logic processing context.
        p_strFeedId - The feed ID to be processed.
        p_bIsRead - If set to true, the feed is read, if set to false, it is unread.
        Returns:
        The feed ID.
        Throws:
        Exception

      • setFavorite

        public static String setFavorite​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                 String p_strFeedId,
                                 boolean p_bIsFavorite)
                          throws Exception
        Sets the is favorite of a given feed for the current logged-in user.
        Parameters:
        p_ctx - The business logic processing context.
        p_strFeedId - The feed ID to be processed.
        p_bIsFavorite - If set to true, the feed is a favorite, if set to false, it is not a favorite.
        Returns:
        The feed ID.
        Throws:
        Exception

      • getShareVersion

        public static int getShareVersion()

      • getAddOnVersion

        public static int getAddOnVersion​(String p_strAppGuid)
        Get the version of an AddOn application.
        Parameters:
        p_strAppGuid - The application GUID
        Returns:
        The version, or 1000 if the version is not available.

      • getShareConnections

        public de.uplanet.lucy.server.share.businesslogic.connection.ShareConnections getShareConnections​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx)

      • getFolderName

        public String getFolderName​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                            String p_strFolderRecId)
                     throws Exception
        Throws:
        Exception

      • getFileFolderName

        public String getFileFolderName​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                String p_strFileRecId)
                         throws Exception
        Throws:
        Exception

      • canAddFile

        public static boolean canAddFile​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                 String p_strFolderId,
                                 String p_strProfileId)
                          throws Exception
        Parameters:
        p_ctx - The businesslogic processing context.
        p_strFolderId - The folder ID.
        p_strProfileId - The profile ID.
        Returns:
        true if the profile can add a file to the given folder, false otherwise.
        Throws:
        Exception

      • canRequestReadConfirmation

        public static boolean canRequestReadConfirmation​(de.uplanet.lucy.server.businesslogic.IBusinessLogicProcessingContext p_ctx,
                                                 String p_strProfileId)
        Parameters:
        p_ctx - The business logic processing context.
        p_strProfileId - The profile ID.
        Returns:
        true if the profile can request a read confirmation, false otherwise. This method requires at least Share 2.0.

      • shouldTruncate

        public static boolean shouldTruncate​(String p_strText,
                                     int p_iLen)
        Parameters:
        p_strText - The text - could be HTML
        p_iLen - The maximum length
        Returns:
        true if the text should be truncated, false otherwise.