blob: 334e1b804d5b1fe58fbb569269cacbab58915c97 [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>Work Breakdown Element</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A Work Breakdown Element is a special Breakdown Element that provides specific properties for Breakdown Elements that represent or refer to Work Definitions. For example its subclass Activity defines work as it is also a subclass of Work Definition. Its subclass Task Descriptor does not define work by itself, but refers to a Work Definition and therefore can have the same common properties and Work Breakdown Element has.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.epf.uma.WorkBreakdownElement#getIsRepeatable <em>Is Repeatable</em>}</li>
* <li>{@link org.eclipse.epf.uma.WorkBreakdownElement#getIsOngoing <em>Is Ongoing</em>}</li>
* <li>{@link org.eclipse.epf.uma.WorkBreakdownElement#getIsEventDriven <em>Is Event Driven</em>}</li>
* <li>{@link org.eclipse.epf.uma.WorkBreakdownElement#getLinkToPredecessor <em>Link To Predecessor</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.epf.uma.UmaPackage#getWorkBreakdownElement()
* @model abstract="true"
* @generated
*/
public interface WorkBreakdownElement extends BreakdownElement {
/**
* Returns the value of the '<em><b>Is Repeatable</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* This attribute is used to define repetition of work, e.g. iterations. A Process Work Definition with this attribute set to True shall be repeated more than once on the same set of artifacts. For example, for an instance of Iteration (defined as a special Process Work Definition below) this attribute is set to True by default indicating that every sub-Activity will be repeated more than once. However, any Process Work Definition can set this attribute to True to define iterations (e.g. to iterate one Activity consisting of many sub-activities or even Phases, but to iterate just one Task).
* <!-- end-model-doc -->
* @return the value of the '<em>Is Repeatable</em>' attribute.
* @see #setIsRepeatable(Boolean)
* @see org.eclipse.epf.uma.UmaPackage#getWorkBreakdownElement_IsRepeatable()
* @model default="false" dataType="org.eclipse.epf.uma.Boolean" required="true" ordered="false"
* @generated
*/
Boolean getIsRepeatable();
/**
* Sets the value of the '{@link org.eclipse.epf.uma.WorkBreakdownElement#getIsRepeatable <em>Is Repeatable</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Is Repeatable</em>' attribute.
* @see #getIsRepeatable()
* @generated
*/
void setIsRepeatable(Boolean value);
/**
* Returns the value of the '<em><b>Is Ongoing</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* If the isOngoing attribute is set to True for a Process Work Definition instance, then the element describes an ongoing piece of work without a fixed duration or end state. For example, the Process Work Definition could represent work of an administrator continuously (e.g. 3h a day) working to ensure that systems are kept in a certain state. Another example would be program management work overseeing many different projects being scheduled for one particular project at specific reoccurring intervals during the whole lifecycle of the project.
* <!-- end-model-doc -->
* @return the value of the '<em>Is Ongoing</em>' attribute.
* @see #setIsOngoing(Boolean)
* @see org.eclipse.epf.uma.UmaPackage#getWorkBreakdownElement_IsOngoing()
* @model default="false" dataType="org.eclipse.epf.uma.Boolean" required="true" ordered="false"
* @generated
*/
Boolean getIsOngoing();
/**
* Sets the value of the '{@link org.eclipse.epf.uma.WorkBreakdownElement#getIsOngoing <em>Is Ongoing</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Is Ongoing</em>' attribute.
* @see #getIsOngoing()
* @generated
*/
void setIsOngoing(Boolean value);
/**
* Returns the value of the '<em><b>Is Event Driven</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The isEventDriven attribute indicates that the Process Work Definition describes an instance of work which is not started because it has been scheduled to start at a certain point of time, because preceding work is being completed, or input work products are available, but because another specific event has occurred. Examples for such events are exceptions or problem situations which require specific work to be performed as a result. Also change management work can be modeled as event driven work analyzing a change request or defect and allocating work dynamically to resources to deal with it following the work described with such Process Work Definition. The events themselves are not modeled in this version of the specification. They shall be described as part of the normal descriptions fields available.
*
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Is Event Driven</em>' attribute.
* @see #setIsEventDriven(Boolean)
* @see org.eclipse.epf.uma.UmaPackage#getWorkBreakdownElement_IsEventDriven()
* @model default="false" dataType="org.eclipse.epf.uma.Boolean" required="true" ordered="false"
* @generated
*/
Boolean getIsEventDriven();
/**
* Sets the value of the '{@link org.eclipse.epf.uma.WorkBreakdownElement#getIsEventDriven <em>Is Event Driven</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Is Event Driven</em>' attribute.
* @see #getIsEventDriven()
* @generated
*/
void setIsEventDriven(Boolean value);
/**
* Returns the value of the '<em><b>Link To Predecessor</b></em>' reference list.
* The list contents are of type {@link org.eclipse.epf.uma.WorkOrder}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Link To Predecessor</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>Link To Predecessor</em>' reference list.
* @see org.eclipse.epf.uma.UmaPackage#getWorkBreakdownElement_LinkToPredecessor()
* @model ordered="false"
* @generated
*/
List<WorkOrder> getLinkToPredecessor();
} // WorkBreakdownElement