CoreandServices.book - Ocean - Schlumberger

Custom Worksteps
In order to build the default UI’s for you, Ocean needs to know the details of your
arguments. For each argument, Ocean needs to know its role (input/output), its type, its
value, its description, and any special Ocean attributes with which it is marked.
All of the argument details are packaged in a DescribedArgument class, which allows
Ocean to deal with arguments without having to know their types.
public abstract class DescribedArgument : IDescriptionSource
{
public ArgumentRole ArgRole { get; }
public Type ArgType { get; }
public object Value { get; set; }
public IDescription Description { get; }
public IEnumerable
GetAssociatedAttributes();
protected ArgumentRole ArgRoleCore { get; }
protected Type ArgTypeCore { get; }
protected object ValueCore { get; set; }
protected IDescription DescriptionCore { get; }
}
protected IEnumerable
GetAssociatedAttributesCore();
There would be one of these objects for each argument in an argument package. In our
example, there would be four: two for the inputs and two for the outputs.
All of the described arguments are collected into an array and given to Ocean via the
IDescribedArgumentsSource interface.
public interface IDescribedArgumentsSource
{
DescribedArgument[] DescribedArguments { get; }
}
In our example, the array would need to be length four to hold all of the arguments.
Having your argument package implement IDescribedArgumentsSource is the key to
getting the Ocean convenience functionality for your argument package.
6-296 Ocean Application Development Framework 2008.1
Schlumberger Private