com.ibm.itim.dataservices.model

Class ObjectProfileEntity

java.lang.Object

com.ibm.itim.dataservices.model.ObjectProfileEntity

public class ObjectProfileEntity
extends java.lang.Object

Class that describes how a class in the data store maps to a semantic entity in the system's data model. For example, the inetOrgPerson class may be mapped to a Person entity in the data model. Along with the class association there are associations down to the attribute level, like which inetOrgPerson attribute will be used as the logical name of each Person entity.

Constructor Summary

Constructors

Constructor and Description
ObjectProfileEntity(ObjectProfile profile) Constructs an ObjectProfileEntity with a value object.

Method Summary

Modifier and Type	Method and Description
DistinguishedName	getDistinguishedName() Returns the distinguished name of the profile.
ObjectProfile	getProfile() Returns the ObjectProfile value object for this entity.
void	remove() Removes the entity from the data store.
void	update() Updates the ObjectProfile in the data store with the given ObjectProfile value object with recorded changes.
void	update(ObjectProfile profile) Deprecated. use update()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectProfileEntity

public ObjectProfileEntity(ObjectProfile profile)

Constructs an ObjectProfileEntity with a value object.

Parameters:

profile - ObjectProfile object holding the attributes of the profile.

Method Detail

getDistinguishedName

public DistinguishedName getDistinguishedName()

Returns the distinguished name of the profile.

Returns:

DistinguishedName of the profile.

getProfile

public ObjectProfile getProfile()

Returns the ObjectProfile value object for this entity.

Returns:

ObjectProfile for the entity.

update

public void update(ObjectProfile profile)
            throws ObjectNotFoundException,
                   ModelCommunicationException

Deprecated. use update()

Updates the ObjectProfile in the data store with the given ObjectProfile value object with recorded changes.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to a data integrity problem, or the entity may have been removed by another client.

update

public void update()
            throws ObjectNotFoundException,
                   ModelCommunicationException

Updates the ObjectProfile in the data store with the given ObjectProfile value object with recorded changes.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to a data integrity problem, or the entity may have been removed by another client.

remove

public void remove()
            throws ModelCommunicationException,
                   ModelRemoveException,
                   ObjectNotFoundException

Removes the entity from the data store.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to a data integrity problem, or the entity may have already been removed by another client.

ModelRemoveException - Thrown if unable to remove the entity of the data store.