WebSphere brand IBM WebSphere Sensor Events, Version 6.2

createItem

Purpose

This Web service creates new items in the Location Awareness Services for WebSphere® Sensor Events database.

Syntax

ItemIDWithTimeStamp createItem(className,KeywordValuePair[] keyPairs,KeywordValuePair[] optPairs,String[] groups,LocaleDescriptor locale)

Input

className: A string that represents name of the class for the new item.

keyPairs: An array from the type, com.ibm.atlas.adminobjects.lasitemregistration.KeywordValuePair. This parameter is a keyword-value pair that represents key properties. The combination of values has to be unique. The keyword for each keyword-value pair is the name of a key property, and the value is the value for that key property. You can set these with setKeyword() and setValue(). The values must be in the correct type and in the correct format. For example, if the property type is an integer, then the value must also be an integer and can contain any number between 0 and 9.

optPairs: An array from type, com.ibm.atlas.adminobjects.lasitemregistration.KeywordValuePair. This parameter is a keyword-value pair that represents optional properties. The keyword for each keyword-value pair is the name of an optional property, and the value is the value for that optional property. You can set these with setKeyword() and setValue(). If the MinOccurs value of the property is 1, then the property is mandatory and you must enter a value for it. Some properties are not listed in metadata of the class but the method, createItem, accepts it. These properties are:
  • iconLink
  • iconLable
  • tagid
  • edgeLength - Accepted if the Container property is selected in the Class Details View of the Classes/Items Manager portlet in the WebSphere Application Server administrative console.
  • parentTagID - Accepted if the tag of the parent exists and if the Container property in the Class Details View of the Classes/Items Manager portlet is marked for a parent item.
  • parentItemID - Accepted if the parent item exists in the Class Details View of the Classes/Items Manager portlet and if the Container property is marked for a parent item.
The values must be in the correct type and in the correct format. For example, if a property type is a date, then the value must be in the MM/dd/yyyy format.

groups: An array from the type, String, that contains the groups for which the new item is a member. This array can also be null if the item should not be a member in any group.

locale: If you want to set the default value, you have to input null. See Localization and input parameters for more information about the locale descriptor.

Output

The output from the Web service is an object from the type, ItemIDWithTimeStamp. This contains the item ID and the timestamp of the last update for the new item.


Library | Support | Terms of use

(c) Copyright IBM Corporation 2004, 2009. All rights reserved.
U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.