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:

Extension, IAtom, IEntry, Kind.Adaptable, Kind.Adaptor

public class TaskEntry
extends 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

BaseEntry.AtomHandler, BaseEntry.EntryState

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

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

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

AbstractExtension.AttributesHandler

Field Summary

static String	REL_PARENTTASK
static String	REL_TASK
static 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

URL	createFormInstance(Map<String,Object> linkParams, List<MediaSource> documents) Creates a new Form instance and returns the raw instance URL
void	declareExtensions(ExtensionProfile extProfile)
List<Link>	getDocumentLink(String contentType) Get the task documents filtered by content type
static URL	getEntryURL(URL baseUrl, String id) Gets an URL for accessing an FormType entry
Link	getFormTypeEmbedLink(Map<String,Object> linkParams) Get the embed JS url for the FormType that can edit this submission
Link	getFormTypeLink(Map<String,Object> linkParams) Get the HTML link to this FormTypeEntry.
Link	getFormTypePopupLink(Map<String,Object> linkParams) Get a link to an HTML page that embeds this FormTypeEntry.
KeysExtension	getKeys() Get the keys associated with this submission
String	getKind() Get the kind of task: either FLOW or FORM
String	getState() Get the state for this submission: either SAVED, PENDING or SUBMITTED, ...
void	setResetToStep(String activityName)

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

addAdaptor, addHtmlLink, addLink, addLink, delete, 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 String REL_TASK

See Also:

Constant Field Values

REL_PARENTTASK

public static final String REL_PARENTTASK

See Also:

Constant Field Values

TASK_ENTRY_URL_FORMAT

public static final 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 URL getEntryURL(URL baseUrl,
                              String id)
                       throws MalformedURLException

Gets an URL for accessing an FormType entry

Parameters:

id - the theme entry id

Returns:

The entry URL

Throws:

MalformedURLException

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)

Specified by:

declareExtensions in interface Kind.Adaptor

Overrides:

declareExtensions in class ExtensionPoint

setResetToStep

public void setResetToStep(String activityName)

getKind

public String getKind()

Get the kind of task: either FLOW or FORM

Specified by:

getKind in interface IAtom

Overrides:

getKind in class BaseEntry<TaskEntry>

Returns:

The task kind

getState

public String getState()

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

Returns:

The submission state

getKeys

public KeysExtension getKeys()

Get the keys associated with this submission

Returns:

The Keys for this submission

getDocumentLink

public List<Link> getDocumentLink(String contentType)

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 Link getFormTypeLink(Map<String,Object> linkParams)
                     throws 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:

ServiceException

createFormInstance

public URL createFormInstance(Map<String,Object> linkParams,
                              List<MediaSource> documents)
                       throws 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:

ServiceException

getFormTypePopupLink

public Link getFormTypePopupLink(Map<String,Object> linkParams)
                          throws 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:

ServiceException

getFormTypeEmbedLink

public Link getFormTypeEmbedLink(Map<String,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