com.cisco.provisioning.cpe.api.search
Interface RecordData

public interface RecordData

The interface to get the record data returned from the Search. RecordSearchResults

Method Summary

Map<String,Object>	getDetails() Get the record properties.
Key	getPrimaryKey() Get Primary Key for the record.
List<Key>	getSecondaryKeys() Get secondary Keys for the record.

Method Detail

getPrimaryKey

Key getPrimaryKey()

Get Primary Key for the record.

Returns:

Primary Key for the record.
For device searches, always returns DeviceOid unless DeviceIDPattern was specified in DeviceSearchType.
For Node searches, returns the Node class.

getSecondaryKeys

List<Key> getSecondaryKeys()

Get secondary Keys for the record.

Returns:

Secondary Keys for the record.
For device searches, returns DeviceIDs other than DeviceOids if ReturnParameters.ALL was specified in DeviceSearchType.
For node searches, always returns Null.

getDetails

Map<String,Object> getDetails()

Get the record properties.

Returns:

The record properties. For device search using the ReturnParameters.ALL results are similar to IPDevice.getDetails(). NULL if searches for Node.