NodeSubscription.java

package org.buddycloud.channelserver.pubsub.model;

import java.util.Date;

import org.buddycloud.channelserver.pubsub.subscription.Subscriptions;
import org.xmpp.packet.JID;
import org.xmpp.resultsetmanagement.Result;

/**
 * Represents a user's subscription to a node
 */
public interface NodeSubscription extends Result {

    /**
     * Gets the subscription type
     * 
     * @return
     */
    Subscriptions getSubscription();

    /**
     * Gets the user
     * 
     * @return
     */
    JID getUser();

    /**
     * Gets the listener for notifications (for the inbox protocol)
     * 
     * @return the listener's JID, or <code>null</code> if not a remote subscription.
     */
    JID getListener();

    /**
     * Gets the node id
     * 
     * @return
     */
    String getNodeId();

    /**
     * Get last updated
     * 
     * @return
     */
    Date getLastUpdated();

    /**
     * Get invited by
     * 
     * @return
     */
    JID getInvitedBy();
}