ConfigureFormReader (smack-extensions 4.4.7 API)

All Superinterfaces:

FormReader

All Known Implementing Classes:

ConfigureForm, FillableConfigureForm, FilledConfigureForm
```
public interface ConfigureFormReader
extends FormReader
```

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String FORM_TYPE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FORM_TYPE`

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default AccessModel`	`getAccessModel()` Get the currently configured `AccessModel`, null if it is not set.
`default java.lang.String`	`getBodyXSLT()` Returns the URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.
`default java.util.List<java.lang.String>`	`getChildren()` The id's of the child nodes associated with a collection node (both leaf and collection).
`default ChildrenAssociationPolicy`	`getChildrenAssociationPolicy()` Returns the policy that determines who may associate children with the node.
`default java.util.List<org.jxmpp.jid.Jid>`	`getChildrenAssociationWhitelist()` List of JID's that are on the whitelist that determines who can associate child nodes with the collection node.
`default java.lang.Integer`	`getChildrenMax()` Gets the maximum number of child nodes that can be associated with the collection node.
`default java.util.List<? extends java.lang.CharSequence>`	`getCollection()` Gets the collection node which the node is affiliated with.
`default java.lang.String`	`getDataformXSLT()` Gets 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.
`default java.lang.String`	`getDataType()` The type of node data, usually specified by the namespace of the payload (if any).
`default ItemReply`	`getItemReply()` Determines who should get replies to items.
`default java.lang.Integer`	`getMaxItems()` Gets the maximum number of items to persisted to this node if `isPersistItems()` is true.
`default java.lang.Integer`	`getMaxPayloadSize()` Gets the maximum payload size in bytes.
`default NodeType`	`getNodeType()` Gets the node type.
`default NotificationType`	`getNotificationType()` Determines the type of notifications which are sent.
`default PublishModel`	`getPublishModel()` Gets the publishing model for the node, which determines who may publish to it.
`default java.util.List<java.lang.String>`	`getRosterGroupsAllowed()` Gets the roster groups that are allowed to subscribe and retrieve items.
`default java.lang.String`	`getTitle()` Gets the human readable node title.
`default java.lang.Boolean`	`isDeliverPayloads()` Does the node deliver payloads with event notifications.
`default java.lang.Boolean`	`isNotifyConfig()` Determines if subscribers should be notified when the configuration changes.
`default java.lang.Boolean`	`isNotifyDelete()` Determines whether subscribers should be notified when the node is deleted.
`default java.lang.Boolean`	`isNotifyRetract()` Determines whether subscribers should be notified when items are deleted from the node.
`default boolean`	`isPersistItems()` Determines whether items should be persisted in the node.
`default boolean`	`isPresenceBasedDelivery()` Determines whether to deliver notifications to available users only.
`default boolean`	`isSubscribe()` Determines if subscriptions are allowed.

Methods inherited from interface org.jivesoftware.smackx.xdata.form.FormReader
getField, readBoolean, readDate, readFirstValue, readInteger, readStringValues, readValues

- Field Detail
  - FORM_TYPE
```
static final java.lang.String FORM_TYPE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getAccessModel
```
default AccessModel getAccessModel()
```
    Get the currently configured AccessModel, null if it is not set.
    
    Returns:
    
    The current AccessModel
  - getBodyXSLT
```
default java.lang.String getBodyXSLT()
```
    Returns the URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.
    
    Returns:
    
    URL to an XSL
  - getChildren
```
default java.util.List<java.lang.String> getChildren()
```
    The id's of the child nodes associated with a collection node (both leaf and collection).
    
    Returns:
    
    list of child nodes.
  - getChildrenAssociationPolicy
```
default ChildrenAssociationPolicy getChildrenAssociationPolicy()
```
    Returns the policy that determines who may associate children with the node.
    
    Returns:
    
    The current policy
  - getChildrenAssociationWhitelist
```
default java.util.List<org.jxmpp.jid.Jid> getChildrenAssociationWhitelist()
```
    List of JID's that are on the whitelist that determines who can associate child nodes with the collection node. This is only relevant if getChildrenAssociationPolicy() is set to ChildrenAssociationPolicy.whitelist.
    
    Returns:
    
    List of the whitelist
  - getChildrenMax
```
default java.lang.Integer getChildrenMax()
```
    Gets the maximum number of child nodes that can be associated with the collection node.
    
    Returns:
    
    The maximum number of child nodes
  - getCollection
```
default java.util.List<? extends java.lang.CharSequence> getCollection()
```
    Gets the collection node which the node is affiliated with.
    
    Returns:
    
    The collection node id
  - getDataformXSLT
```
default java.lang.String getDataformXSLT()
```
    Gets 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.
    
    Returns:
    
    The URL of an XSL transformation
  - isDeliverPayloads
```
default java.lang.Boolean isDeliverPayloads()
```
    Does the node deliver payloads with event notifications.
    
    Returns:
    
    true if it does, false otherwise
  - getItemReply
```
default ItemReply getItemReply()
```
    Determines who should get replies to items.
    
    Returns:
    
    Who should get the reply
  - getMaxItems
```
default java.lang.Integer getMaxItems()
```
    Gets the maximum number of items to persisted to this node if isPersistItems() is true.
    
    Returns:
    
    The maximum number of items to persist
  - getMaxPayloadSize
```
default java.lang.Integer getMaxPayloadSize()
```
    Gets the maximum payload size in bytes.
    
    Returns:
    
    The maximum payload size
  - getNodeType
```
default NodeType getNodeType()
```
    Gets the node type.
    
    Returns:
    
    The node type
  - isNotifyConfig
```
default java.lang.Boolean isNotifyConfig()
```
    Determines if subscribers should be notified when the configuration changes.
    
    Returns:
    
    true if they should be notified, false otherwise
  - isNotifyDelete
```
default java.lang.Boolean isNotifyDelete()
```
    Determines whether subscribers should be notified when the node is deleted.
    
    Returns:
    
    true if subscribers should be notified, false otherwise
  - isNotifyRetract
```
default java.lang.Boolean isNotifyRetract()
```
    Determines whether subscribers should be notified when items are deleted from the node.
    
    Returns:
    
    true if subscribers should be notified, false otherwise
  - getNotificationType
```
default NotificationType getNotificationType()
```
    Determines the type of notifications which are sent.
    
    Returns:
    
    NotificationType for the node configuration
    
    Since:
    
    4.3
  - isPersistItems
```
default boolean isPersistItems()
```
    Determines whether items should be persisted in the node.
    
    Returns:
    
    true if items are persisted
  - isPresenceBasedDelivery
```
default boolean isPresenceBasedDelivery()
```
    Determines whether to deliver notifications to available users only.
    
    Returns:
    
    true if users must be available
  - getPublishModel
```
default PublishModel getPublishModel()
```
    Gets the publishing model for the node, which determines who may publish to it.
    
    Returns:
    
    The publishing model
  - getRosterGroupsAllowed
```
default java.util.List<java.lang.String> getRosterGroupsAllowed()
```
    Gets the roster groups that are allowed to subscribe and retrieve items.
    
    Returns:
    
    The roster groups
  - isSubscribe
```
default boolean isSubscribe()
```
    Determines if subscriptions are allowed.
    
    Returns:
    
    true if subscriptions are allowed, false otherwise
  - getTitle
```
default java.lang.String getTitle()
```
    Gets the human readable node title.
    
    Returns:
    
    The node title
  - getDataType
```
default java.lang.String getDataType()
```
    The type of node data, usually specified by the namespace of the payload (if any).
    
    Returns:
    
    The type of node data

Interface ConfigureFormReader

Field Summary

Method Summary

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

Field Detail

FORM_TYPE

Method Detail

getAccessModel

getBodyXSLT

getChildren

getChildrenAssociationPolicy

getChildrenAssociationWhitelist

getChildrenMax

getCollection

getDataformXSLT

isDeliverPayloads

getItemReply

getMaxItems

getMaxPayloadSize

getNodeType

isNotifyConfig

isNotifyDelete

isNotifyRetract

getNotificationType

isPersistItems

isPresenceBasedDelivery

getPublishModel

getRosterGroupsAllowed

isSubscribe

getTitle

getDataType