org.apache.abdera.model
Interface Workspace

All Superinterfaces:
Base, Cloneable, Element, ExtensibleElement, Iterable<Element>

public interface Workspace
extends ExtensibleElement

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 Summary
 Workspace addCollection(Collection collection)
          Adds an individual collection to this workspace
 Collection addCollection(String title, String href)
          Adds an individual collection to this workspace
 Collection addMultipartCollection(String title, String href)
          Adds a multipart collection to this workspace
 Collection getCollection(String title)
          Returns the named collection
 List<Collection> getCollections()
          Returns the full set of collections in this workspace
 List<Collection> getCollectionsThatAccept(javax.activation.MimeType... type)
          Returns collections that accept the specified media types
 List<Collection> getCollectionsThatAccept(String... type)
          Returns collections that accept the specified media types
 Collection getCollectionThatAccepts(javax.activation.MimeType... type)
          Returns a collection that accepts the specified media types
 Collection getCollectionThatAccepts(String... type)
          Returns a collection that accepts the specified media types
 String getTitle()
          Return the workspace title
 Text getTitleElement()
          Return the atom:title
 Text setTitle(String title)
          Set the workspace title
 Text setTitleAsHtml(String title)
          Set the workspace title as escaped HTML
 Text setTitleAsXHtml(String title)
          Set the workspace title as XHTML
 
Methods inherited from interface org.apache.abdera.model.ExtensibleElement
addExtension, addExtension, addExtension, addExtension, addExtension, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension
 
Methods inherited from interface org.apache.abdera.model.Element
declareNS, discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getElements, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setMustPreserveWhitespace, setParentElement, setText, setText
 
Methods inherited from interface org.apache.abdera.model.Base
addComment, clone, complete, getDefaultWriterOptions, getFactory, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

getTitle

String getTitle()
Return the workspace title

Returns:
The atom:title value

setTitle

Text setTitle(String title)
Set the workspace title

Parameters:
title - The atom:title value
Returns:
The newly created atom:title

setTitleAsHtml

Text setTitleAsHtml(String title)
Set the workspace title as escaped HTML

Parameters:
title - The atom:title value
Returns:
The newly created atom:title

setTitleAsXHtml

Text setTitleAsXHtml(String title)
Set the workspace title as XHTML

Parameters:
title - The atom:title value
Returns:
the newly created atom:title

getTitleElement

Text getTitleElement()
Return the atom:title

Returns:
The atom:title element

getCollections

List<Collection> getCollections()
Returns the full set of collections in this workspace

Returns:
A listing of app:collection elements

getCollection

Collection getCollection(String title)
Returns the named collection

Parameters:
title - A collection title
Returns:
A matching app:collection

addCollection

Workspace addCollection(Collection collection)
Adds an individual collection to this workspace

Parameters:
collection - The collection to add

addCollection

Collection addCollection(String title,
                         String href)
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)
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)
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)
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)
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)
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


Copyright © 2006-2010 Apache Software Foundation. All Rights Reserved.