TriggerDefinition.java

package com.bagri.core.system;

import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;

/**
 * Represents basic trigger implementation
 * 
 * @author Denis Sukhoroslov
 *
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(namespace = "http://www.bagridb.com/schema/system", propOrder = {
		"docType",
		"synchronous",
		"enabled",
		"index",
		"actions"
})
@XmlSeeAlso({
    JavaTrigger.class,
    XQueryTrigger.class
})
public abstract class TriggerDefinition extends Entity {
	
	@XmlElement(required = false)
	private String docType;

	@XmlElement(required = true)
	private boolean synchronous;
	
	@XmlElement(required = false, defaultValue = "true")
	private boolean enabled = true;

	@XmlElement(required = true)
	private int index;
	
	@XmlElement(name="action")
	@XmlElementWrapper(name="actions")
	private Set<TriggerAction> actions = new HashSet<TriggerAction>();
	
	/**
	 * default constructor
	 */
	public TriggerDefinition() {
		// for JAXB
		super();
	}
	
	/**
	 * 
	 * @param version the version
	 * @param createdAt the date/time of version creation
	 * @param createdBy the user who has created the version
	 * @param docType the document type for which trigger is registered
	 * @param synchronous is trigger invoked synchronously or not
	 * @param enabled the trigger enabled flag
	 * @param index the order at which trigger will be invoked 
	 */
	public TriggerDefinition(int version, Date createdAt, String createdBy, String docType, 
			boolean synchronous, boolean enabled, int index) {
		super(version, createdAt, createdBy);
		this.docType = docType;
		this.synchronous = synchronous;
		this.enabled = enabled;
		this.index = index;
	}

	/**
	 * 
	 * @return the trigger name
	 */
	public abstract String getName();

	public String getDocType() {
		return docType;
	}

	/**
	 * 
	 * @return is trigger invoked synchronously or not
	 */
	public boolean isSynchronous() {
		return synchronous;
	}

	/**
	 * 
	 * @return the trigger enabled flag
	 */
	public boolean isEnabled() {
		return enabled;
	}

	/**
	 * 
	 * @param enabled the new flag value
	 * @return true if flag has been changed, false otherwise
	 */
	public boolean setEnabled(boolean enabled) {
		if (this.enabled != enabled) {
			this.enabled = enabled;
			//this.updateVersion("???");
			return true;
		}
		return false;
	}
	
	/**
	 * 
	 * @return the order at which trigger will be invoked
	 */
	public int getIndex() {
		return index;
	}
	
	/**
	 * 
	 * @param index the order at which trigger will be invoked
	 */
	public void setIndex(int index) {
		this.index = index;
	}

	/**
	 * 
	 * @return a collection of trigger actions  
	 */
	public Set<TriggerAction> getActions() {
		return actions;
	}
	
	/**
	 * 
	 * @param actions a collection of trigger actions
	 */
	public void setActions(Collection<TriggerAction> actions) {
		this.actions.clear();
		if (actions != null) {
			this.actions.addAll(actions);
		}
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Map<String, Object> convert() {
		Map<String, Object> result = super.convert();
		result.put("docType", docType); // can be null!
		result.put("synchronous", synchronous); 
		result.put("enabled", enabled);
		result.put("index", index);
		result.put("actions", actions.toString());
		return result;
	}

}