org.jivesoftware.smackx.pubsub.form

Class FillableConfigureForm

java.lang.Object

org.jivesoftware.smackx.xdata.form.FilledForm

org.jivesoftware.smackx.xdata.form.FillableForm

org.jivesoftware.smackx.pubsub.form.FillableConfigureForm

All Implemented Interfaces:

ConfigureFormReader, FormReader

public class FillableConfigureForm
extends FillableForm
implements ConfigureFormReader

Field Summary

Fields inherited from class org.jivesoftware.smackx.xdata.form.FilledForm

formTypeFormField

Fields inherited from interface org.jivesoftware.smackx.pubsub.form.ConfigureFormReader

FORM_TYPE

Method Summary

Modifier and Type	Method and Description
void	setAccessModel(AccessModel accessModel) Sets the value of access model.
void	setBodyXSLT(java.lang.String bodyXslt) Set the URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.
void	setChildren(java.util.List<java.lang.String> children) Set the list of child node ids that are associated with a collection node.
void	setChildrenAssociationPolicy(ChildrenAssociationPolicy policy) Sets the policy that determines who may associate children with the node.
void	setChildrenAssociationWhitelist(java.util.List<? extends org.jxmpp.jid.Jid> whitelist) Set the JID's in the whitelist of users that can associate child nodes with the collection node.
void	setChildrenMax(int max) Set the maximum number of child nodes that can be associated with a collection node.
void	setCollection(java.lang.String collection) Sets the collection node which the node is affiliated with.
void	setCollections(java.util.Collection<java.lang.String> collections)
void	setDataformXSLT(java.net.URL url) Sets the URL of an XSL transformation which can be applied to the payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine.
void	setDataType(java.lang.CharSequence type) Sets the type of node data, usually specified by the namespace of the payload (if any).
void	setDeliverPayloads(boolean deliver) Sets whether the node will deliver payloads with event notifications.
void	setItemReply(ItemReply reply) Sets who should get the replies to items.
void	setMaxItems(int max) Set the maximum number of items to persisted to this node if ConfigureFormReader.isPersistItems() is true.
void	setMaxPayloadSize(int max) Sets the maximum payload size in bytes.
void	setNodeType(NodeType type) Sets the node type.
void	setNotificationType(NotificationType notificationType) Sets the NotificationType for the node.
void	setNotifyConfig(boolean notify) Sets whether subscribers should be notified when the configuration changes.
void	setNotifyDelete(boolean notify) Sets whether subscribers should be notified when the node is deleted.
void	setNotifyRetract(boolean notify) Sets whether subscribers should be notified when items are deleted from the node.
void	setPersistentItems(boolean persist) Sets whether items should be persisted in the node.
void	setPresenceBasedDelivery(boolean presenceBased) Sets whether to deliver notifications to available users only.
void	setPublishModel(PublishModel publish) Sets the publishing model for the node, which determines who may publish to it.
void	setRosterGroupsAllowed(java.util.List<? extends java.lang.CharSequence> groups) Sets the roster groups that are allowed to subscribe and retrieve items.
void	setSubscribe(boolean subscribe) Sets whether subscriptions are allowed.
void	setTitle(java.lang.CharSequence title) Sets a human readable title for the node.

Methods inherited from class org.jivesoftware.smackx.xdata.form.FillableForm

getDataFormToSubmit, getField, setAnswer, setAnswer, setAnswer, setAnswer, write, write, write, writeBoolean, writeListMulti, writeTextSingle

Methods inherited from class org.jivesoftware.smackx.xdata.form.FilledForm

ensureFormType, getDataForm, getFieldOrThrow, getFormType, getInstructions, getTitle, hasField

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smackx.pubsub.form.ConfigureFormReader

getAccessModel, getBodyXSLT, getChildren, getChildrenAssociationPolicy, getChildrenAssociationWhitelist, getChildrenMax, getCollection, getDataformXSLT, getDataType, getItemReply, getMaxItems, getMaxPayloadSize, getNodeType, getNotificationType, getPublishModel, getRosterGroupsAllowed, getTitle, isDeliverPayloads, isNotifyConfig, isNotifyDelete, isNotifyRetract, isPersistItems, isPresenceBasedDelivery, isSubscribe

Methods inherited from interface org.jivesoftware.smackx.xdata.form.FormReader

getField, readBoolean, readDate, readFirstValue, readInteger, readStringValues, readValues

Method Detail

setAccessModel

public void setAccessModel(AccessModel accessModel)

Sets the value of access model.

Parameters:

accessModel - TODO javadoc me please

setBodyXSLT

public void setBodyXSLT(java.lang.String bodyXslt)

Set the URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.

Parameters:

bodyXslt - The URL of an XSL

setChildren

public void setChildren(java.util.List<java.lang.String> children)

Set the list of child node ids that are associated with a collection node.

Parameters:

children - TODO javadoc me please

setChildrenAssociationPolicy

public void setChildrenAssociationPolicy(ChildrenAssociationPolicy policy)

Sets the policy that determines who may associate children with the node.

Parameters:

policy - The policy being set

setChildrenAssociationWhitelist

public void setChildrenAssociationWhitelist(java.util.List<? extends org.jxmpp.jid.Jid> whitelist)

Set the JID's in the whitelist of users that can associate child nodes with the collection node. This is only relevant if ConfigureFormReader.getChildrenAssociationPolicy() is set to ChildrenAssociationPolicy.whitelist.

Parameters:

whitelist - The list of JID's

setChildrenMax

public void setChildrenMax(int max)

Set the maximum number of child nodes that can be associated with a collection node.

Parameters:

max - The maximum number of child nodes.

setCollection

public void setCollection(java.lang.String collection)

Sets the collection node which the node is affiliated with.

Parameters:

collection - The node id of the collection node

setCollections

public void setCollections(java.util.Collection<java.lang.String> collections)

setDataformXSLT

public void setDataformXSLT(java.net.URL url)

Sets the URL of an XSL transformation which can be applied to the payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine.

Parameters:

url - The URL of an XSL transformation

setDeliverPayloads

public void setDeliverPayloads(boolean deliver)

Sets whether the node will deliver payloads with event notifications.

Parameters:

deliver - true if the payload will be delivered, false otherwise

setItemReply

public void setItemReply(ItemReply reply)

Sets who should get the replies to items.

Parameters:

reply - Defines who should get the reply

setMaxItems

public void setMaxItems(int max)

Set the maximum number of items to persisted to this node if ConfigureFormReader.isPersistItems() is true.

Parameters:

max - The maximum number of items to persist

setMaxPayloadSize

public void setMaxPayloadSize(int max)

Sets the maximum payload size in bytes.

Parameters:

max - The maximum payload size

setNodeType

public void setNodeType(NodeType type)

Sets the node type.

Parameters:

type - The node type

setNotifyConfig

public void setNotifyConfig(boolean notify)

Sets whether subscribers should be notified when the configuration changes.

Parameters:

notify - true if subscribers should be notified, false otherwise

setNotifyDelete

public void setNotifyDelete(boolean notify)

Sets whether subscribers should be notified when the node is deleted.

Parameters:

notify - true if subscribers should be notified, false otherwise

setNotifyRetract

public void setNotifyRetract(boolean notify)

Sets whether subscribers should be notified when items are deleted from the node.

Parameters:

notify - true if subscribers should be notified, false otherwise

setNotificationType

public void setNotificationType(NotificationType notificationType)

Sets the NotificationType for the node.

Parameters:

notificationType - The enum representing the possible options

Since:

4.3

setPersistentItems

public void setPersistentItems(boolean persist)

Sets whether items should be persisted in the node.

Parameters:

persist - true if items should be persisted, false otherwise

setPresenceBasedDelivery

public void setPresenceBasedDelivery(boolean presenceBased)

Sets whether to deliver notifications to available users only.

Parameters:

presenceBased - true if user must be available, false otherwise

setPublishModel

public void setPublishModel(PublishModel publish)

Sets the publishing model for the node, which determines who may publish to it.

Parameters:

publish - The enum representing the possible options for the publishing model

setRosterGroupsAllowed

public void setRosterGroupsAllowed(java.util.List<? extends java.lang.CharSequence> groups)

Sets the roster groups that are allowed to subscribe and retrieve items.

Parameters:

groups - The roster groups

setSubscribe

public void setSubscribe(boolean subscribe)

Sets whether subscriptions are allowed.

Parameters:

subscribe - true if they are, false otherwise

setTitle

public void setTitle(java.lang.CharSequence title)

Sets a human readable title for the node.

Parameters:

title - The node title

setDataType

public void setDataType(java.lang.CharSequence type)

Sets the type of node data, usually specified by the namespace of the payload (if any).

Parameters:

type - The type of node data