com.hp.ucmdb.api.topology

Interface TopologyModificationData

All Superinterfaces:

Serializable, TopologyData

public interface TopologyModificationData
extends TopologyData

Method Summary

Modifier and Type	Method and Description
void	addReferenceCI(CI ci) Adds the CI to the list of modifications.
CI	addReferenceCI(String type) Creates a new CI of the specified type and adds it to the list of modification.
CI	addReferenceCI(UcmdbId id, String type) Creates a new CI of the specified type ID and adds it to the list of modification.
void	addReferenceCIs(Iterable<? extends CI> cis) Adds all CIs from the collection to the list of modifications.
void	addReferenceRelation(Relation relation) Adds the specified relation to the list of modifications.
Relation	addReferenceRelation(String type, CI end1, CI end2) Creates a new relation of the specified type between the two CIs and adds it to the list of modifications.
Relation	addReferenceRelation(String type, UcmdbId end1, UcmdbId end2) Creates a new relation of the specified type between the CIs with the specified IDs and adds it to the list of modifications.
Relation	addReferenceRelation(UcmdbId id, String type, CI end1, CI end2)
Relation	addReferenceRelation(UcmdbId id, String type, UcmdbId end1, UcmdbId end2)
void	addReferenceRelations(Iterable<? extends Relation> relations) Adds the relations in the collection to the list of modifications.
String	getAdditionalModifierInfo()
ListPropertiesUpdate	getListPropertiesUpdate() Returns list properties to update or null
CI	getReferenceCI(UcmdbId id) Returns the CI in this collection having the specified id.
Iterable<CI>	getReferenceCIs() An Iterable collection of the reference CIs.
Iterable<Relation>	getReferenceRelations() An Iterable collection of the Relations to be modified.
boolean	hasReferenceCIs() Checks if there are any CIs in the list of modifications.
boolean	hasReferenceRelations() Checks if there are any Relations in the list of modifications.
boolean	isFromDelegateUser()
void	setFromDelegateUser(boolean fromDelegateUser)
TopologyModificationData	withListPropertiesUpdate(ListPropertiesUpdate listPropertiesUpdate) Set list properties to update

Methods inherited from interface com.hp.ucmdb.api.topology.TopologyData

addCI, addCI, addCI, addCIs, addRelation, addRelation, addRelation, addRelation, addRelation, addRelations, getCI, getCIs, getRelations, hasCIs, hasRelations

Method Detail

addReferenceCI

void addReferenceCI(CI ci)

Adds the CI to the list of modifications.

Parameters:

ci - The CI to add

addReferenceCIs

void addReferenceCIs(Iterable<? extends CI> cis)

Adds all CIs from the collection to the list of modifications.

Parameters:

cis - The cis to add

addReferenceCI

CI addReferenceCI(String type)

Creates a new CI of the specified type and adds it to the list of modification. The new CI has a temporary ID. This has the same effect as these two calls:
TopologyUpdateFactory.createCI(String)
TopologyData.addCI(com.hp.ucmdb.api.types.CI).

Parameters:

type - The type of the CI.

Returns:

CI

See Also:

TopologyUpdateFactory.createCI(String)

addReferenceCI

CI addReferenceCI(UcmdbId id,
                  String type)

Creates a new CI of the specified type ID and adds it to the list of modification. This has the same effect as these two calls:
TopologyUpdateFactory.createCI(com.hp.ucmdb.api.types.UcmdbId, String)
TopologyData.addCI(com.hp.ucmdb.api.types.CI).

Parameters:

id - the id of the CI.

type - The type of the CI.

Returns:

CI

See Also:

TopologyUpdateFactory.createCI(com.hp.ucmdb.api.types.UcmdbId, String)

addReferenceRelation

void addReferenceRelation(Relation relation)

Adds the specified relation to the list of modifications.

Parameters:

relation - The relation to add

addReferenceRelations

void addReferenceRelations(Iterable<? extends Relation> relations)

Adds the relations in the collection to the list of modifications.

Parameters:

relations - The relations to add

addReferenceRelation

Relation addReferenceRelation(String type,
                              CI end1,
                              CI end2)

Creates a new relation of the specified type between the two CIs and adds it to the list of modifications. The new relation has a temporary ID. This has the same effect as these two calls:
TopologyUpdateFactory.createRelation(String, com.hp.ucmdb.api.types.CI, com.hp.ucmdb.api.types.CI)
TopologyData.addRelation(com.hp.ucmdb.api.types.Relation)

Parameters:

type - The type of the relation

end1 - The end1 CI

end2 - The end2 CI

Returns:

relation

See Also:

TopologyUpdateFactory.createRelation(String, com.hp.ucmdb.api.types.CI, com.hp.ucmdb.api.types.CI)

addReferenceRelation

Relation addReferenceRelation(String type,
                              UcmdbId end1,
                              UcmdbId end2)

Creates a new relation of the specified type between the CIs with the specified IDs and adds it to the list of modifications. The new relation has a temporary ID. This has the same effect as these two calls:
TopologyUpdateFactory.createRelation(String, com.hp.ucmdb.api.types.UcmdbId, com.hp.ucmdb.api.types.UcmdbId)
TopologyData.addRelation(com.hp.ucmdb.api.types.Relation)

Parameters:

type - The type of the relation

end1 - The end1 CI id

end2 - The end2 CI id

Returns:

the created relation

See Also:

TopologyUpdateFactory.createRelation(String, com.hp.ucmdb.api.types.UcmdbId, com.hp.ucmdb.api.types.UcmdbId)

addReferenceRelation

Relation addReferenceRelation(UcmdbId id,
                              String type,
                              UcmdbId end1,
                              UcmdbId end2)

addReferenceRelation

Relation addReferenceRelation(UcmdbId id,
                              String type,
                              CI end1,
                              CI end2)

hasReferenceCIs

boolean hasReferenceCIs()

Checks if there are any CIs in the list of modifications.

Returns:

true if has at least one reference CI

getReferenceCIs

Iterable<CI> getReferenceCIs()

An Iterable collection of the reference CIs.

Returns:

iterable on all reference CIs

getReferenceCI

CI getReferenceCI(UcmdbId id)

Returns the CI in this collection having the specified id.

Parameters:

id - The ID of the requested reference CI

Returns:

CI

hasReferenceRelations

boolean hasReferenceRelations()

Checks if there are any Relations in the list of modifications.

Returns:

true if has at least one reference relation

getReferenceRelations

Iterable<Relation> getReferenceRelations()

An Iterable collection of the Relations to be modified.

Returns:

iterable on all reference relations

getAdditionalModifierInfo

String getAdditionalModifierInfo()

withListPropertiesUpdate

TopologyModificationData withListPropertiesUpdate(ListPropertiesUpdate listPropertiesUpdate)

Set list properties to update

Parameters:

listPropertiesUpdate -

Returns:

the updated TopologyModificationData

Since:

UCMDB 10.1

getListPropertiesUpdate

ListPropertiesUpdate getListPropertiesUpdate()

Returns list properties to update or null

Returns:

list properties to update or null

Since:

UCMDB 10.1

isFromDelegateUser

boolean isFromDelegateUser()

setFromDelegateUser

void setFromDelegateUser(boolean fromDelegateUser)