IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.core
Interface IPatternApplication

All Superinterfaces:
Comparable

public interface IPatternApplication
extends Comparable

Represents an application of a particular pattern.

The properties of a pattern application are the descriptor of the pattern that was applied (getAppliedPattern), a unique identifier (getUniqueId) to distinguish the application from other applications of the same pattern, and the times of the initial application (getApplicationTime) and the last modification made (getModificationTime) as a consequence of the pattern application. Use the getParticipantRole method to retrieve the role played by the object in the pattern application.


Method Summary
 Date getApplicationTime()
          Returns the time that the pattern was initially applied.
 IPatternDescriptor getAppliedPattern()
          Returns the pattern descriptor representing the pattern that was applied for this pattern application.
 Date getModificationTime()
          Returns the time that a modification was most recently made to the pattern application.
 PatternApplicationRole getParticipantRole(Object participatingObject)
          Returns the role played by the given object in this pattern application.
 String getUniqueId()
          Returns the unique identifier of the pattern application.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getAppliedPattern

public IPatternDescriptor getAppliedPattern()
Returns the pattern descriptor representing the pattern that was applied for this pattern application.

Returns:
Returns the pattern descriptor that was applied.

getUniqueId

public String getUniqueId()
Returns the unique identifier of the pattern application.

This ID is generated at the time the pattern is initially applied.

Returns:
Returns the identity of the pattern application.

getApplicationTime

public Date getApplicationTime()
Returns the time that the pattern was initially applied.

Returns:
Returns the time of the application of the pattern.

getModificationTime

public Date getModificationTime()
Returns the time that a modification was most recently made to the pattern application.

Returns:
Returns the most recent time of modification of the pattern application.

getParticipantRole

public PatternApplicationRole getParticipantRole(Object participatingObject)
Returns the role played by the given object in this pattern application.

Returns:
Returns the role played by the object in the pattern application.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.