001/*
002 * file CqUserDbMember.java
003 *
004 * Licensed Materials - Property of IBM
005 * Restricted Materials of IBM 
006 *
007 * com.ibm.rational.wvcm.stp.cq.CqUserDbMember
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 */
013package com.ibm.rational.wvcm.stp.cq;
014
015import static com.ibm.rational.wvcm.stpex.StpExBase.PROPERTY_NAMESPACE;
016
017import javax.wvcm.WvcmException;
018import javax.wvcm.PropertyNameList.PropertyName;
019
020import com.ibm.rational.wvcm.stpex.StpExBase;
021
022/**
023 * The properties supported by all members of a ClearQuest User Database.
024 */
025public interface CqUserDbMember extends CqResource {
026    /** The user database that contains this resource. */
027    PropertyName<CqUserDb> USER_DB =
028        new PropertyName<CqUserDb>(PROPERTY_NAMESPACE,
029                                   "user-db");
030
031    /**
032     * Returns the value of the {@link #USER_DB USER_DB} property as defined by 
033     * this proxy.
034     *
035     * @return  A CqUserDb proxy for the database that contains this resource
036     *
037     * @throws  WvcmException  if this proxy does not define a value for the
038     *                         {@link #USER_DB USER_DB} property.
039     */
040    CqUserDb getUserDb() throws WvcmException;
041
042    /** The database set that contains this resource */
043    PropertyName<CqDbSet> DB_SET = 
044        new PropertyName<CqDbSet>(PROPERTY_NAMESPACE, "db-set");
045
046    /**
047     * Returns the value of the {@link #DB_SET DB_SET} property as defined by 
048     * this proxy.
049     *
050     * @return  A CqDbSet proxy for the database set that contains this resource.
051     *
052     * @throws  WvcmException  if this proxy does not define a value for the
053     *                         {@link #DB_SET DB_SET} property.
054     */
055    CqDbSet getDbSet() throws WvcmException;
056}