com.frevvo.forms.client
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.
com.google.gdata.data.BaseEntry.AtomHandler, com.google.gdata.data.BaseEntry.EntryState
Modifier and Type | Field and Description |
---|---|
static String |
EMBED_BORDER_PARAMETER
true (default) to center the iframe in the page, or
false otherwise |
static String |
EMBED_BUTTONCLASS_N_PARAMETER
Button's css class parameter (see VALUE_BUTTONCLASS_* constants).
|
static String |
EMBED_BUTTONCLICK_N_PARAMETER
Button's onclick javascript parameter.
|
static String |
EMBED_BUTTONHREF_N_PARAMETER
Button's href parameter.
|
static String |
EMBED_BUTTONLABEL_N_PARAMETER
Button's label parameter.
|
static String |
EMBED_BUTTONTITLE_N_PARAMETER
Button's title parameter.
|
static String |
EMBED_CENTER_PARAMETER
true (default) to center the iframe in the page, or
false otherwise |
static String |
EMBED_CONTAINER_PARAMETER
true to generate a container markup to centralize the form
in the page, false (default) otherwise |
static String |
EMBED_EXT_SUBMIT_PARAMETER
true to generate JS in the outer page that you can call
to submit the form, false (default) otherwise. |
static 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 String |
EMBED_ID_PARAMETER
Override the iframe id attribute (defaults to
frevvo-form
allowing more than on form embedded in the same page |
static 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 String |
EMBED_SCROLLING_PARAMETER
auto (default) to automatically show scrollbars if required. |
static 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 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 String |
FORMTYPE_DATA_PARAMETER
A
java.util.Map containing control names/values used to
initialize the form |
static String |
FORMTYPE_DOCACTIONSYNC_PARAMETER
true (default) to perform the document action synchronously,
false otherwise |
static String |
FORMTYPE_DOCACTIONURL_PARAMETER
The url used to send the form documents.
|
static String |
FORMTYPE_ENTRY_URL_FORMAT |
static String |
FORMTYPE_ERRORACTIONTARGET_PARAMETER
The target frame to be redirected to the error action url: use with
EMBED_ERRORACTIONURL_PARAMETER |
static String |
FORMTYPE_ERRORACTIONURL_PARAMETER
The url used to redirect the browser when there are doc action errors
submitting the form.
|
static String |
FORMTYPE_FORMACTIONDOCS_PARAMETER
true any form action will be ignored and the document set (including attachments) will be returned when the form is submitted. |
static String |
FORMTYPE_FORMACTIONMETHOD_PARAMETER
The target frame to be redirected to the form action url: use with
EMBED_FORMACTIONMETHOD_PARAMETER |
static String |
FORMTYPE_FORMACTIONTARGET_PARAMETER
The target frame to be redirected to the form action url: use with
EMBED_FORMACTIONTARGET_PARAMETER |
static String |
FORMTYPE_FORMACTIONURL_PARAMETER
The url used to redirect the browser after the form designer is
finished/cancelled or the form submitted.
|
static String |
FORMTYPE_LOCALE_PARAMETER
The locale
|
static String |
FORMTYPE_ONINIT_PARAMETER
The Javascript function name to be called before the form is initialized
|
static String |
FORMTYPE_ONSUBMIT_PARAMETER
The Javascript function name to be called after the form is submitted
|
static String |
FORMTYPE_READONLY_PARAMETER
true to render the form in read-only mode,
false false otherwise |
static String |
FORMTYPE_SAVESUBMISSION_PARAMETER
true default. |
static String |
FORMTYPE_SHOW_PALETTE_PARAMETER
false to render the form without the standard/custom palettes. |
static String |
FORMTYPE_THEME_PARAMETER
The theme id or name used to override the theme set in the form of
application
|
static String |
FORMTYPE_TZ_PARAMETER
The time zone
|
static String |
REL_CONTROLTYPE |
static String |
REL_DESIGNER |
static String |
REL_DOCUMENTTYPES |
static String |
REL_FORM |
static String |
REL_FORM_INSTANCES |
static String |
REL_FORM_POPUP |
static String |
REL_LOCALES |
static String |
REL_SCHEMA |
static String |
REL_SNAPSHOT |
static String |
REL_SUBMISSIONS |
static String |
VALUE_BUTTONCLASS_EDIT
Pre-defined styling for an edit button
|
static String |
VALUE_BUTTONCLASS_REMOVE
Pre-defined styling for a remove button
|
static String |
VALUE_FORMACTIONTARGET_CLOSE
Closes the current frame
|
static String |
VALUE_FORMACTIONTARGET_FRAME
Redirects the current form frame
|
static String |
VALUE_FORMACTIONTARGET_PARENT
Redirects the parent frame
|
static String |
VALUE_FORMACTIONTARGET_TOP
Redirects the top frame of the browser
|
static String |
VALUE_RESIZE_FALSE
Turn auto resize off
|
static String |
VALUE_RESIZE_HORIZONTAL
Turn auto resize on horizontally only
|
static String |
VALUE_RESIZE_TRUE
Turn auto resize on
|
static String |
VALUE_RESIZE_VERTICAL
Turn auto resize on vertically only
|
Constructor and Description |
---|
FormTypeEntry()
Constructs a new Entry instance
|
Modifier and Type | Method and Description |
---|---|
com.google.gdata.data.media.MediaSource |
createAttachmentSource(String controlName,
String fileName,
InputStream is,
String contentType)
Create a new attachment source that can be used to instantiate a form
and initialize an Upload control (See
|
com.google.gdata.data.media.MediaSource |
createDocumentSource(String name,
InputStream is)
Create a new XML Document Source that can be used to instantiate a form
and initialize it with XML (See
|
FormEntry |
createEditInstance(Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents)
Create a new edit mode instance
|
FormEntry |
createFormEntry(Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents)
Deprecated.
Use
FormTypeEntry.createInstance instead. |
URL |
createFormInstance(FormsService myService,
Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents) |
URL |
createFormInstance(FormsService myService,
Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents,
String authHeader,
List<org.apache.commons.httpclient.Cookie> cookies) |
URL |
createFormInstance(Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents)
Creates a new Form instance and returns the raw instance URL
|
URL |
createFormInstance(Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents,
String authHeader,
List<org.apache.commons.httpclient.Cookie> cookies) |
URL |
createFormInstanceEmbed(Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents)
Creates a new Form instance and returns the embed instance URL
|
FormEntry |
createInstance(Map<String,Object> linkParams)
Create a new use mode instance
|
FormEntry |
createInstance(Map<String,Object> linkParams,
Collection<com.google.gdata.data.media.MediaSource> documents)
Create a new use mode instance
|
FormEntryBuilder |
createInstanceBuilder() |
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.
|
FormFeed |
getEditingFormFeed() |
String |
getElementName() |
static URL |
getEntryURL(URL baseUrl,
String id)
Gets an URL for accessing an FormType entry
|
static URL |
getEntryURL(URL baseUrl,
String id,
boolean full)
Get the formtype entry URL
|
FormFeed |
getFormFeed() |
com.google.gdata.data.Link |
getFormFeedLink()
Get the link to the form feed (entries are instances of this formType)
|
com.google.gdata.data.Link |
getFormTypeEditorEmbedLink(Map<String,Object> linkParams)
Get the Javascript link to this
FormTypeEntry 's designer. |
com.google.gdata.data.Link |
getFormTypeEditorLink(Map<String,Object> linkParams)
Get the HTML link to this
FormTypeEntry 's designer. |
com.google.gdata.data.Link |
getFormTypeEmbedLink(Map<String,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(Map<String,Object> linkParams)
Get the HTML link to this
FormTypeEntry . |
com.google.gdata.data.Link |
getFormTypePopupLink(Map<String,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
|
String |
getKind()
Get the kind of formtype: either FLOW or FORM
|
LocaleFeed |
getLocaleFeed() |
com.google.gdata.data.Link |
getLocaleFeedLink()
Get the link to the locale feed (entries are supported locales)
|
ApplicationEntry |
getOnwerEntry()
Deprecated.
|
ApplicationEntry |
getOwnerEntry()
Get the owner ApplicationEntry for this FormTypeEntry.
|
String |
getOwnerId()
Get the id of the ApplicationEntry that owns this FormTypeEntry.
|
com.google.gdata.data.Link |
getPublicFormTypeEmbedLink(Map<String,Object> linkParams)
Get the public embed JS url for this
FormTypeEntry that can be used
to automatically generate an iframe and container markup. |
com.google.gdata.data.Link |
getPublicFormTypeLink(Map<String,Object> linkParams)
Get the HTML link to this
FormTypeEntry . |
com.google.gdata.data.Link |
getPublicFormTypePopupLink(Map<String,Object> linkParams)
Get a link to an HTML page that embeds this
FormTypeEntry . |
FormTypeEntry |
getSelf(boolean full)
Get self entry
|
FormsService |
getService() |
com.google.gdata.data.Link |
getSnapshotLink(String contentType)
Get the snapshot link for the given content type.
|
List<com.google.gdata.data.Link> |
getSnapshotLinks()
Get all available snapshot links for this entry
The actual list of images supported depends on the JRE/ImageIO libraries
installed.
|
String |
getStyle() |
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(Map<String,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(Map<String,Object> linkParams)
Get the HTML link to this
FormTypeEntry . |
String |
getTargetNamespace() |
String |
getTemplateId() |
Visibility |
getVisibility() |
boolean |
isPublic()
Deprecated.
Use getVisibility() instead
|
boolean |
isReadOnly()
Is this entry read only?
|
protected static Map<String,Object> |
normalizeParameters(Map<String,Object> linkParams)
Normalize link parameters before using them to generate urls
|
void |
setDeployState(DeployState deployState) |
void |
setElementName(String extId) |
void |
setKind(String v) |
void |
setPublic(boolean isPublic)
Deprecated.
Use getVisibility() instead
|
void |
setReadOnly(boolean readOnly)
Sets the read-only property for this entry
|
void |
setStyle(String style) |
void |
setTargetNamespace(String targetns) |
void |
setTemplateId(String templateId) |
void |
setVisibility(Visibility visibility) |
FormTypeEntry |
updateMedia(boolean arg0) |
getContentHandlerInfo, getMediaEditLink, getMediaSource, setMediaSource, setService
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, 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
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
consumeAttributes, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final String REL_FORM
public static final String REL_FORM_POPUP
public static final String REL_CONTROLTYPE
public static final String REL_DESIGNER
public static final String REL_SUBMISSIONS
public static final String REL_SCHEMA
public static final String REL_DOCUMENTTYPES
public static final String REL_SNAPSHOT
public static final String REL_FORM_INSTANCES
public static final String REL_LOCALES
public static final String FORMTYPE_ENTRY_URL_FORMAT
public static final String EMBED_EXT_SUBMIT_PARAMETER
true
to generate JS in the outer page that you can call
to submit the form, false
(default) otherwise.public static final String EMBED_CONTAINER_PARAMETER
true
to generate a container markup to centralize the form
in the page, false
(default) otherwisepublic static final 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.public static final String EMBED_SCROLLING_PARAMETER
auto
(default) to automatically show scrollbars if required.
Scrolling will be set to auto if resize is true. If you don't want scrollbars
set to 'no', if you always want scrollbars set to 'yes'.public static final String EMBED_CENTER_PARAMETER
true
(default) to center the iframe in the page, or
false
otherwisepublic static final String EMBED_BORDER_PARAMETER
true
(default) to center the iframe in the page, or
false
otherwisepublic static final String EMBED_HEIGHT_PARAMETER
false
public static final String EMBED_WIDTH_PARAMETER
false
public static final String EMBED_ID_PARAMETER
frevvo-form
allowing more than on form embedded in the same pagepublic static final String EMBED_BUTTONLABEL_N_PARAMETER
EMBED_BUTTONLABEL_N_PARAMETER+0
public static final String EMBED_BUTTONTITLE_N_PARAMETER
EMBED_BUTTONTITLE_N_PARAMETER+0
public static final String EMBED_BUTTONCLICK_N_PARAMETER
EMBED_BUTTONCLICK_N_PARAMETER+0
public static final String EMBED_BUTTONCLASS_N_PARAMETER
EMBED_BUTTONCLAS_N_PARAMETER+0
public static final String EMBED_BUTTONHREF_N_PARAMETER
EMBED_BUTTONHREF_N_PARAMETER+0
public static final String VALUE_BUTTONCLASS_EDIT
public static final String VALUE_BUTTONCLASS_REMOVE
public static final String FORMTYPE_DATA_PARAMETER
java.util.Map
containing control names/values used to
initialize the formpublic static final String FORMTYPE_THEME_PARAMETER
public static final String FORMTYPE_SHOW_PALETTE_PARAMETER
false
to render the form without the standard/custom palettes.
true
true otherwisepublic static final String FORMTYPE_CLIENTID_PARAMETER
public static final String FORMTYPE_READONLY_PARAMETER
true
to render the form in read-only mode,
false
false otherwisepublic static final String FORMTYPE_FORMACTIONDOCS_PARAMETER
true
any form action will be ignored and the document set (including attachments) will be returned when the form is submitted.
false
default. Normal form action processing is performed.public static final String FORMTYPE_SAVESUBMISSION_PARAMETER
true
default. Submission will be saved to the database.
false
Nothing will be saved to the database.public static final String FORMTYPE_FORMACTIONURL_PARAMETER
public static final String FORMTYPE_FORMACTIONTARGET_PARAMETER
EMBED_FORMACTIONTARGET_PARAMETER
public static final String FORMTYPE_FORMACTIONMETHOD_PARAMETER
EMBED_FORMACTIONMETHOD_PARAMETER
public static final String FORMTYPE_ERRORACTIONURL_PARAMETER
public static final String FORMTYPE_ERRORACTIONTARGET_PARAMETER
EMBED_ERRORACTIONURL_PARAMETER
public static final String FORMTYPE_DOCACTIONURL_PARAMETER
public static final String FORMTYPE_DOCACTIONSYNC_PARAMETER
true
(default) to perform the document action synchronously,
false
otherwisepublic static final String FORMTYPE_ONINIT_PARAMETER
public static final String FORMTYPE_ONSUBMIT_PARAMETER
public static final String FORMTYPE_TZ_PARAMETER
public static final String FORMTYPE_LOCALE_PARAMETER
public static final String VALUE_FORMACTIONTARGET_TOP
public static final String VALUE_FORMACTIONTARGET_FRAME
public static final String VALUE_FORMACTIONTARGET_PARENT
public static final String VALUE_FORMACTIONTARGET_CLOSE
public static final String VALUE_RESIZE_TRUE
public static final String VALUE_RESIZE_HORIZONTAL
public static final String VALUE_RESIZE_VERTICAL
public static final String VALUE_RESIZE_FALSE
public static URL getEntryURL(URL baseUrl, String id) throws MalformedURLException
id
- the theme entry idMalformedURLException
public static URL getEntryURL(URL baseUrl, String id, boolean full) throws MalformedURLException
baseUrl
- The base urlid
- The formTypeEntry idfull
- Whether full metadata needs to be returnedMalformedURLException
protected static Map<String,Object> normalizeParameters(Map<String,Object> linkParams)
linkParams
- The link parameters you want to normalizepublic void declareExtensions(com.google.gdata.data.ExtensionProfile extProfile)
declareExtensions
in interface com.google.gdata.data.Kind.Adaptor
declareExtensions
in class com.google.gdata.data.ExtensionPoint
public FormsService getService()
getService
in class com.google.gdata.data.BaseEntry<FormTypeEntry>
public String getKind()
getKind
in interface com.google.gdata.data.IAtom
getKind
in class com.google.gdata.data.BaseEntry<FormTypeEntry>
public void setKind(String v)
setKind
in interface com.google.gdata.data.IAtom
setKind
in class com.google.gdata.data.BaseEntry<FormTypeEntry>
public FormTypeEntry getSelf(boolean full) throws IOException, com.google.gdata.util.ServiceException
full
- Whether to include full metadata including keysFormTypeEntry
refreshed from the serverIOException
com.google.gdata.util.ServiceException
public com.google.gdata.data.Link getFormTypeEditorLink(Map<String,Object> linkParams) throws com.google.gdata.util.ServiceException
FormTypeEntry
's designer.linkParams
- The parameters used to customize the link to the designercom.google.gdata.util.ServiceException
public com.google.gdata.data.Link getFormTypeEditorEmbedLink(Map<String,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}"/>
linkParams
- The parameters used to customize the embed url (see
EMBED_*_PARAMETERS constants)public com.google.gdata.data.Link getFormTypeLink(Map<String,Object> linkParams) throws com.google.gdata.util.ServiceException
FormTypeEntry
.linkParams
- The parameters used to customize the link to the formFormTypeEntry
's formcom.google.gdata.util.ServiceException
public com.google.gdata.data.Link getFormTypePopupLink(Map<String,Object> linkParams) throws com.google.gdata.util.ServiceException
FormTypeEntry
.linkParams
- The parameters used to customize the link to the formFormTypeEntry
's formcom.google.gdata.util.ServiceException
public com.google.gdata.data.Link getFormTypeEmbedLink(Map<String,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}"/>
linkParams
- The parameters used to customize the embed url (see
EMBED_*_PARAMETERS constants)public com.google.gdata.data.Link getFormFeedLink() throws com.google.gdata.util.ServiceException
linkParams
- com.google.gdata.util.ServiceException
public FormFeed getFormFeed() throws MalformedURLException, IOException, com.google.gdata.util.ServiceException
MalformedURLException
IOException
com.google.gdata.util.ServiceException
public FormFeed getEditingFormFeed() throws MalformedURLException, IOException, com.google.gdata.util.ServiceException
MalformedURLException
IOException
com.google.gdata.util.ServiceException
public com.google.gdata.data.Link getLocaleFeedLink() throws com.google.gdata.util.ServiceException
linkParams
- com.google.gdata.util.ServiceException
public LocaleFeed getLocaleFeed() throws MalformedURLException, IOException, com.google.gdata.util.ServiceException
MalformedURLException
IOException
com.google.gdata.util.ServiceException
public com.google.gdata.data.Link getSubmissionsLink(Map<String,Object> linkParams) throws com.google.gdata.util.ServiceException
FormTypeEntry
.linkParams
- The parameters used to customize the link to the formFormTypeEntry
's formcom.google.gdata.util.ServiceException
public com.google.gdata.data.Link getSubmissionsEmbedLink(Map<String,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:
linkParams
- The parameters used to customize the embed url (see
EMBED_*_PARAMETERS constants)public com.google.gdata.data.Link getSubmissionFeedLink()
Get the SubmissionFeed link for submissions for this FormType.
Invoking this method will not hit the server.
public SubmissionFeed getSubmissionFeed() throws MalformedURLException, IOException, com.google.gdata.util.ServiceException
Get the SubmissionFeed for this entry.
Invoking this method will hit the server.
IOException
com.google.gdata.util.ServiceException
MalformedURLException
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
public com.google.gdata.data.Link getControlTypeFeedLink()
Get the ControlTypeFeed link owned by this FormType.
Invoking this method will not hit the server.
public ControlTypeFeed getControlTypeFeed() throws MalformedURLException, IOException, com.google.gdata.util.ServiceException
Get the ControlTypeFeed owned by this FormTypeEntry.
Invoking this method will hit the server.
IOException
com.google.gdata.util.ServiceException
MalformedURLException
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.
public DocumentTypeFeed getDocumentTypeFeed() throws MalformedURLException, IOException, com.google.gdata.util.ServiceException
Get the DocumentTypeFeed owned by this entry.
Invoking this method will hit the server.
IOException
com.google.gdata.util.ServiceException
MalformedURLException
public List<com.google.gdata.data.Link> getSnapshotLinks()
public com.google.gdata.data.Link getSnapshotLink(String contentType)
contentType
- The type of snapshot (see getSnapshotLinks()
for
sample valuespublic boolean isReadOnly()
public void setReadOnly(boolean readOnly)
readOnly
- public String getTemplateId()
public void setTemplateId(String templateId)
public String getElementName()
public void setElementName(String extId)
public String getOwnerId()
public ApplicationEntry getOwnerEntry() throws com.google.gdata.util.ServiceException, IOException
com.google.gdata.util.ServiceException
IOException
public ApplicationEntry getOnwerEntry() throws com.google.gdata.util.ServiceException, IOException
com.google.gdata.util.ServiceException
IOException
public KeysExtension getKeys()
public DeployState getDeployState()
public void setDeployState(DeployState deployState)
public String getTargetNamespace()
public void setTargetNamespace(String targetns)
public Visibility getVisibility()
public void setVisibility(Visibility visibility)
public String getStyle()
public void setStyle(String style)
public boolean isPublic()
true
is it is public, false
otherwisepublic void setPublic(boolean isPublic)
isPublic
- true
make this entry public, false
to make is privatepublic URL createFormInstance(Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents) throws com.google.gdata.util.ServiceException
linkParams
- The parameters that can be used to initialize the form
instancedocuments
- A list of XML documents that can be used to initialize the
formcom.google.gdata.util.ServiceException
public URL createFormInstance(FormsService myService, Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents) throws com.google.gdata.util.ServiceException
com.google.gdata.util.ServiceException
public URL createFormInstance(Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents, String authHeader, List<org.apache.commons.httpclient.Cookie> cookies) throws com.google.gdata.util.ServiceException
com.google.gdata.util.ServiceException
public URL createFormInstance(FormsService myService, Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents, String authHeader, List<org.apache.commons.httpclient.Cookie> cookies) throws com.google.gdata.util.ServiceException
com.google.gdata.util.ServiceException
public FormEntry createInstance(Map<String,Object> linkParams) throws com.google.gdata.util.ServiceException
linkParams
- com.google.gdata.util.ServiceException
public FormEntry createInstance(Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents) throws com.google.gdata.util.ServiceException
linkParams
- documents
- com.google.gdata.util.ServiceException
public FormEntry createEditInstance(Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents) throws com.google.gdata.util.ServiceException
linkParams
- documents
- com.google.gdata.util.ServiceException
@Deprecated public FormEntry createFormEntry(Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents) throws com.google.gdata.util.ServiceException
FormTypeEntry.createInstance
instead.linkParams
- documents
- com.google.gdata.util.ServiceException
public URL createFormInstanceEmbed(Map<String,Object> linkParams, Collection<com.google.gdata.data.media.MediaSource> documents) throws com.google.gdata.util.ServiceException
linkParams
- The parametes that can be used to initialize the form instancedocuments
- The list of XML documents that can be used to initialize the
formcom.google.gdata.util.ServiceException
public com.google.gdata.data.media.MediaSource createDocumentSource(String name, InputStream is)
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 contentpublic com.google.gdata.data.media.MediaSource createAttachmentSource(String controlName, String fileName, InputStream is, String contentType)
controlName
- The name of this MediaSource that must match the name
of an Upload control in the formis
- The input stream to the xml contentcontentType
- the content type of the attachmentpublic FormEntryBuilder createInstanceBuilder()
public FormTypeEntry updateMedia(boolean arg0) throws IOException, com.google.gdata.util.ServiceException
updateMedia
in class com.google.gdata.data.media.MediaEntry<FormTypeEntry>
IOException
com.google.gdata.util.ServiceException
public com.google.gdata.data.Link getPublicFormTypeLink(Map<String,Object> linkParams) throws com.google.gdata.util.ServiceException
FormTypeEntry
.
This is only relevant when using Container SecurityManager's tenants.
linkParams
- The parameters used to customize the link to the formFormTypeEntry
's formcom.google.gdata.util.ServiceException
public com.google.gdata.data.Link getPublicFormTypePopupLink(Map<String,Object> linkParams) throws com.google.gdata.util.ServiceException
FormTypeEntry
.
This is only relevant when using Container SecurityManager's tenants.
linkParams
- The parameters used to customize the link to the formFormTypeEntry
's formcom.google.gdata.util.ServiceException
public com.google.gdata.data.Link getPublicFormTypeEmbedLink(Map<String,Object> linkParams)
Get the public embed JS url for this FormTypeEntry
that can be used
to automatically generate an iframe and container markup.
This is only relevant when using Container SecurityManager's tenants.
Next is an example of how this link href should be used in an html page:
<script language="JavaScript" type="text/javascript" src="{EMBEDLINK}"/>
linkParams
- The parameters used to customize the embed url (see
EMBED_*_PARAMETERS constants)Copyright © 2006–2015 frevvo Inc. All rights reserved.