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, 2008. 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
014 package com.ibm.rational.wvcm.stp.cq;
015
016 import 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 * It is defined in the HOOK Namespace as a child of a record type.
024 * <p>
025 * At this time, only named record hooks are supported. These hooks are defined
026 * by a record type as the value of the NAMED_HOOK_LIST property of a
027 * CqRecordType resource and are used as an argument to
028 * CqRecord.doFireNamedHook();
029 * <p>
030 * The user-friendly specification for the location of a hook has the form
031 * <pre>
032 * <b>cq.hook:</b><i><record-type></i>/<i><hook-name></i>@<i><db-set></i>/<i><user-db></i>
033 * </pre>
034 */
035 public interface CqHook extends CqUserDbMember
036 {
037 }