Business modelling web service
The business modelling web service allows you to retrieve information about the business models available in WSRR using a Web service client.
Business modelling web service methods
The following interface diagram lists the methods, and their signatures, provided by the business modelling web service:
The methods are described in the following table:
| getModelDetail | Given the URI of an owl:Class defined as a model,
returns the ModelDetail for that particular class. The locale and
an int value can also be passed to the method. The int value can be one of the following.
|
| getModels | Returns a list of all the Model objects representing any owl:Class that has been defined as a business model. |
| getModelSystems | Returns a list of ModelSystem that represent owl:Ontology objects that have defined as a business system. A ModelFilter object must be supplied, although this is not currently used. |
Generated objects
The following objects are generated by the WSDL2Java tool. The properties on these objects correspond to what has been defined in the business model file. The following tables show the methods on the objects that can be used. See the related link for further details about Creating a business model system file manually.Model
| getDescription() | The description of the Model. Used for display purposes. |
| getName() | The name of the model. This is used for display purposes. |
| getURI() | The full URI that represents the model, for example http://mynamespace/model#MyModel |
ModelConstraint
| getMaxValue() | Corresponds to the maxCardinality value in a business model definition. For relationships, this is the maximum number of target objects allowed. |
| getMinValue() | Corresponds to the minCardinality value in a business model definition. For relationships, this is the minimum number of target objects allowed. |
| getPropertyNCName() | This is the name of the property that the constraint applies to. The result of getPropertyNCName() is equal to getNCName() on a ModelProperty object. |
ModelDetail
| getConstrainedModelProperties() | Get all the properties that have model constraints associated with them. |
| getDescription() | See getDescription() on Model. |
| getModelURI() | See getURI() on Model. |
| getName() | See getName() on Model. |
| getOptionalModelProperties() | Get all the properties that do not have constraints associated with them. |
| getModelConstraints() | Get the associated model constraints. |
ModelProperty
| getDefaultValue() | The default value can be applied to a property when creating a GenericObject |
| getDescription() | The description of the Property. Used for display purposes. |
| getName() | The name of the Property. Used for display purposes. |
| getNCName() | The NCName of the property. This is the name of the property, with a prefix that has been defined in the business model file. For example, yns_myProperty |
| getRange() | The range is the type of value that the property
or target of a relationship represents. When the range applies to a user-defined property, this can be one of the XSD Schema types (for example, http://www.w3.org/2001/XMLSchema#string). For a user-defined relationship, this can be another business model that has been defined, or one of the existing service registry objects (for example, http://www.ibm.com/xmlns/prod/serviceregistry/6/1/model/object#WSDLDocument). During a create or update operation, the validator will check that a value is of the type specified. |
| getType() | The type of object this is:
|
ModelSystem
| getName() | The name of the ModelSystem. Used for display purposes |
| getDescription() | The description of the ModelSystem. Used for display purposes |
| getURI() | The full URI that represents the Model System |
The following subtopics describe how to use the business modelling web service: