com.frevvo.forms.client
Class SubmissionEntry

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.ExtensionPoint
          com.google.gdata.data.BaseEntry<SubmissionEntry>
              com.frevvo.forms.client.SubmissionEntry

All Implemented Interfaces:

com.google.gdata.data.Extension, com.google.gdata.data.IAtom, com.google.gdata.data.IEntry, com.google.gdata.data.Kind.Adaptable, com.google.gdata.data.Kind.Adaptor

public class SubmissionEntry
extends com.google.gdata.data.BaseEntry<SubmissionEntry>

This entry represents a single form submission.

This entry does not contain any owned/contained feeds.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.data.BaseEntry

com.google.gdata.data.BaseEntry.AtomHandler, com.google.gdata.data.BaseEntry.EntryState

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

com.google.gdata.data.ExtensionPoint.CumulativeBlobHandler, com.google.gdata.data.ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

com.google.gdata.data.AbstractExtension.AttributesHandler

Field Summary

static java.lang.String	ERROR_ELEMENT
static java.lang.String	ERRORDESCRIPTION_ELEMENT
static java.lang.String	REL_PARENTSUBMISSION
static java.lang.String	REL_SNAPSHOT
static java.lang.String	REL_SUBMISSION
static java.lang.String	SUBMISSION_ENTRY_URL_FORMAT
static java.lang.String	VALUE_ATTRIBUTE
static java.lang.String	VERSION_ELEMENT

Fields inherited from class com.google.gdata.data.BaseEntry

state

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

SubmissionEntry()
Constructs a new Entry instance

Method Summary

java.net.URL	createFormInstance(java.util.Map<java.lang.String,java.lang.Object> linkParams, java.util.List<com.google.gdata.data.media.MediaSource> documents) Creates a new Form instance and returns the raw instance URL
java.net.URL	createFormInstanceEmbed(java.util.Map<java.lang.String,java.lang.Object> linkParams, java.util.List<com.google.gdata.data.media.MediaSource> documents) Creates a new Form instance and returns the embed instance URL
void	declareExtensions(com.google.gdata.data.ExtensionProfile extProfile)
void	generate(com.google.gdata.util.common.xml.XmlWriter w, com.google.gdata.data.ExtensionProfile extProfile)
java.util.List<com.google.gdata.data.Link>	getDocumentLinks() Get all the submission documents
java.util.List<com.google.gdata.data.Link>	getDocumentLinks(java.lang.String contentType) Get the submission documents filtered by content type
static java.net.URL	getEntryURL(java.net.URL baseUrl, java.lang.String id) Gets an URL for accessing an FormType entry
java.lang.String	getErrorDescription()
<T extends com.google.gdata.data.Extension> T	getExtension(java.lang.Class<T> extensionClass)
com.google.gdata.data.Link	getFormTypeEmbedLink(java.util.Map<java.lang.String,java.lang.Object> linkParams) Get the embed JS url for the FormType that can edit this submission
com.google.gdata.data.Link	getFormTypeLink(java.util.Map<java.lang.String,java.lang.Object> linkParams) Get the HTML link to this FormTypeEntry.
com.google.gdata.data.Link	getFormTypePopupLink(java.util.Map<java.lang.String,java.lang.Object> linkParams) Get a link to an HTML page that embeds this FormTypeEntry.
com.google.gdata.util.XmlParser.ElementHandler	getHandler(com.google.gdata.data.ExtensionProfile p, java.lang.String namespace, java.lang.String localName, org.xml.sax.Attributes attrs)
KeysExtension	getKeys() Get the keys associated with this submission
java.lang.String	getKind() Get the kind of submission: either FLOW or FORM
com.google.gdata.data.Link	getSnapshotLink(java.lang.String contentType) Get the snapshot link for the given content type
java.util.List<com.google.gdata.data.Link>	getSnapshotLinks() Get all available snapshot links for this entry
java.lang.String	getState() Get the state for this submission: either SAVED, PENDING or SUBMITTED
boolean	isError()
SubmissionEntry	update()

Methods inherited from class com.google.gdata.data.BaseEntry

addAdaptor, addHtmlLink, addLink, addLink, delete, generateAtom, generateRss, getAdaptedEntry, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContentHandlerInfo, getContributors, getEdited, getEditLink, getEtag, getHtmlLink, getId, getLink, getLinks, getLinks, getMediaEditLink, getPlainTextContent, getPubControl, getPublished, getRights, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, parseAtom, readEntry, readEntry, removeLinks, removeLinks, setCanEdit, setContent, setContent, setDraft, setEdited, setEtag, setId, setKind, setPubControl, setPublished, setRights, setService, setSource, setSummary, setTitle, setUpdated, setVersionId, visitChildren

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtensionDescription, getExtensionHandler, getExtensions, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild

Methods inherited from class com.google.gdata.data.AbstractExtension

consumeAttributes, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

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

Field Detail

REL_SUBMISSION

public static final java.lang.String REL_SUBMISSION

See Also:

Constant Field Values

REL_PARENTSUBMISSION

public static final java.lang.String REL_PARENTSUBMISSION

See Also:

Constant Field Values

SUBMISSION_ENTRY_URL_FORMAT

public static final java.lang.String SUBMISSION_ENTRY_URL_FORMAT

See Also:

Constant Field Values

VERSION_ELEMENT

public static final java.lang.String VERSION_ELEMENT

See Also:

Constant Field Values

ERROR_ELEMENT

public static final java.lang.String ERROR_ELEMENT

See Also:

Constant Field Values

ERRORDESCRIPTION_ELEMENT

public static final java.lang.String ERRORDESCRIPTION_ELEMENT

See Also:

Constant Field Values

VALUE_ATTRIBUTE

public static final java.lang.String VALUE_ATTRIBUTE

See Also:

Constant Field Values

REL_SNAPSHOT

public static final java.lang.String REL_SNAPSHOT

See Also:

Constant Field Values

Constructor Detail

SubmissionEntry

public SubmissionEntry()

Constructs a new Entry instance

Method Detail

getEntryURL

public static java.net.URL getEntryURL(java.net.URL baseUrl,
                                       java.lang.String id)
                                throws java.net.MalformedURLException

Gets an URL for accessing an FormType entry

Parameters:

id - the theme entry id

Returns:

The entry URL

Throws:

java.net.MalformedURLException

isError

public boolean isError()

getErrorDescription

public java.lang.String getErrorDescription()

declareExtensions

public void declareExtensions(com.google.gdata.data.ExtensionProfile extProfile)

Specified by:

declareExtensions in interface com.google.gdata.data.Kind.Adaptor

Overrides:

declareExtensions in class com.google.gdata.data.ExtensionPoint

getKind

public java.lang.String getKind()

Get the kind of submission: either FLOW or FORM

Specified by:

getKind in interface com.google.gdata.data.IAtom

Overrides:

getKind in class com.google.gdata.data.BaseEntry<SubmissionEntry>

Returns:

The submission kind

getState

public java.lang.String getState()

Get the state for this submission: either SAVED, PENDING or SUBMITTED

Returns:

The submission state

update

public SubmissionEntry update()
                       throws java.io.IOException,
                              com.google.gdata.util.ServiceException

Overrides:

update in class com.google.gdata.data.BaseEntry<SubmissionEntry>

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

getKeys

public KeysExtension getKeys()

Get the keys associated with this submission

Returns:

The Keys for this submission

getDocumentLinks

public java.util.List<com.google.gdata.data.Link> getDocumentLinks()

Get all the submission documents

Returns:

The list of document links

getDocumentLinks

public java.util.List<com.google.gdata.data.Link> getDocumentLinks(java.lang.String contentType)

Get the submission documents filtered by content type

Parameters:

contentTypeFilter - An optional contentType used to filter the list of documents

Returns:

The list of document links

getFormTypeLink

public com.google.gdata.data.Link getFormTypeLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
                                           throws com.google.gdata.util.ServiceException

Get the HTML link to this FormTypeEntry.

Parameters:

linkParams - The parameters used to customize the link to the form

Returns:

The Link to this FormTypeEntry's form

Throws:

com.google.gdata.util.ServiceException

getFormTypePopupLink

public com.google.gdata.data.Link getFormTypePopupLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
                                                throws com.google.gdata.util.ServiceException

Get a link to an HTML page that embeds this FormTypeEntry.

Parameters:

linkParams - The parameters used to customize the link to the form

Returns:

The Link to this FormTypeEntry's form

Throws:

com.google.gdata.util.ServiceException

getFormTypeEmbedLink

public com.google.gdata.data.Link getFormTypeEmbedLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)

Get the embed JS url for the FormType that can edit this submission

Next is an example of how this link href should be used in an html page:

        <script language="JavaScript" type="text/javascript" src="{EMBEDLINK}"/>
 

Parameters:

linkParams - The parameters used to customize the embed url (see FormTypeEntry.EMBED_*_PARAMETERS constants)

Returns:

The embed JS url

getSnapshotLinks

public java.util.List<com.google.gdata.data.Link> getSnapshotLinks()

Get all available snapshot links for this entry

Returns:

The list of snaphost links

getSnapshotLink

public com.google.gdata.data.Link getSnapshotLink(java.lang.String contentType)

Get the snapshot link for the given content type

Parameters:

contentType - The type of snapshot

Returns:

The link to the snapshot

createFormInstance

public java.net.URL createFormInstance(java.util.Map<java.lang.String,java.lang.Object> linkParams,
                                       java.util.List<com.google.gdata.data.media.MediaSource> documents)
                                throws com.google.gdata.util.ServiceException

Creates a new Form instance and returns the raw instance URL

Parameters:

linkParams - The parameters that can be used to initialize the form instance

documents - A list of XML documents that can be used to initialize the form

Returns:

The form instance raw url to the HTML representation of the form

Throws:

com.google.gdata.util.ServiceException

createFormInstanceEmbed

public java.net.URL createFormInstanceEmbed(java.util.Map<java.lang.String,java.lang.Object> linkParams,
                                            java.util.List<com.google.gdata.data.media.MediaSource> documents)
                                     throws com.google.gdata.util.ServiceException

Creates a new Form instance and returns the embed instance URL

Parameters:

linkParams - The parametes that can be used to initialize the form instance

documents - The list of XML documents that can be used to initialize the form

Returns:

The URL to the Form instance embed Javascript

Throws:

com.google.gdata.util.ServiceException

getExtension

public <T extends com.google.gdata.data.Extension> T getExtension(java.lang.Class<T> extensionClass)

Overrides:

getExtension in class com.google.gdata.data.ExtensionPoint

generate

public void generate(com.google.gdata.util.common.xml.XmlWriter w,
                     com.google.gdata.data.ExtensionProfile extProfile)
              throws java.io.IOException

Specified by:

generate in interface com.google.gdata.data.Extension

Overrides:

generate in class com.google.gdata.data.BaseEntry<SubmissionEntry>

Throws:

java.io.IOException

getHandler

public com.google.gdata.util.XmlParser.ElementHandler getHandler(com.google.gdata.data.ExtensionProfile p,
                                                                 java.lang.String namespace,
                                                                 java.lang.String localName,
                                                                 org.xml.sax.Attributes attrs)

Specified by:

getHandler in interface com.google.gdata.data.Extension

Overrides:

getHandler in class com.google.gdata.data.BaseEntry<SubmissionEntry>