org.restlet.ext.atom
Class Collection

java.lang.Object
  extended by org.restlet.ext.atom.Collection

public class Collection
extends java.lang.Object

Atom Protocol collection, part of a workspace.

Author:
Jerome Louvel

Constructor Summary
Collection(Workspace workspace, java.lang.String title, java.lang.String href)
          Constructor.
 
Method Summary
 Feed getFeed()
          Returns the feed representation.
 Reference getHref()
          Returns the hypertext reference.
 MemberType getMemberType()
          Returns the type of members.
 java.lang.String getTitle()
          Returns the title.
 Workspace getWorkspace()
          Returns the parent workspace.
 Reference postMember(Representation member)
          Posts a member to the collection resulting in the creation of a new resource.
 void setHref(Reference href)
          Sets the hypertext reference.
 void setMemberType(MemberType memberType)
          Sets the type of members.
 void setTitle(java.lang.String title)
          Sets the title.
 void setWorkspace(Workspace workspace)
          Sets the parent workspace.
 void writeElement(XmlWriter writer)
          Writes the current object as an XML element using the given SAX writer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Collection

public Collection(Workspace workspace,
                  java.lang.String title,
                  java.lang.String href)
Constructor.

Parameters:
workspace - The parent workspace.
title - The title.
href - The hypertext reference.
Method Detail

getFeed

public Feed getFeed()
             throws java.lang.Exception
Returns the feed representation.

Returns:
The feed representation.
Throws:
java.lang.Exception

getHref

public Reference getHref()
Returns the hypertext reference.

Returns:
The hypertext reference.

getMemberType

public MemberType getMemberType()
Returns the type of members.

Returns:
The type of members.

getTitle

public java.lang.String getTitle()
Returns the title.

Returns:
The title.

getWorkspace

public Workspace getWorkspace()
Returns the parent workspace.

Returns:
The parent workspace.

postMember

public Reference postMember(Representation member)
                     throws java.lang.Exception
Posts a member to the collection resulting in the creation of a new resource.

Parameters:
member - The member representation to post.
Returns:
The reference of the new resource.
Throws:
java.lang.Exception

setHref

public void setHref(Reference href)
Sets the hypertext reference.

Parameters:
href - The hypertext reference.

setMemberType

public void setMemberType(MemberType memberType)
Sets the type of members.

Parameters:
memberType - The type of members.

setTitle

public void setTitle(java.lang.String title)
Sets the title.

Parameters:
title - The title.

setWorkspace

public void setWorkspace(Workspace workspace)
Sets the parent workspace.

Parameters:
workspace - The parent workspace.

writeElement

public void writeElement(XmlWriter writer)
                  throws org.xml.sax.SAXException
Writes the current object as an XML element using the given SAX writer.

Parameters:
writer - The SAX writer.
Throws:
org.xml.sax.SAXException


Copyright © 2005-2008 Noelios Technologies.