blob: 833398a00239e9253ee9cb43891c28e040177f84 [file] [log] [blame]
//------------------------------------------------------------------------------
// Copyright (c) 2005, 2006 IBM Corporation and others.
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// Contributors:
// IBM Corporation - initial implementation
//------------------------------------------------------------------------------
package org.eclipse.epf.uma;
import java.util.List;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Custom Category</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A Custom Category is a category introduced by a method content author to structure any number of method Content Elements of any subtype based on user-defined criteria. Because Content Categories (and therefore Custom Categories, too) are Content Elements themselves, Custom Categories can be used to recursively categorize Content Categories as well. Custom Categories can also be nested with any Content Category. Custom categories can be used to categorize content based on the user's criteria as well as to define whole tree-structures of nested categories allowing the user to systematically navigate and browse method content and processes based on these categories. For example, one could create a custom category to logically organize content relevant for the user's development organization departments; e.g. a "Testing" category that groups together all roles, work products, tasks, and guidance element relevant to testing. Another example would be categories that express licensing levels of the content grouping freely distributable method content versus content that represent intellectual property and requires a license to be purchased to be able to use it.
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.epf.uma.CustomCategory#getCategorizedElements <em>Categorized Elements</em>}</li>
* <li>{@link org.eclipse.epf.uma.CustomCategory#getSubCategories <em>Sub Categories</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.epf.uma.UmaPackage#getCustomCategory()
* @model
* @generated
*/
public interface CustomCategory extends ContentCategory {
/**
* Returns the value of the '<em><b>Categorized Elements</b></em>' reference list.
* The list contents are of type {@link org.eclipse.epf.uma.DescribableElement}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Categorized Elements</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Categorized Elements</em>' reference list.
* @see org.eclipse.epf.uma.UmaPackage#getCustomCategory_CategorizedElements()
* @model ordered="false"
* @generated
*/
List<DescribableElement> getCategorizedElements();
/**
* Returns the value of the '<em><b>Sub Categories</b></em>' reference list.
* The list contents are of type {@link org.eclipse.epf.uma.ContentCategory}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Sub Categories</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Sub Categories</em>' reference list.
* @see org.eclipse.epf.uma.UmaPackage#getCustomCategory_SubCategories()
* @model ordered="false"
* @generated
*/
List<ContentCategory> getSubCategories();
} // CustomCategory