Package com.collabnet.ce.webservices

Class CTFDocument

java.lang.Object

com.collabnet.ce.webservices.CTFItem

com.collabnet.ce.webservices.CTFDocument

All Implemented Interfaces:

ObjectWithTitle

public class CTFDocument
extends CTFItem

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
protected CollabNetApp	app
protected String	id

Constructor Summary

Constructors

Constructor	Description
CTFDocument(com.collabnet.ce.webservices.CTFObject parent, org.json.simple.JSONObject data)

Method Summary

Modifier and Type	Method	Description
protected <T extends ObjectWithTitle> T	findByTitle(List<T> list, String title)	Convenience method for a subtype to find an item in a collection by its title.
String	getDescription()
String	getId()
String	getURL()	Get the document's URL.
void	update(CTFFile file)	Updates this document by a new file.

Methods inherited from class com.collabnet.ce.webservices.CTFItem

getFolder, getPath, getTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.collabnet.ce.webservices.ObjectWithTitle

getId

Field Detail

app

protected final CollabNetApp app

id

protected final String id

Constructor Detail

CTFDocument

public CTFDocument(com.collabnet.ce.webservices.CTFObject parent,
                   org.json.simple.JSONObject data)

Method Detail

getDescription

public String getDescription()

update

public void update(CTFFile file)
            throws IOException

Updates this document by a new file.

Throws:

IOException

getURL

public String getURL()

Get the document's URL.

Returns:

an absolute URL to the document.

getId

public String getId()

findByTitle

protected <T extends ObjectWithTitle> T findByTitle(List<T> list,
                                                    String title)

Convenience method for a subtype to find an item in a collection by its title.