com.plumtree.server
Interface IPTBulkSubscriber

All Superinterfaces:
IPTUnknown

public interface IPTBulkSubscriber
extends IPTUnknown

Author:
michaeld

Method Summary
 int ScheduleImmediateJob()
          Creates a job to run once immediately to process all the subscriptions.
 void SetBulkSubscription(int nClassID, int nObjectID, int[] anGroupIDs)
          Bulk subscribe the users in the passed in groups to a given object with the given class id and object id.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

SetBulkSubscription

void SetBulkSubscription(int nClassID,
                         int nObjectID,
                         int[] anGroupIDs)
Bulk subscribe the users in the passed in groups to a given object with the given class id and object id. Currently this only works for Portlets and Communities. The communit will not be added to the users' Subscriptions, or the portlet added to the users' Home My Page until the Subscription Job is run. To start the subscription job call IPTBulkSubscriber.ScheduleImmediateJob().

Parameters:
nCommunityID -
anGroupIDs -

ScheduleImmediateJob

int ScheduleImmediateJob()
Creates a job to run once immediately to process all the subscriptions.

Returns:
the ID of the job that will be run