Package org.alfresco.service.cmr.links

Interface LinksService

  • All Known Implementing Classes:
    LinksServiceImpl
    public interface LinksService
    The Links service.
    Since:
    4.0
    Author:
    Nick Burch

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      LinkInfo createLink​(java.lang.String siteShortName, java.lang.String title, java.lang.String description, java.lang.String url, boolean internal)
      Creates a new LinkInfo in the given site, with the specified settings
      void deleteLink​(LinkInfo link)
      Deletes an existing LinkInfo from the repository
      org.alfresco.query.PagingResults<LinkInfo> findLinks​(java.lang.String siteShortName, java.lang.String user, java.util.Date from, java.util.Date to, java.lang.String tag, org.alfresco.query.PagingRequest paging)
      Finds all LinkInfo instances indexed in the repository for the given site, created by the specified user in the specified date range, with the given tag
      LinkInfo getLink​(java.lang.String siteShortName, java.lang.String linkName)
      Retrieves an existing LinkInfo from the repository
      org.alfresco.query.PagingResults<LinkInfo> listLinks​(java.lang.String siteShortName, java.lang.String user, org.alfresco.query.PagingRequest paging)
      Retrieves all LinkInfo instances in the repository for the given site and the specified user.
      org.alfresco.query.PagingResults<LinkInfo> listLinks​(java.lang.String siteShortName, java.util.Date from, java.util.Date to, org.alfresco.query.PagingRequest paging)
      Retrieves all LinkInfo instances in the repository for the given site, created in the specified date range
      org.alfresco.query.PagingResults<LinkInfo> listLinks​(java.lang.String siteShortName, org.alfresco.query.PagingRequest paging)
      Retrieves all LinkInfo instances in the repository for the given site.
      LinkInfo updateLink​(LinkInfo link)
      Updates an existing LinkInfo in the repository.

    • Method Detail

      • createLink

        @NotAuditable
LinkInfo createLink​(java.lang.String siteShortName,
                    java.lang.String title,
                    java.lang.String description,
                    java.lang.String url,
                    boolean internal)
        Creates a new LinkInfo in the given site, with the specified settings
        Returns:
        The newly created LinkInfo

      • deleteLink

        @NotAuditable
void deleteLink​(LinkInfo link)
        Deletes an existing LinkInfo from the repository

      • getLink

        @NotAuditable
LinkInfo getLink​(java.lang.String siteShortName,
                 java.lang.String linkName)
        Retrieves an existing LinkInfo from the repository

      • listLinks

        @NotAuditable
org.alfresco.query.PagingResults<LinkInfo> listLinks​(java.lang.String siteShortName,
                                                     org.alfresco.query.PagingRequest paging)
        Retrieves all LinkInfo instances in the repository for the given site.

      • listLinks

        @NotAuditable
org.alfresco.query.PagingResults<LinkInfo> listLinks​(java.lang.String siteShortName,
                                                     java.lang.String user,
                                                     org.alfresco.query.PagingRequest paging)
        Retrieves all LinkInfo instances in the repository for the given site and the specified user.

      • listLinks

        @NotAuditable
org.alfresco.query.PagingResults<LinkInfo> listLinks​(java.lang.String siteShortName,
                                                     java.util.Date from,
                                                     java.util.Date to,
                                                     org.alfresco.query.PagingRequest paging)
        Retrieves all LinkInfo instances in the repository for the given site, created in the specified date range

      • findLinks

        @NotAuditable
org.alfresco.query.PagingResults<LinkInfo> findLinks​(java.lang.String siteShortName,
                                                     java.lang.String user,
                                                     java.util.Date from,
                                                     java.util.Date to,
                                                     java.lang.String tag,
                                                     org.alfresco.query.PagingRequest paging)
        Finds all LinkInfo instances indexed in the repository for the given site, created by the specified user in the specified date range, with the given tag