Load services

You can use different types of load services to return business objects. For example, you can use a search service to return catalog entries.

Load services return an XML document that returns serialized business objects represented by the object element. The object element must include the objectType attribute. The value of the objectType attribute must correspond to the objectType attribute of a declared wcfObjectDefinition. The properties of an object are represented by the object element's sub-elements. The name of the element is the name of the property.
Note: You cannot use the following terms as property names since they are reserved:
  • object
  • parent
  • reference
You can include child objects in the serialized object by declaring a child object element. The object tag supports the following attributes:
  • objectType="XXX"
  • readOnly="true"
  • readOnly="false"
  • moveable="true"
  • moveable="false"
The properties elements can include the readOnly="true" or readOnly="false" attributes. There are several special properties:
  • changeControlModifiable
  • changeControlWorkspaceName
  • changeControlWorkspaceTaskGroup
  • changeControlWorkspaceTask
  • objectStoreId
You can use the reference tag to declare embedded references and the parent tag to declare an embedded parent object.

The following code snippet illustrates the response from a service that returns a catalog entry:

<object objectType="Product">
	<object objectType="CatalogEntryDescription">
		<name>Two-Drawer Coffee Table</name>
		<sDesc>This beautiful coffee table will fit perfectly into any living area.</sDesc>
The Management Center uses the following types of load services:
Returns the child objects that are associated with a specified parent object. Instances of wcfTopObjectDefinition, wcfOrganizationalObjectDefinition, and wcfPrimaryObjectDefinition can have multiple get children services. These get children services are invoked when the framework detects that the child objects are required. For example, when the user expands a category in the explorer view, the get children service that loads the child categories is invoked.
Returns the primary objects that reference a specified primary object. Instances of wcfPrimaryObjectDefinition can have multiple get references services. The get references services are invoked when the framework needs to display objects that reference the current object. For example, when the user selects the References tab in the product properties view, the get references service that returns the bundles that contain the current product are invoked.
Refreshes the properties of a primary object. Instances of wcfPrimaryObjectDefinition must declare a single refresh service. When the user selects the Reload action, the framework invokes the refresh service for the selected business object under the Active Work node in the explorer view.
Returns a list of business objects that match user specified search criteria. For example, the framework invokes the search service for the current search type when the user types a search string in the find area and clicks the search button.