Package org.apache.abdera.model

Interface Workspace

All Superinterfaces:
Base, Cloneable, Element, ExtensibleElement, Iterable<Element>
@Deprecated(since="2021-07-29") public interface Workspace extends ExtensibleElement
Deprecated.
This API is deprecated as Apache Abdera is a retired project since 2017.

An Atom Publishing Protocol Introspection Document workspace element.

Per APP Draft-08 

   The "app:workspace" element contains information elements about the
   collections of resources available for editing.  The app:workspace
   element MUST contain one or more app:collection elements.

   appWorkspace =
      element app:workspace {
         appCommonAttributes,
         ( atomTitle
           & appCollection*
           & extensionElement* )
      }

  • Method Details

    • getTitle

      String getTitle()
      Deprecated.
      Return the workspace title
      Returns:
      The atom:title value

    • setTitle

      Text setTitle(String title)
      Deprecated.
      Set the workspace title
      Parameters:
      title - The atom:title value
      Returns:
      The newly created atom:title

    • setTitleAsHtml

      Text setTitleAsHtml(String title)
      Deprecated.
      Set the workspace title as escaped HTML
      Parameters:
      title - The atom:title value
      Returns:
      The newly created atom:title

    • setTitleAsXHtml

      Text setTitleAsXHtml(String title)
      Deprecated.
      Set the workspace title as XHTML
      Parameters:
      title - The atom:title value
      Returns:
      the newly created atom:title

    • getTitleElement

      Text getTitleElement()
      Deprecated.
      Return the atom:title
      Returns:
      The atom:title element

    • getCollections

      List<Collection> getCollections()
      Deprecated.
      Returns the full set of collections in this workspace
      Returns:
      A listing of app:collection elements

    • getCollection

      Collection getCollection(String title)
      Deprecated.
      Returns the named collection
      Parameters:
      title - A collection title
      Returns:
      A matching app:collection

    • addCollection

      Workspace addCollection(Collection collection)
      Deprecated.
      Adds an individual collection to this workspace
      Parameters:
      collection - The collection to add

    • addCollection

      Collection addCollection(String title, String href)
      Deprecated.
      Adds an individual collection to this workspace
      Parameters:
      title - The collection title
      href - The collection HREF
      Returns:
      The newly created app:collection
      Throws:
      IRISyntaxException - if the href is malformed

    • addMultipartCollection

      Collection addMultipartCollection(String title, String href)
      Deprecated.
      Adds a multipart collection to this workspace
      Parameters:
      title - The collection title
      href - The collection HREF
      Returns:
      The newly created app:collection
      Throws:
      IRISyntaxException - if the href is malformed

    • getCollectionThatAccepts

      Collection getCollectionThatAccepts(javax.activation.MimeType... type)
      Deprecated.
      Returns a collection that accepts the specified media types
      Parameters:
      a - listing of media types the collection must accept
      Returns:
      A matching app:collection element

    • getCollectionThatAccepts

      Collection getCollectionThatAccepts(String... type)
      Deprecated.
      Returns a collection that accepts the specified media types
      Parameters:
      a - listing of media types the collection must accept
      Returns:
      A matching app:collection element

    • getCollectionsThatAccept

      List<Collection> getCollectionsThatAccept(javax.activation.MimeType... type)
      Deprecated.
      Returns collections that accept the specified media types
      Parameters:
      a - listing of media types the collection must accept
      Returns:
      A listing matching app:collection elements

    • getCollectionsThatAccept

      List<Collection> getCollectionsThatAccept(String... type)
      Deprecated.
      Returns collections that accept the specified media types
      Parameters:
      a - listing of media types the collection must accept
      Returns:
      A listing of matching app:collection elements