public interface IOperator
As a minimum, an operator needs to have a name. It does not necessarily have to have an implementation associated with it.
| Modifier and Type | Method and Description |
|---|---|
String |
getDocumentation()
Get the documentation string attached to this operator, if any.
|
String |
getImplementationDetail(String label)
Get an implementation detail associated with the operator, given its label.
|
Collection<IImplementationDetail> |
getImplementationDetails()
Return all implementation details associated with the operator.
|
String |
getName()
Return the operator name.
|
NRLDataType |
getNRLReturnType()
Returns the return type of the operator.
|
IParameter |
getParameter(String name)
Return a parameter by name
|
List<IParameter> |
getParameters()
Return a list of
IParameter objects. |
String |
getPurpose()
Return the purpose of this operator.
|
IModelElement |
getReturnType()
Return the return type of the operator.
|
String |
getReturnTypeName()
Return the name of the return type as found in the definition
|
List<NRLError> |
resolveModelReferences(IModelCollection models)
Resolve all parameter type and return type references against models.
|
void |
setNRLReturnType(NRLDataType type)
Set the NRL type of the return type
|
void |
setReturnType(IModelElement returnType)
Set the type this operator will return.
|
void |
setReturnTypeName(String name)
Set the raw name of the return type.
|
String getDocumentation()
String getImplementationDetail(String label)
See IImplementationDetail for more information.
label - the labelCollection<IImplementationDetail> getImplementationDetails()
IImplementationDetail for more information.
Note that this does not return the implementation details associated with parameters of the operators - those have to be read off the individual parameters.
IImplementationDetail objectsString getName()
IParameter getParameter(String name)
name - parameter nameList<IParameter> getParameters()
IParameter objects.String getPurpose()
String getReturnTypeName()
IModelElement getReturnType()
resolveModelReferences(IModelCollection) before this.NRLDataType getNRLReturnType()
NRLDataType.UNKNOWN.List<NRLError> resolveModelReferences(IModelCollection models)
models - the modelsvoid setReturnType(IModelElement returnType)
returnType - the typevoid setReturnTypeName(String name)
name - the namevoid setNRLReturnType(NRLDataType type)
type - the typeCopyright © 2006-2013. All Rights Reserved.