com.kuka.nav.object.manager
Interface ObjectManager

public interface ObjectManager

API for the ObjectManager.

Method Summary

boolean	add(LocalizedObject object) Adds the given object to the ObjectManager in case it is not already managed.
boolean	addAll(Collection<LocalizedObject> objects) Adds the given objects to ObjectManager in case they are not already managed.
boolean	addAll(LocalizedObject... objects) Adds the given objects to the ObjectManager in case they are not already managed.
Collection<LocalizedObject>	getAll() Returns all currently managed objects (on all maps).
Collection<LocalizedObject>	getAll(int mapId) Returns all currently managed objects on the given map.
Collection<LocalizedObject>	getAll(int mapId, String name) Returns all currently managed objects of a given template id (i.e. object type) on the given map.
boolean	remove(LocalizedObject object) Removes the given LocalizedObject from the ObjectManager in case it is currently managed.
boolean	removeAll() Removes all currently managed LocalizedObjects from the ObjectManager.
boolean	removeAll(Collection<LocalizedObject> objects) Removes one or more LocalizedObjects from the ObjectManager.
boolean	removeAll(LocalizedObject... objects) Removes the given LocalizedObjects from the ObjectManager in case they are currently managed.

Method Detail

add

boolean add(LocalizedObject object)

Adds the given object to the ObjectManager in case it is not already managed.

Parameters:

object - LocalizedObject to add to the ObjectManger

Returns:

true if the collection of managed objects changed as a result of the call

addAll

boolean addAll(Collection<LocalizedObject> objects)

Adds the given objects to ObjectManager in case they are not already managed.

Parameters:

objects - Collection of LocalizedObjects

Returns:

true if the collection of managed objects changed as a result of the call

addAll

boolean addAll(LocalizedObject... objects)

Adds the given objects to the ObjectManager in case they are not already managed.

Parameters:

objects - arbitrary number of LocalizedObjects to add

Returns:

true if the collection of managed objects changed as a result of the call

remove

boolean remove(LocalizedObject object)

Removes the given LocalizedObject from the ObjectManager in case it is currently managed.

Parameters:

object - LocalizedObject to remove

Returns:

true if the object was removed as a result of this call

removeAll

boolean removeAll(LocalizedObject... objects)

Removes the given LocalizedObjects from the ObjectManager in case they are currently managed.

Parameters:

objects - Collection of LocalizedObjects to remove

Returns:

true if one or more objects were removed as a result of this call

removeAll

boolean removeAll(Collection<LocalizedObject> objects)

Removes one or more LocalizedObjects from the ObjectManager.

Parameters:

objects - arbitrary number of LocalizedObjects to remove

Returns:

true if an element was removed as a result of this call

removeAll

boolean removeAll()

Removes all currently managed LocalizedObjects from the ObjectManager.

Returns:

true if one or more objects were removed as a result of this call

getAll

Collection<LocalizedObject> getAll()

Returns all currently managed objects (on all maps).

Returns:

Collection of all currently managed LocalizedObjects

getAll

Collection<LocalizedObject> getAll(int mapId)

Returns all currently managed objects on the given map.

Parameters:

mapId - the id of the map

Returns:

Collection of all LocalizedObjects that are currently managed on the map with given id

getAll

Collection<LocalizedObject> getAll(int mapId,
                                   String name)

Returns all currently managed objects of a given template id (i.e. object type) on the given map.

Parameters:

mapId - the id of the map

name - the template name

Returns:

Collection of all LocalizedObjects of the given template id that are currently managed on the map with given id