com.prosyst.mprm.admin.devices.inventory

Interface FunctionalItemEx

All Superinterfaces:

com.prosyst.mbs.services.fim.FunctionalItem

public interface FunctionalItemEx
extends com.prosyst.mbs.services.fim.FunctionalItem

This interface extends the FunctionalItem interface with generic methods for operation invocation and properties setting/getting.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GATEWAY_ID Gateway ID property.

Fields inherited from interface com.prosyst.mbs.services.fim.FunctionalItem

NAME, OBJECT_CLASS, TAGS, UID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGatewayID() Returns the ID of the gateway on which this functional item resides, null for back-end functional items.
long	getLastPropertyUpdateTimestamp(java.lang.String property) Returns the time of the last update of given property, as reported by System.currentTimeMillis() or -1, if not known.
java.lang.String	getMainObjectClass() Returns the name of the main interface implemented by the underlying functional item (the interface at the bottom of the inheritance hierarchy).
java.util.List<java.lang.String>	getObjectClass() The names of the main functional item interface and all inherited interfaces.
java.lang.Object	getProperty(java.lang.String property) Reads the value of given property.
java.lang.Object	invokeOperation(java.lang.String operation, java.lang.Object... parameters) Executes the operation with the given input parameters.
void	setProperty(java.lang.String property, java.lang.Object value) Sets the value of given property.
void	synchronizeState() Synchronized functional item state from remote gateway.

Methods inherited from interface com.prosyst.mbs.services.fim.FunctionalItem

getAttributes, getItemMetadata, getName, getTags, getUID, setName, setTags

Field Detail

GATEWAY_ID

static final java.lang.String GATEWAY_ID

Gateway ID property. Can be used when searching Functional Items by LDAP filter (e.g. with DeviceInventory.listFunctionalItems(String, String) method}

See Also:

Constant Field Values

Method Detail

getGatewayID

java.lang.String getGatewayID()

Returns the ID of the gateway on which this functional item resides, null for back-end functional items.

Returns:

gateway ID or null

invokeOperation

java.lang.Object invokeOperation(java.lang.String operation,
                                 java.lang.Object... parameters)
                          throws java.lang.Exception

Executes the operation with the given input parameters.

Parameters:

operation - operation to execute

parameters - input parameters

Returns:

operation output

Throws:

java.lang.Exception - if error occurs while executing operation

setProperty

void setProperty(java.lang.String property,
                 java.lang.Object value)
          throws java.lang.Exception

Sets the value of given property.

Parameters:

property - property name

value - property new value

Throws:

java.lang.Exception - if error occurs while setting the property

getProperty

java.lang.Object getProperty(java.lang.String property)
                      throws java.lang.Exception

Reads the value of given property.

Parameters:

property - property name

Returns:

property value

Throws:

java.lang.Exception - if error occurs while reading property value

getLastPropertyUpdateTimestamp

long getLastPropertyUpdateTimestamp(java.lang.String property)
                             throws java.lang.Exception

Returns the time of the last update of given property, as reported by System.currentTimeMillis() or -1, if not known.

Parameters:

property - property name

Returns:

time-stamp or -1

Throws:

java.lang.Exception - if error occurs

getObjectClass

java.util.List<java.lang.String> getObjectClass()

The names of the main functional item interface and all inherited interfaces. Same as the Constants.OBJECTCLASS service reference property of the underlying FunctionalItem.

Specified by:

getObjectClass in interface com.prosyst.mbs.services.fim.FunctionalItem

Returns:

interfaces implemented by the underlying functional item

getMainObjectClass

java.lang.String getMainObjectClass()

Returns the name of the main interface implemented by the underlying functional item (the interface at the bottom of the inheritance hierarchy).

Returns:

underlying functional item main interface

synchronizeState

void synchronizeState()
               throws java.lang.Exception

Synchronized functional item state from remote gateway.

Throws:

java.lang.Exception - if error occurs