001/*
002 * file CqHook.java
003 *
004 * Licensed Materials - Property of IBM
005 * Restricted Materials of IBM 
006 *
007 * com.ibm.rational.wvcm.stp.cq.CqHook
008 *
009 * (C) Copyright IBM Corporation 2004, 2010.  All Rights Reserved.
010 * Note to U.S. Government Users Restricted Rights:  Use, duplication or 
011 * disclosure restricted by GSA ADP  Schedule Contract with IBM Corp.
012 */
013
014package com.ibm.rational.wvcm.stp.cq;
015
016import com.ibm.rational.wvcm.stp.StpResource;
017
018/**
019 * A schema-defined script to be executed during the application of an Action to
020 * an actionable resource. Hooks can be referred to directly from record form
021 * controls or in the source of another record, action or field hook.
022 * <p>
023 * Both named record hooks and global hooks are defined in the HOOK Namespace.
024 * Named record hooks are defined as a child of a record type.
025 * <p>
026 * At this time, named record hooks and global hooks are supported. 
027 * Named record hooks are defined by a record type as the value of the 
028 * NAMED_HOOK_LIST property of a CqRecordType resource.
029 * Global hook names must be known in advance and used to construct a location.
030 * These can then be used as an argument to CqRecord.doFireNamedHook();
031 * <p>
032 * The user-friendly specification for the location of a named hook has the form
033 * <pre>
034 *  <b>cq.hook:</b><i>&lt;record-type&gt;</i>/<i>&lt;hook-name&gt;</i>@<i>&lt;db-set&gt;</i>/<i>&lt;user-db&gt;</i>
035 * </pre>
036 * The user-friendly specification for the location of a global hook has the form
037 * <pre>
038 *  <b>cq.hook:</b><i>&lt;hook-name&gt;</i>@<i>&lt;db-set&gt;</i>/<i>&lt;user-db&gt;</i>
039 * </pre>
040 */
041public interface CqHook extends CqUserDbMember
042{
043}