org.jivesoftware.wildfire.disco
Interface DiscoItem

All Known Subinterfaces:

DiscoServerItem

public interface DiscoItem

An item is associated with an XMPP Entity, usually thought of a children of the parent entity and normally are addressable as a JID.

An item associated with an entity may not be addressable as a JID. In order to handle such items, Service Discovery uses an optional 'node' attribute that supplements the 'jid' attribute.

Author:

Gaston Dombiak

Method Summary

String	getAction() Returns the action (i.e.
String	getJID() Returns the entity's ID.
String	getName() Returns the entity's name.
String	getNode() Returns the node attribute that supplements the 'jid' attribute.

Method Detail

getJID

String getJID()

Returns the entity's ID.

Returns:

the entity's ID.

getNode

String getNode()

Returns the node attribute that supplements the 'jid' attribute. A node is merely something that is associated with a JID and for which the JID can provide information.

Node attributes SHOULD be used only when trying to provide or query information which is not directly addressable.

Returns:

the node attribute that supplements the 'jid' attribute

getName

String getName()

Returns the entity's name. The entity's name specifies in natural-language the name for the item.

Returns:

the entity's name.

getAction

String getAction()

Returns the action (i.e. update or remove) that indicates what must be done with this item or null if none. An "update" action requests the server to create or update the item. Whilst a "remove" action requests to remove the item.

Returns:

the action (i.e. update or remove) that indicates what must be done with this item or null if none.