org.eclipse.stp.core.sca
Interface ReferenceValue

All Superinterfaces:
SCAObject

public interface ReferenceValue
extends SCAObject

A representation of the model object 'Reference Value'.

This interface is not intended to be implemented by clients.

The following features are supported:

See Also:
SCAPackage.getReferenceValue()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 FeatureMap getAnyAttribute()
          Returns the value of the 'Any Attribute' attribute list.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 Component getOwningComponent()
          Return the Component which owns this ReferenceValue.
 Reference getReference()
          The following method could require the resolution of the ComponentType of the containing Component.
 ReferenceValuesSet getReferenceValueSet()
          Returns the value of the 'Reference Value Set' container reference.
 WireTarget getTarget()
          The WireTarget can be one of either Service or ExternalService.
 java.lang.String getTargetURI()
          Returns the value of the 'Target URI' attribute.
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 void setReference(Reference reference)
           
 void setReferenceValueSet(ReferenceValuesSet value)
          Sets the value of the 'Reference Value Set' container reference.
 void setTarget(WireTarget wireTarget)
          Set the target URI using the given wireTarget.
 void setTargetURI(java.lang.String value)
          Sets the value of the 'Target URI' attribute.
 boolean targets(WireTarget wireTarget)
          Return true if this ReferenceValue targets the passed WireTarget;
 
Methods inherited from interface org.eclipse.stp.core.sca.SCAObject
addStatus, clearStatus, getEObject, getFlags, getStatus
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getTargetURI

java.lang.String getTargetURI()
Returns the value of the 'Target URI' attribute.

If the meaning of the 'Target URI' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Target URI' attribute.
See Also:
setTargetURI(String), SCAPackage.getReferenceValue_TargetURI()

setTargetURI

void setTargetURI(java.lang.String value)
Sets the value of the 'Target URI' attribute.

Parameters:
value - the new value of the 'Target URI' attribute.
See Also:
getTargetURI()

getName

java.lang.String getName()
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Specified by:
getName in interface SCAObject
Returns:
the value of the 'Name' attribute.
See Also:
setName(String), SCAPackage.getReferenceValue_Name()

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Specified by:
setName in interface SCAObject
Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getAnyAttribute

FeatureMap getAnyAttribute()
Returns the value of the 'Any Attribute' attribute list. The list contents are of type org.eclipse.emf.ecore.util.FeatureMap.Entry.

If the meaning of the 'Any Attribute' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Any Attribute' attribute list.
See Also:
SCAPackage.getReferenceValue_AnyAttribute()

getReferenceValueSet

ReferenceValuesSet getReferenceValueSet()
Returns the value of the 'Reference Value Set' container reference. It is bidirectional and its opposite is 'Reference Values'.

If the meaning of the 'Reference Value Set' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Reference Value Set' container reference.
See Also:
setReferenceValueSet(ReferenceValuesSet), SCAPackage.getReferenceValue_ReferenceValueSet(), ReferenceValuesSet.getReferenceValues()

setReferenceValueSet

void setReferenceValueSet(ReferenceValuesSet value)
Sets the value of the 'Reference Value Set' container reference.

Parameters:
value - the new value of the 'Reference Value Set' container reference.
See Also:
getReferenceValueSet()

getReference

Reference getReference()
The following method could require the resolution of the ComponentType of the containing Component.

Returns:
The resolved Reference from the ComponentType

setReference

void setReference(Reference reference)
Parameters:
reference - Set the resolved reference (which implicitly changes the name attribute)

getTarget

WireTarget getTarget()
The WireTarget can be one of either Service or ExternalService.

Returns:
The resolved WireTarget for the current targetURI

setTarget

void setTarget(WireTarget wireTarget)
Set the target URI using the given wireTarget. The WireTarget will compute the correct target URI.

Parameters:
wireTarget - The new target for this ReferenceValue.

getOwningComponent

Component getOwningComponent()
Return the Component which owns this ReferenceValue.

Returns:
Component

targets

boolean targets(WireTarget wireTarget)
Return true if this ReferenceValue targets the passed WireTarget;

Parameters:
wireTarget -
Returns:
boolean