001    /*
002     * file CcRegistryRegion.java
003     * 
004     * Licensed Materials - Property of IBM
005     * Restricted Materials of IBM 
006     *
007     * com.ibm.rational.wvcm.stp.cc.CcRegistryRegion
008     *
009     * © Copyright IBM Corporation 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.cc;
015    
016    import static com.ibm.rational.wvcm.stpex.StpExBase.PROPERTY_NAMESPACE;
017    
018    import javax.wvcm.ResourceList;
019    import javax.wvcm.WvcmException;
020    import javax.wvcm.PropertyNameList.PropertyName;
021    
022    import com.ibm.rational.wvcm.stpex.StpExBase;
023    
024    /**
025     * <p>
026     * A proxy for a ClearCase registry region. 
027     * </p>
028     * <p>
029     * A registry region is a tag namespace shared by a subset of registry clients. 
030     * The Rational ClearCase registry supports only a single region. With the Rational ClearCase registry, 
031     * you can create multiple regions. VOB and view tags in a Rational ClearCase registry include the 
032     * name of the registry region in which the tag is visible. Each Rational ClearCase client is a 
033     * member of a single registry region and can access only those VOBs and views whose tags are 
034     * visible in that region.
035     * </p>
036     * <p>
037     * For more information about registry regions, see the ClearCase "Administrator's Guide"
038     * manual, and the cleartool man pages "lsregion" and "mkregion".
039     * </p>
040     */
041    
042    public interface CcRegistryRegion extends CcResource {
043    
044        /** List of VOB tags in this registry region as CcVobTag instances */
045        PropertyName<ResourceList<CcVobTag>> VOB_TAG_LIST =
046            new PropertyName<ResourceList<CcVobTag>>(PROPERTY_NAMESPACE,
047                                                   "vob-tag-list");
048        
049        /**
050         * Returns the value of this proxy's {@link #VOB_TAG_LIST} property.
051         * 
052         * @return list of VOB tags registered in the region
053         * @throws WvcmException
054         *             if this proxy doesn't define a value for this property.
055         */
056        ResourceList<CcVobTag> getVobTagList() throws WvcmException;
057    
058        /** List of view tags in this registry region as CcViewTag instances */
059        PropertyName<ResourceList<CcViewTag>> VIEW_TAG_LIST =
060            new PropertyName<ResourceList<CcViewTag>>(PROPERTY_NAMESPACE,
061                                                      "view-tag-list");
062    
063        /**
064         * Returns the value of this proxy's {@link #VIEW_TAG_LIST} property.
065         * 
066         * @return list of view tags registered in the region
067         * @throws WvcmException
068         *             if this proxy doesn't define a value for this property.
069         */
070        ResourceList<CcViewTag> getViewTagList() throws WvcmException;
071    }