com.netegrity.llsdk6.imsapi.managedobject
Interface Relationship

public interface Relationship

Relationship objects represents a relationship on a specific instance of a primary object.

Since:

Framework r12

Method Summary

void	addRelatedObject(ManagedObject relatedObj) Adds a given managed object to the primary managed object's relationship if this is multi-valued.
java.util.Collection	getAdded() Return the added objects.
ObjectType	getPrimaryObjectType() The primary object for this relationship
AttributeRightsCollection	getRelatedARC() Returns the current AttributeRightsCollection
ObjectType	getRelatedObjectType() The related object for this relationship
RelationshipProvider	getRelationshipProvider() Returns the relationship provider.
java.util.Collection	getRemoved() Return the removed objects.
boolean	isObjectRelated(ManagedObject relatedObj) Indicates whether a given managed object is related to the primary managed object
void	persistAddRelatedObject(ManagedObject relatedObj) Called by an event to immediately persist the adding of the related object.
void	persistRelatedObjectNameChange(java.lang.String oldUniqueName, java.lang.String newUniqueName) Immediately persist a name change to a related object.
void	persistRemoveRelatedObject(ManagedObject relatedObj) Called by an event to immediately persist th eremoving of the related object.
void	removeRelatedObject(ManagedObject relatedObj) Removes a given managed object from the primary managed object's relationship if this is multi-valued.
void	setRelatedARC(AttributeRightsCollection arc) When related objects are retrieved by this relationship, they are retrieved using the specified set of attribute rights.

Method Detail

getRelationshipProvider

RelationshipProvider getRelationshipProvider()

Returns the relationship provider.

getRelatedARC

AttributeRightsCollection getRelatedARC()

Returns the current AttributeRightsCollection

Returns:

null if no AttributeRightsCollection has been set

setRelatedARC

void setRelatedARC(AttributeRightsCollection arc)
                   throws SmApiException

When related objects are retrieved by this relationship, they are retrieved using the specified set of attribute rights. Once a related object has been retrieved, it is not possible to change the attribute rights collection here and an IllegalStateException is thrown.

Parameters:

arc -

Throws:

SmApiException

java.lang.IllegalStateException

getPrimaryObjectType

ObjectType getPrimaryObjectType()

The primary object for this relationship

getRelatedObjectType

ObjectType getRelatedObjectType()

The related object for this relationship

isObjectRelated

boolean isObjectRelated(ManagedObject relatedObj)
                        throws SmApiException

Indicates whether a given managed object is related to the primary managed object

Parameters:

relatedObj -

Returns:

boolean

Throws:

SmApiException

getAdded

java.util.Collection getAdded()
                              throws SmApiException

Return the added objects. This should be used in generating events that persist the objects added when the relationship is not persisted with the primary object.

Throws:

SmApiException

getRemoved

java.util.Collection getRemoved()
                                throws SmApiException

Return the removed objects. This should be used in generate events that persist the objects removed when the relationship is not persisted with the primary object.

Throws:

SmApiException

addRelatedObject

void addRelatedObject(ManagedObject relatedObj)
                      throws SmApiException

Adds a given managed object to the primary managed object's relationship if this is multi-valued. Sets the managed object for the relationship if this is single-valued. This call should persist this information. Depending on the implementation, this may result in a value stored on the primary managed object, or elsewhere. It may even equate to creating an event that represents the adding of the relationship

Parameters:

relatedObj -

Throws:

SmApiException

removeRelatedObject

void removeRelatedObject(ManagedObject relatedObj)
                         throws SmApiException

Removes a given managed object from the primary managed object's relationship if this is multi-valued. Clears the managed object for the relationship if this is single-valued. This call should persist this information. Depending on the implementation, this may result in a value stored on the primary managed object, or elsewhere. It may even equate to creating an event that represents the removal of the relationship

Parameters:

relatedObj -

Throws:

SmApiException

persistRelatedObjectNameChange

void persistRelatedObjectNameChange(java.lang.String oldUniqueName,
                                    java.lang.String newUniqueName)
                                    throws SmApiException

Immediately persist a name change to a related object. Called by a managed object based on the reversereferenceattribute during the modifyObject() of an unpersisted object.

Throws:

SmApiException

persistAddRelatedObject

void persistAddRelatedObject(ManagedObject relatedObj)
                             throws SmApiException

Called by an event to immediately persist the adding of the related object.

Throws:

SmApiException

persistRemoveRelatedObject

void persistRemoveRelatedObject(ManagedObject relatedObj)
                                throws SmApiException

Called by an event to immediately persist th eremoving of the related object.

Throws:

SmApiException