org.opennms.gwt.web.ui.asset.client

Interface AssetService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

AssetServiceImpl

@RemoteServiceRelativePath(value="asset")
public interface AssetService
extends com.google.gwt.user.client.rpc.RemoteService

Author:

Markus Neumann
Client side GWT Interface for remote procedure calls (RPC) at asset services.

Method Summary

Modifier and Type	Method and Description
AssetCommand	getAssetByNodeId(int nodeId) Calling this method will return a AssetCommand with contains all asset data and additional data for GWT asset ui.
AssetSuggCommand	getAssetSuggestions() Calling this method will return an AssetSuggCommand that contains all suggestions for all FieldSetSuggestBoxes at the GWT asset ui.
Boolean	saveOrUpdateAssetByNodeId(int nodeId, AssetCommand asset) Calling this method will save or update a OnmsAsset by the given AssetCommand.

Method Detail

getAssetByNodeId

AssetCommand getAssetByNodeId(int nodeId)
                       throws Exception

Calling this method will return a AssetCommand with contains all asset data and additional data for GWT asset ui. If no OnmsNode is found by given nodeId a exception will occur.

Parameters:

nodeId - related to OnmsNode.

Returns:

AssetCommand by the given nodeId

Throws:

Exception - , used asset service can throw all types of exception

getAssetSuggestions

AssetSuggCommand getAssetSuggestions()
                              throws Exception

Calling this method will return an AssetSuggCommand that contains all suggestions for all FieldSetSuggestBoxes at the GWT asset ui.

Returns:

AssetSuggCommand

Throws:

Exception - , used asset service can throw all types of exception

saveOrUpdateAssetByNodeId

Boolean saveOrUpdateAssetByNodeId(int nodeId,
                                  AssetCommand asset)
                           throws Exception

Calling this method will save or update a OnmsAsset by the given AssetCommand. Problems will be thrown as exceptions.

Parameters:

nodeId - related to OnmsNode.

{@link - AssetCommand}

Returns:

If the operation went well result will be true, if not false.

Throws:

Exception - , used asset service can throw all types of exception