com.frevvo.forms.client
Class TaskEntry

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

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 TaskEntry
extends com.google.gdata.data.BaseEntry<TaskEntry>

This entry represents a single task.

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	REL_PARENTTASK
static java.lang.String	REL_TASK
static java.lang.String	TASK_ENTRY_URL_FORMAT

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

TaskEntry()
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
void	declareExtensions(com.google.gdata.data.ExtensionProfile extProfile)
void	delete()
java.util.List<com.google.gdata.data.Link>	getDocumentLink(java.lang.String contentTypeFilter) Get the task 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
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.
java.lang.String	getKind() Get the kind of task: either FLOW or FORM
java.lang.String	getState() Get the state for this submission: either SAVED, PENDING or SUBMITTED, ...
void	setResetToStep(java.lang.String activityName)

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

addAdaptor, addHtmlLink, addLink, addLink, generate, generateAtom, generateRss, getAdaptedEntry, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContentHandlerInfo, getContributors, getEdited, getEditLink, getEtag, getHandler, 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, update, visitChildren

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

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, 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_TASK

public static final java.lang.String REL_TASK

See Also:

Constant Field Values

REL_PARENTTASK

public static final java.lang.String REL_PARENTTASK

See Also:

Constant Field Values

TASK_ENTRY_URL_FORMAT

public static final java.lang.String TASK_ENTRY_URL_FORMAT

See Also:

Constant Field Values

Constructor Detail

TaskEntry

public TaskEntry()

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

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

setResetToStep

public void setResetToStep(java.lang.String activityName)

getKind

public java.lang.String getKind()

Get the kind of task: either FLOW or FORM

Specified by:

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

Overrides:

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

Returns:

The task kind

getState

public java.lang.String getState()

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

Returns:

The submission state

delete

public void delete()
            throws java.io.IOException,
                   com.google.gdata.util.ServiceException

Overrides:

delete in class com.google.gdata.data.BaseEntry<TaskEntry>

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

getDocumentLink

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

Get the task 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

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

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