com.frevvo.forms.client
Class FormTypeEntry

java.lang.Object
  extended by com.google.gdata.data.AbstractExtension
      extended by com.google.gdata.data.ExtensionPoint
          extended by com.google.gdata.data.BaseEntry<E>
              extended by com.google.gdata.data.media.MediaEntry<FormTypeEntry>
                  extended by com.frevvo.forms.client.FormTypeEntry
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, com.google.gdata.data.media.IMediaEntry

public class FormTypeEntry
extends com.google.gdata.data.media.MediaEntry<FormTypeEntry>

This entry represents a single FormType created by a user. It is also always owned/contained by an ApplicationEntry.

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 EMBED_BORDER_PARAMETER
          true (default) to center the iframe in the page, or false otherwise
static java.lang.String EMBED_BUTTONCLASS_N_PARAMETER
          Button's css class parameter (see VALUE_BUTTONCLASS_* constants).
static java.lang.String EMBED_BUTTONCLICK_N_PARAMETER
          Button's onclick javascript parameter.
static java.lang.String EMBED_BUTTONHREF_N_PARAMETER
          Button's href parameter.
static java.lang.String EMBED_BUTTONLABEL_N_PARAMETER
          Button's label parameter.
static java.lang.String EMBED_BUTTONTITLE_N_PARAMETER
          Button's title parameter.
static java.lang.String EMBED_CENTER_PARAMETER
          true (default) to center the iframe in the page, or false otherwise
static java.lang.String EMBED_CONTAINER_PARAMETER
          true to generate a container markup to centralize the form in the page, false (default) otherwise
static java.lang.String EMBED_HEIGHT_PARAMETER
          The initial height (defaults to the height set in the form or 600px otherwise) for the iframe; useful when EMBED_RESIZE_PARAMETER is set to false
static java.lang.String EMBED_ID_PARAMETER
          Override the iframe id attribute (defaults to frevvo-form allowing more than on form embedded in the same page
static java.lang.String EMBED_RESIZE_PARAMETER
          true (default) to auto resize the iframe when the form or form designer changes its height or width, false to disable it, 'vert' for vertical resize only and 'horz' for horizontal resize.
static java.lang.String EMBED_WIDTH_PARAMETER
          The initial witdh (defaults to the width set in the form or 600px otherwise) for the iframe; useful when EMBED_RESIZE_PARAMETER is set to false
static java.lang.String FORMTYPE_CLIENTID_PARAMETER
          The client id that is going to be associated with the new instance created; if an instance already exist it will be reused instead of creating a new one
static java.lang.String FORMTYPE_DATA_PARAMETER
          A java.util.Map containing control names/values used to initialize the form
static java.lang.String FORMTYPE_DOCACTIONSYNC_PARAMETER
          true (default) to perform the document action synchronously, false otherwise
static java.lang.String FORMTYPE_DOCACTIONURL_PARAMETER
          The url used to send the form documents.
static java.lang.String FORMTYPE_ENTRY_URL_FORMAT
           
static java.lang.String FORMTYPE_ERRORACTIONTARGET_PARAMETER
          The target frame to be redirected to the error action url: use with EMBED_ERRORACTIONURL_PARAMETER
static java.lang.String FORMTYPE_ERRORACTIONURL_PARAMETER
          The url used to redirect the browser when there are doc action errors submitting the form.
static java.lang.String FORMTYPE_FORMACTIONMETHOD_PARAMETER
          The target frame to be redirected to the form action url: use with EMBED_FORMACTIONMETHOD_PARAMETER
static java.lang.String FORMTYPE_FORMACTIONTARGET_PARAMETER
          The target frame to be redirected to the form action url: use with EMBED_FORMACTIONTARGET_PARAMETER
static java.lang.String FORMTYPE_FORMACTIONURL_PARAMETER
          The url used to redirect the browser after the form designer is finished/cancelled or the form submitted.
static java.lang.String FORMTYPE_LOCALE_PARAMETER
          The locale
static java.lang.String FORMTYPE_ONINIT_PARAMETER
          The Javascript function name to be called before the form is initialized
static java.lang.String FORMTYPE_ONSUBMIT_PARAMETER
          The Javascript function name to be called after the form is submitted
static java.lang.String FORMTYPE_READONLY_PARAMETER
          true to render the form in read-only mode, false false otherwise
static java.lang.String FORMTYPE_THEME_PARAMETER
          The theme id or name used to override the theme set in the form of application
static java.lang.String REL_CONTROLTYPE
           
static java.lang.String REL_DESIGNER
           
static java.lang.String REL_DOCUMENTTYPES
           
static java.lang.String REL_FORM
           
static java.lang.String REL_FORM_POPUP
           
static java.lang.String REL_SCHEMA
           
static java.lang.String REL_SNAPSHOT
           
static java.lang.String REL_SUBMISSIONS
           
static java.lang.String VALUE_BUTTONCLASS_EDIT
          Pre-defined styling for an edit button
static java.lang.String VALUE_BUTTONCLASS_REMOVE
          Pre-defined styling for a remove button
static java.lang.String VALUE_FORMACTIONTARGET_CLOSE
          Closes the current frame
static java.lang.String VALUE_FORMACTIONTARGET_FRAME
          Redirects the current form frame
static java.lang.String VALUE_FORMACTIONTARGET_PARENT
          Redirects the parent frame
static java.lang.String VALUE_FORMACTIONTARGET_TOP
          Redirects the top frame of the browser
static java.lang.String VALUE_RESIZE_FALSE
          Turn auto resize off
static java.lang.String VALUE_RESIZE_HORIZONTAL
          Turn auto resize on horizontally only
static java.lang.String VALUE_RESIZE_TRUE
          Turn auto resize on
static java.lang.String VALUE_RESIZE_VERTICAL
          Turn auto resize on vertically only
 
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
FormTypeEntry()
          Constructs a new Entry instance
 
Method Summary
 com.google.gdata.data.media.MediaSource createAttachmentSource(java.lang.String controlName, java.lang.String fileName, java.io.InputStream is, java.lang.String contentType)
          Create a new attachment source that can be used to instantiate a form and initialize an Upload control (See createformInstance).
 com.google.gdata.data.media.MediaSource createDocumentSource(java.lang.String name, java.io.InputStream is)
          Create a new XML Document Source that can be used to instantiate a form and initialize it with XML (See createformInstance).
 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)
           
 ControlTypeFeed getControlTypeFeed()
           Get the ControlTypeFeed owned by this FormTypeEntry.
 com.google.gdata.data.Link getControlTypeFeedLink()
           Get the ControlTypeFeed link owned by this FormType.
 DeployState getDeployState()
           
 DocumentTypeFeed getDocumentTypeFeed()
           Get the DocumentTypeFeed owned by this entry.
 com.google.gdata.data.Link getDocumentTypeFeedLink()
           Get the DocumentTypeFeed link owned by this entry.
static java.net.URL getEntryURL(java.net.URL baseUrl, java.lang.String id)
          Gets an URL for accessing an FormType entry
static java.net.URL getEntryURL(java.net.URL baseUrl, java.lang.String id, boolean full)
          Get the formtype entry URL
 com.google.gdata.data.Link getFormTypeEditorEmbedLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
           Get the Javascript link to this FormTypeEntry's designer.
 com.google.gdata.data.Link getFormTypeEditorLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
          Get the HTML link to this FormTypeEntry's designer.
 com.google.gdata.data.Link getFormTypeEmbedLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
           Get the embed JS url for this FormTypeEntry that can be used to automatically generate an iframe and container markup.
 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.data.Link getFormTypeSchemaLink()
           Get the XML Schema for the FormType.
 KeysExtension getKeys()
          Get the keys associated with this submission
 java.lang.String getKind()
          Get the kind of formtype: either FLOW or FORM
 ApplicationEntry getOnwerEntry()
          Get the owner ApplicationEntry for this FormTypeEntry.
 java.lang.String getOwnerId()
          Get the id of the ApplicationEntry that owns this FormTypeEntry.
 FormTypeEntry getSelf(boolean full)
          Get self entry
 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
 SubmissionFeed getSubmissionFeed()
           Get the SubmissionFeed for this entry.
 com.google.gdata.data.Link getSubmissionFeedLink()
           Get the SubmissionFeed link for submissions for this FormType.
 com.google.gdata.data.Link getSubmissionsEmbedLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
           Get the submissions embed JS url for this FormTypeEntry that can be used to automatically generate an iframe and container markup showing submissions for this form.
 com.google.gdata.data.Link getSubmissionsLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
          Get the HTML link to this FormTypeEntry.
 java.lang.String getTemplateId()
           
 Visibility getVisibility()
           
 boolean isPublic()
          Deprecated. Use getVisibility() instead
 boolean isReadOnly()
          Is this entry read only?
protected static java.util.Map<java.lang.String,java.lang.Object> normalizeParameters(java.util.Map<java.lang.String,java.lang.Object> linkParams)
          Normalize link parameters before using them to generate urls
 void setDeployState(DeployState deployState)
           
 void setKind(java.lang.String v)
           
 void setPublic(boolean isPublic)
          Deprecated. Use getVisibility() instead
 void setReadOnly(boolean readOnly)
          Sets the read-only property for this entry
 void setTemplateId(java.lang.String templateId)
           
 void setVisibility(Visibility visibility)
           
 FormTypeEntry updateMedia(boolean arg0)
           
 
Methods inherited from class com.google.gdata.data.media.MediaEntry
getContentHandlerInfo, getMediaEditLink, getMediaSource, setMediaSource, setService
 
Methods inherited from class com.google.gdata.data.BaseEntry
addAdaptor, addHtmlLink, addLink, addLink, delete, generate, generateAtom, generateRss, getAdaptedEntry, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContributors, getEdited, getEditLink, getEtag, getHandler, getHtmlLink, getId, getLink, getLinks, getLinks, 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, setPubControl, setPublished, setRights, 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
 
Methods inherited from interface com.google.gdata.data.IEntry
getCanEdit, getContent, getEdited, getEditLink, getPublished, getSummary, setCanEdit, setEdited, setPublished
 
Methods inherited from interface com.google.gdata.data.IAtom
addLink, getAuthors, getCategories, getEtag, getId, getLink, getLinks, getSelfLink, getTitle, getUpdated, getVersionId, removeLinks, removeLinks, setEtag, setId, setUpdated, setVersionId
 

Field Detail

REL_FORM

public static final java.lang.String REL_FORM
See Also:
Constant Field Values

REL_FORM_POPUP

public static final java.lang.String REL_FORM_POPUP
See Also:
Constant Field Values

REL_CONTROLTYPE

public static final java.lang.String REL_CONTROLTYPE
See Also:
Constant Field Values

REL_DESIGNER

public static final java.lang.String REL_DESIGNER
See Also:
Constant Field Values

REL_SUBMISSIONS

public static final java.lang.String REL_SUBMISSIONS
See Also:
Constant Field Values

REL_SCHEMA

public static final java.lang.String REL_SCHEMA
See Also:
Constant Field Values

REL_DOCUMENTTYPES

public static final java.lang.String REL_DOCUMENTTYPES
See Also:
Constant Field Values

REL_SNAPSHOT

public static final java.lang.String REL_SNAPSHOT
See Also:
Constant Field Values

FORMTYPE_ENTRY_URL_FORMAT

public static final java.lang.String FORMTYPE_ENTRY_URL_FORMAT
See Also:
Constant Field Values

EMBED_CONTAINER_PARAMETER

public static final java.lang.String EMBED_CONTAINER_PARAMETER
true to generate a container markup to centralize the form in the page, false (default) otherwise

See Also:
Constant Field Values

EMBED_RESIZE_PARAMETER

public static final java.lang.String EMBED_RESIZE_PARAMETER
true (default) to auto resize the iframe when the form or form designer changes its height or width, false to disable it, 'vert' for vertical resize only and 'horz' for horizontal resize.

See Also:
Constant Field Values

EMBED_CENTER_PARAMETER

public static final java.lang.String EMBED_CENTER_PARAMETER
true (default) to center the iframe in the page, or false otherwise

See Also:
Constant Field Values

EMBED_BORDER_PARAMETER

public static final java.lang.String EMBED_BORDER_PARAMETER
true (default) to center the iframe in the page, or false otherwise

See Also:
Constant Field Values

EMBED_HEIGHT_PARAMETER

public static final java.lang.String EMBED_HEIGHT_PARAMETER
The initial height (defaults to the height set in the form or 600px otherwise) for the iframe; useful when EMBED_RESIZE_PARAMETER is set to false

See Also:
Constant Field Values

EMBED_WIDTH_PARAMETER

public static final java.lang.String EMBED_WIDTH_PARAMETER
The initial witdh (defaults to the width set in the form or 600px otherwise) for the iframe; useful when EMBED_RESIZE_PARAMETER is set to false

See Also:
Constant Field Values

EMBED_ID_PARAMETER

public static final java.lang.String EMBED_ID_PARAMETER
Override the iframe id attribute (defaults to frevvo-form allowing more than on form embedded in the same page

See Also:
Constant Field Values

EMBED_BUTTONLABEL_N_PARAMETER

public static final java.lang.String EMBED_BUTTONLABEL_N_PARAMETER
Button's label parameter. Each button is referenced by adding a consecutive integer suffix, e.g.: EMBED_BUTTONLABEL_N_PARAMETER+0

See Also:
Constant Field Values

EMBED_BUTTONTITLE_N_PARAMETER

public static final java.lang.String EMBED_BUTTONTITLE_N_PARAMETER
Button's title parameter. Each button is referenced by adding a consecutive integer suffix, e.g.: EMBED_BUTTONTITLE_N_PARAMETER+0

See Also:
Constant Field Values

EMBED_BUTTONCLICK_N_PARAMETER

public static final java.lang.String EMBED_BUTTONCLICK_N_PARAMETER
Button's onclick javascript parameter. Each button is referenced by adding a consecutive integer suffix, e.g.: EMBED_BUTTONCLICK_N_PARAMETER+0

See Also:
Constant Field Values

EMBED_BUTTONCLASS_N_PARAMETER

public static final java.lang.String EMBED_BUTTONCLASS_N_PARAMETER
Button's css class parameter (see VALUE_BUTTONCLASS_* constants). Each button is referenced by adding a consecutive integer suffix, e.g.: EMBED_BUTTONCLAS_N_PARAMETER+0

See Also:
Constant Field Values

EMBED_BUTTONHREF_N_PARAMETER

public static final java.lang.String EMBED_BUTTONHREF_N_PARAMETER
Button's href parameter. Each button is referenced by adding a consecutive integer suffix, e.g.: EMBED_BUTTONHREF_N_PARAMETER+0

See Also:
Constant Field Values

VALUE_BUTTONCLASS_EDIT

public static final java.lang.String VALUE_BUTTONCLASS_EDIT
Pre-defined styling for an edit button

See Also:
Constant Field Values

VALUE_BUTTONCLASS_REMOVE

public static final java.lang.String VALUE_BUTTONCLASS_REMOVE
Pre-defined styling for a remove button

See Also:
Constant Field Values

FORMTYPE_DATA_PARAMETER

public static final java.lang.String FORMTYPE_DATA_PARAMETER
A java.util.Map containing control names/values used to initialize the form

See Also:
Constant Field Values

FORMTYPE_THEME_PARAMETER

public static final java.lang.String FORMTYPE_THEME_PARAMETER
The theme id or name used to override the theme set in the form of application

See Also:
Constant Field Values

FORMTYPE_CLIENTID_PARAMETER

public static final java.lang.String FORMTYPE_CLIENTID_PARAMETER
The client id that is going to be associated with the new instance created; if an instance already exist it will be reused instead of creating a new one

See Also:
Constant Field Values

FORMTYPE_READONLY_PARAMETER

public static final java.lang.String FORMTYPE_READONLY_PARAMETER
true to render the form in read-only mode, false false otherwise

See Also:
Constant Field Values

FORMTYPE_FORMACTIONURL_PARAMETER

public static final java.lang.String FORMTYPE_FORMACTIONURL_PARAMETER
The url used to redirect the browser after the form designer is finished/cancelled or the form submitted. This url overides what is set in the form designer

See Also:
Constant Field Values

FORMTYPE_FORMACTIONTARGET_PARAMETER

public static final java.lang.String FORMTYPE_FORMACTIONTARGET_PARAMETER
The target frame to be redirected to the form action url: use with EMBED_FORMACTIONTARGET_PARAMETER

See Also:
Constant Field Values

FORMTYPE_FORMACTIONMETHOD_PARAMETER

public static final java.lang.String FORMTYPE_FORMACTIONMETHOD_PARAMETER
The target frame to be redirected to the form action url: use with EMBED_FORMACTIONMETHOD_PARAMETER

See Also:
Constant Field Values

FORMTYPE_ERRORACTIONURL_PARAMETER

public static final java.lang.String FORMTYPE_ERRORACTIONURL_PARAMETER
The url used to redirect the browser when there are doc action errors submitting the form.

See Also:
Constant Field Values

FORMTYPE_ERRORACTIONTARGET_PARAMETER

public static final java.lang.String FORMTYPE_ERRORACTIONTARGET_PARAMETER
The target frame to be redirected to the error action url: use with EMBED_ERRORACTIONURL_PARAMETER

See Also:
Constant Field Values

FORMTYPE_DOCACTIONURL_PARAMETER

public static final java.lang.String FORMTYPE_DOCACTIONURL_PARAMETER
The url used to send the form documents. If the url is an email address then an email with be sent, otherwise the documents will be HTTP POSTed as multipart/form-data to the url (see VALUE_FORMACTIONTARGET_* constants)

See Also:
Constant Field Values

FORMTYPE_DOCACTIONSYNC_PARAMETER

public static final java.lang.String FORMTYPE_DOCACTIONSYNC_PARAMETER
true (default) to perform the document action synchronously, false otherwise

See Also:
Constant Field Values

FORMTYPE_ONINIT_PARAMETER

public static final java.lang.String FORMTYPE_ONINIT_PARAMETER
The Javascript function name to be called before the form is initialized

See Also:
Constant Field Values

FORMTYPE_ONSUBMIT_PARAMETER

public static final java.lang.String FORMTYPE_ONSUBMIT_PARAMETER
The Javascript function name to be called after the form is submitted

See Also:
Constant Field Values

FORMTYPE_LOCALE_PARAMETER

public static final java.lang.String FORMTYPE_LOCALE_PARAMETER
The locale

See Also:
Constant Field Values

VALUE_FORMACTIONTARGET_TOP

public static final java.lang.String VALUE_FORMACTIONTARGET_TOP
Redirects the top frame of the browser

See Also:
Constant Field Values

VALUE_FORMACTIONTARGET_FRAME

public static final java.lang.String VALUE_FORMACTIONTARGET_FRAME
Redirects the current form frame

See Also:
Constant Field Values

VALUE_FORMACTIONTARGET_PARENT

public static final java.lang.String VALUE_FORMACTIONTARGET_PARENT
Redirects the parent frame

See Also:
Constant Field Values

VALUE_FORMACTIONTARGET_CLOSE

public static final java.lang.String VALUE_FORMACTIONTARGET_CLOSE
Closes the current frame

See Also:
Constant Field Values

VALUE_RESIZE_TRUE

public static final java.lang.String VALUE_RESIZE_TRUE
Turn auto resize on

See Also:
Constant Field Values

VALUE_RESIZE_HORIZONTAL

public static final java.lang.String VALUE_RESIZE_HORIZONTAL
Turn auto resize on horizontally only

See Also:
Constant Field Values

VALUE_RESIZE_VERTICAL

public static final java.lang.String VALUE_RESIZE_VERTICAL
Turn auto resize on vertically only

See Also:
Constant Field Values

VALUE_RESIZE_FALSE

public static final java.lang.String VALUE_RESIZE_FALSE
Turn auto resize off

See Also:
Constant Field Values
Constructor Detail

FormTypeEntry

public FormTypeEntry()
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

getEntryURL

public static java.net.URL getEntryURL(java.net.URL baseUrl,
                                       java.lang.String id,
                                       boolean full)
                                throws java.net.MalformedURLException
Get the formtype entry URL

Parameters:
baseUrl - The base url
id - The formTypeEntry id
full - Whether full metadata needs to be returned
Returns:
Throws:
java.net.MalformedURLException

normalizeParameters

protected static java.util.Map<java.lang.String,java.lang.Object> normalizeParameters(java.util.Map<java.lang.String,java.lang.Object> linkParams)
Normalize link parameters before using them to generate urls

Parameters:
linkParameters -
Returns:
The normalized link parameters

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 formtype: either FLOW or FORM

Specified by:
getKind in interface com.google.gdata.data.IAtom
Overrides:
getKind in class com.google.gdata.data.BaseEntry<FormTypeEntry>
Returns:
The formtype kind

setKind

public void setKind(java.lang.String v)
Specified by:
setKind in interface com.google.gdata.data.IAtom
Overrides:
setKind in class com.google.gdata.data.BaseEntry<FormTypeEntry>

getSelf

public FormTypeEntry getSelf(boolean full)
                      throws java.io.IOException,
                             com.google.gdata.util.ServiceException
Get self entry

Parameters:
full - Whether to include full metadata including keys
Returns:
Throws:
java.io.IOException
com.google.gdata.util.ServiceException

getFormTypeEditorLink

public com.google.gdata.data.Link getFormTypeEditorLink(java.util.Map<java.lang.String,java.lang.Object> linkParams)
                                                 throws com.google.gdata.util.ServiceException
Get the HTML link to this FormTypeEntry's designer.

Parameters:
linkParams - The parameters used to customize the link to the designer
Returns:
The Link to the FormTypeEntry designer
Throws:
com.google.gdata.util.ServiceException

getFormTypeEditorEmbedLink

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

Get the Javascript link to this FormTypeEntry's designer. This link can be used to automatically generate an iframe and container markup.

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 EMBED_*_PARAMETERS constants)
Returns:
The link to the designer Javascript embed code

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 this FormTypeEntry that can be used to automatically generate an iframe and container markup.

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 EMBED_*_PARAMETERS constants)
Returns:
The embed JS url

getSubmissionsLink

public com.google.gdata.data.Link getSubmissionsLink(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

getSubmissionsEmbedLink

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

Get the submissions embed JS url for this FormTypeEntry that can be used to automatically generate an iframe and container markup showing submissions for this form.

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

Parameters:
linkParams - The parameters used to customize the embed url (see EMBED_*_PARAMETERS constants)
Returns:
The embed JS url

getSubmissionFeedLink

public com.google.gdata.data.Link getSubmissionFeedLink()

Get the SubmissionFeed link for submissions for this FormType.

Invoking this method will not hit the server.

Returns:
The SubmissionFeed link

getSubmissionFeed

public SubmissionFeed getSubmissionFeed()
                                 throws java.net.MalformedURLException,
                                        java.io.IOException,
                                        com.google.gdata.util.ServiceException

Get the SubmissionFeed for this entry.

Invoking this method will hit the server.

Returns:
The SubmissionFeed
Throws:
java.io.IOException
com.google.gdata.util.ServiceException
java.net.MalformedURLException

getFormTypeSchemaLink

public com.google.gdata.data.Link getFormTypeSchemaLink()

Get the XML Schema for the FormType. This is the XML Schema that describes the from scratch document that will be submitted by the form

Returns:
The link to the XML Schema for the FormType

getControlTypeFeedLink

public com.google.gdata.data.Link getControlTypeFeedLink()

Get the ControlTypeFeed link owned by this FormType.

Invoking this method will not hit the server.

Returns:
The ControlTypeFeed link

getControlTypeFeed

public ControlTypeFeed getControlTypeFeed()
                                   throws java.net.MalformedURLException,
                                          java.io.IOException,
                                          com.google.gdata.util.ServiceException

Get the ControlTypeFeed owned by this FormTypeEntry.

Invoking this method will hit the server.

Returns:
The ControlTypeFeed
Throws:
java.io.IOException
com.google.gdata.util.ServiceException
java.net.MalformedURLException

getDocumentTypeFeedLink

public com.google.gdata.data.Link getDocumentTypeFeedLink()

Get the DocumentTypeFeed link owned by this entry. Each form always has one from scratch DocumentTypeEntry and zero or more DocumentTypeEntry's from uploaded schemas

Invoking this method will not hit the server.

Returns:
The DocumentTypeFeed link

getDocumentTypeFeed

public DocumentTypeFeed getDocumentTypeFeed()
                                     throws java.net.MalformedURLException,
                                            java.io.IOException,
                                            com.google.gdata.util.ServiceException

Get the DocumentTypeFeed owned by this entry.

Invoking this method will hit the server.

Returns:
The DocumentTypeFeed
Throws:
java.io.IOException
com.google.gdata.util.ServiceException
java.net.MalformedURLException

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

isReadOnly

public boolean isReadOnly()
Is this entry read only?

Returns:
true if read-only, false otherwise

setReadOnly

public void setReadOnly(boolean readOnly)
Sets the read-only property for this entry

Parameters:
readOnly -

getTemplateId

public java.lang.String getTemplateId()

setTemplateId

public void setTemplateId(java.lang.String templateId)

getOwnerId

public java.lang.String getOwnerId()
Get the id of the ApplicationEntry that owns this FormTypeEntry.

Returns:
The owner id

getOnwerEntry

public ApplicationEntry getOnwerEntry()
                               throws com.google.gdata.util.ServiceException,
                                      java.io.IOException
Get the owner ApplicationEntry for this FormTypeEntry.

Returns:
The ApplicationEntry
Throws:
com.google.gdata.util.ServiceException
java.io.IOException

getKeys

public KeysExtension getKeys()
Get the keys associated with this submission

Returns:
The Keys for this submission

getDeployState

public DeployState getDeployState()

setDeployState

public void setDeployState(DeployState deployState)

getVisibility

public Visibility getVisibility()

setVisibility

public void setVisibility(Visibility visibility)

isPublic

public boolean isPublic()
Deprecated. Use getVisibility() instead

Is this FormTypeEntry public?

Returns:
true is it is public, false otherwise

setPublic

public void setPublic(boolean isPublic)
Deprecated. Use getVisibility() instead

Set the visibility for this entry

Parameters:
isPublic - true make this entry public, false to make is private

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

createDocumentSource

public com.google.gdata.data.media.MediaSource createDocumentSource(java.lang.String name,
                                                                    java.io.InputStream is)
Create a new XML Document Source that can be used to instantiate a form and initialize it with XML (See createformInstance).

Parameters:
name - The name of this MediaSource. For xml documents this is irrelevant since the association with the form document type is made on the server using the xml namespace (i.e. make sure the targetNamespaces match)
is - The input stream to the xml content
Returns:
The MediaSource you can use to instantiate a form

createAttachmentSource

public com.google.gdata.data.media.MediaSource createAttachmentSource(java.lang.String controlName,
                                                                      java.lang.String fileName,
                                                                      java.io.InputStream is,
                                                                      java.lang.String contentType)
Create a new attachment source that can be used to instantiate a form and initialize an Upload control (See createformInstance).

Parameters:
controlName - The name of this MediaSource that must match the name of an Upload control in the form
is - The input stream to the xml content
contentType - the content type of the attachment
Returns:
The MediaSource you can use to instantiate a form

updateMedia

public FormTypeEntry updateMedia(boolean arg0)
                          throws java.io.IOException,
                                 com.google.gdata.util.ServiceException
Overrides:
updateMedia in class com.google.gdata.data.media.MediaEntry<FormTypeEntry>
Throws:
java.io.IOException
com.google.gdata.util.ServiceException


Copyright © 2006-2011 frevvo Inc. All Rights Reserved.