rapture.common.api.EventApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.RaptureFolderInfo;
import rapture.common.model.RaptureEvent;
import rapture.common.model.RunEventHandle;


@SuppressWarnings("all")
public interface EventApi {
     /**
     * This method is used to retrieve information about an event (primarily the scripts
     * attached to it).
     * 
     */
     RaptureEvent getEvent(CallingContext context, String eventUri);

     /**
     * This method puts an event in the system.
     * 
     */
     void putEvent(CallingContext context, RaptureEvent event);

     /**
     * This method removes an event (and any attached scripts) from the system. If the event
     * is fired at a later point nothing will happen as there would be no scripts attached.
     * 
     */
     void deleteEvent(CallingContext context, String eventUri);

     /**
     * Return a list of full display names of the paths below this one. Ideally optimized
     * depending on the repo.
     * 
     */
     List listEventsByUriPrefix(CallingContext context, String eventUriPrefix);

     /**
     * This method is used to attach a script to an event. A final parameter signals whether
     * this script should be detached from the event when it is fired.
     * 
     */
     void addEventScript(CallingContext context, String eventUri, String scriptUri, Boolean performOnce);

     /**
     * This method detaches a script from the event.
     * 
     */
     void deleteEventScript(CallingContext context, String eventUri, String scriptUri);

     /**
     * This method is used to attach a message to an event. When the event is fired a message
     * is sent to the pipeline with content based on the context of the event and parameters
     * passed to this call.
     * 
     */
     void addEventMessage(CallingContext context, String eventUri, String name, String pipeline, Map params);

     /**
     * This method reverses the message attachment, using the same name as passed in the
     * original attachMessage call
     * 
     */
     void deleteEventMessage(CallingContext context, String eventUri, String name);

     /**
     * This method is used to attach a notification to an event. When the event is fired
     * a message is sent to the notification with content based on the context of the
     * event and parameters passed to this call.
     * 
     */
     void addEventNotification(CallingContext context, String eventUri, String name, String notification, Map params);

     /**
     * This method reverses the notification attachment, using the same name as passed in
     * the original attachNotification call
     * 
     */
     void deleteEventNotification(CallingContext context, String eventUri, String name);

     /**
     * This method is used to attach a workflow (dp) to an event. When the event is fired
     * an instance of the workflow is started.
     * 
     */
     void addEventWorkflow(CallingContext context, String eventUri, String name, String workflowUri, Map params);

     /**
     * This method reverses the notification attachment, using the same name as passed in
     * the original attachWorflowToEvent call.
     * 
     */
     void deleteEventWorkflow(CallingContext context, String eventUri, String name);

     /**
     * This method fires an event, scheduling any attached scripts to run. The optional
     * displayName and context parameters are passed to the script when fired.
     * 
     */
     Boolean runEvent(CallingContext context, String eventUri, String associatedUri, String eventContext);

     /**
     * This method fires an event, scheduling any attached workflows or scripts to run.
     * The optional associatedURI and context map are passed to the event workflow when
     * fired. The event's unique id is returned. This id is passed to any scripts, workflows,
     * etc invoked by the event
     * 
     */
     RunEventHandle runEventWithContext(CallingContext context, String eventUri, String associatedUri, Map eventContextMap);

     /**
     * Determines whether an event has been defined.
     * 
     */
     Boolean eventExists(CallingContext context, String eventUri);

     /**
     * Removes a folder and its contents recursively, including empty subfolders. Validates
     * entitlement on individual events and folders. Returns a list of the events and folders
     * removed.
     * 
     */
     List deleteEventsByUriPrefix(CallingContext context, String uriPrefix);

}