FileDocCategorySizeDatePackage
UMLActor.javaAPI DocExample2156Tue Dec 08 01:21:00 GMT 1998oisoft.togetherx.scriptapi.UML

UMLActor.java

/*----------------------------------------------------------------------------
Copyright © 1998 Object International Software GmbH
----------------------------------------------------------------------------*/
package oisoft.togetherx.scriptapi.UML;

import java.util.Properties;
import java.util.Enumeration;
import oisoft.togetherx.scriptapi.UML.enums.*;

//------------------------------------------------------------------------------
/**
 * Presents Actors of Use Case diagrams.
 * From UML point of view an actor is
 * someone, or something that interacts
 * with the system. It is participient
 * of an use case diagram.
 *
 * An actor is considered to be a user of the
 * system or some class from another
 * subsystem (with <<actor>> stereotype).
 * In the second case <i>isClass()</i> return <b>true</b>
 * and you can get actor as class using
 * <i>getClassOfInstance()</i>.
 *
 * Use <i>getCommunications()</i> to get
 * COMMUNICATION links between this actor and 
 * use cases in diagram.
 *
 * @version  2.1.05  21.07.1998
 * @author   Andrei Ivanov
 * @see UMLUseCase
 * @see UMLUseCaseDiagram
 */
public interface UMLActor extends UMLClassifier
{
  /** Indicates whether this actor is associated with some class.
   * @deprecated Not implemented yet.
   * @return true - if associated.
   */
  boolean                    isClass();

  /**Returns the class with <<actor>> stereotype, 
   * which is associated with this actor.
   * If no class is associated, it returns <b>null</b>.
   * @deprecated Not implemented yet.
   * @return Associated class; can be <b>null</b>. 
   * @see UMLActor#isClass
   */
  UMLClass    	             getClassOfInstance();


  /**Getting COMMUNICATION links
   * between this actor and use cases in the use case
   * diagram.
   * @return COMMUNICATION links enumerator of the actor
   * @see UMLCommunication
   * @see UMLUseCase
   * @see UMLLink#COMMUNICATION
   */
  UMLCommunicationEnumeration  getCommunications();
}
//------------------------------------------------------------------------------