com.netegrity.llsdk6.imsapi.abstractinterface
Interface AttributeCollection

All Superinterfaces:

java.util.Map, ModifiableObject

All Known Subinterfaces:

AccessRole, AccessTask, Account, AdminRole, AdminTask, AssignableObject, Container, Endpoint, EndpointCapability, EndpointGroup, ExploreAndCorrelateDef, Grantor, Group, ManagedObject, Namespace, Organization, PasswordPolicy, ProvisioningNonManagedObject, ProvisioningPolicy, ProvisioningPolicy, ProvisioningRole, Role, Task, User

public interface AttributeCollection
extends ModifiableObject, java.util.Map

Allows a custom object to access managed object attributes through the methods inherited from this interface.

This interface includes methods that restrict access to attributes according to the permissions, if any, in the managed object.

In the context of AttributeCollection, an attribute can have one of three kinds of values:

• Original value--The value assigned to the attribute when the AttributeCollection was created. An AttributeCollection is created when an instance of a managed object is created.
• Current value--The last value set for the attribute through the set... methods in this AttributeCollection.
• Committed value--The value that the attribute had the last time the managed object was committed to the data store.

If you access a managed object's attributes through the methods inherited from AttributeCollection, any changes you make to the attributes are committed to the data store as follows:

• Immediately after you call modifyObject(), if the managed object is accessed through ProviderAccessor.
• After events associated with the current task have been executed, if the managed object is accessed through a get... method of BLTHContext.
• After events associated with the current task have been executed, if the managed object is accessed through an event in EventContext, and the event in EventContext is one of the events that is successfully executed.

You do not use AttributeCollection when accessing a managed object through a tab handler.

For information about accessing managed objects and managed object attributes, see ManagedObject and the section Managed Objects in the Guide.

Since:

IdentityMinder 5.6

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

void	addAttributes(AttributeRightsCollection attrRequests) Adds the specified attributes to this attribute collection and fetches their values into the object.
void	addValueToAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Adds a value to the specified multi-value attribute.
boolean	containsAttribute(java.lang.String name) Determines whether the current managed object instance contains the specified attribute.
boolean	doesAttributeHaveMultipleValues(java.lang.String attributeName) Determines whether two or more values have been assigned to the specified attribute.
java.util.Vector	enumerateAttributes() Retrieves the names of all the attributes that are present in this instance of the managed object.
java.lang.String	getAttribute(java.lang.String attributeName) Retrieves the current value of the specified attribute.
java.util.Vector	getAttributeMultiValue(java.lang.String attributeName) Retrieves the current values of the specified multi-value attribute.
PermissionType	getAttributePermission(java.lang.String attributeName) Retrieves the current permission of the specified attribute.
java.util.Hashtable	getAttributes() Deprecated. Deprecated in IdentityMinder 6.0. Use of this method is strongly discouraged. Use an attribute retrieval method such as getAttribute() or getAttributeMultiValue().
ExtendedAttribute	getExtendedAttribute(java.lang.String attributeName) Get the underlying ExtendedAttribute object for an extended attribute.
java.lang.String	getLastCommittedAttribute(java.lang.String attributeName) Retrieves the value of the specified attribute as it existed when the managed object was last committed to the data store.
java.util.Vector	getLastCommittedAttributeMultiValue(java.lang.String attributeName) Retrieves the values of the specified multi-value attribute as they existed when the managed object was last committed to the data store.
java.lang.Object	getLastCommittedValue(java.lang.String attributeName) Get the last committed value of an attribute.
java.lang.String	getOriginalAttribute(java.lang.String attributeName) Retrieves the original value of the specified attribute.
java.util.Vector	getOriginalAttributeMultiValue(java.lang.String attributeName) Retrieves the original values of the specified multi-value attribute.
java.lang.Object	getOriginalValue(java.lang.String attributeName) Get the original value of an attribute.
java.lang.Object	getValue(java.lang.String attributeName) Get the current value of an attribute.
boolean	hasAttributeChanged(java.lang.String attributeName) Determines whether the current value of the specified attribute has changed from the original value when the instance of this managed object was created.
boolean	isAttributeUncommitted(java.lang.String attributeName) Determines whether the current value of the specified attribute is different from the value last committed to the data store.
boolean	isUncommitted() Determines whether any attribute in the collection is uncommitted.
void	makeCurrentValueOriginal(java.lang.String attributeName) Takes the current value of the attribute and makes it the original value.
void	removeAttributes(java.util.Vector attrNames) Removes the specified attributes from this attribute collection.
void	setAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Updates the current value of the specified attribute.
void	setAttributeMultiValue(java.lang.String attributeName, java.util.Vector values) Sets the current values of the specified multi-value attribute.
void	setAttributes(java.util.Hashtable attributes) Deprecated. Deprecated in IdentityMinder 6.0. Use of this method is strongly discouraged. Use a method such as setAttribute() or setAttributeMultiValue() to assign values to attributes.
void	setValue(java.lang.String attributeName, java.lang.Object value) Set the current value of an attribute.
void	updateAttributeSet(AttributeRightsCollection attrRequests) Updates the attributes in this attribute collection with the attributes specified in attrRequests.

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

containsAttribute

boolean containsAttribute(java.lang.String name)

Determines whether the current managed object instance contains the specified attribute.

This method is useful to call before attempting to retrieve an attribute with a method such as getAttribute() or getAttributeMultiValue(). If containsAttribute() returns true, your subsequent attempt to retrieve the attribute will not throw AttributeNotPresentException.

Parameters:

name - The name of the attribute to check.

Returns:

true if the attribute exists, or false otherwise.

doesAttributeHaveMultipleValues

boolean doesAttributeHaveMultipleValues(java.lang.String attributeName)
                                        throws SmApiException

Determines whether two or more values have been assigned to the specified attribute.

If the specified attribute is not included in the managed object instance, an exception is thrown.

This method checks the current value of the attribute, before the data is committed to the data store. The method does not determine whether the data store actually supports multiple values for this attribute.

This method does not consider any permissions that might be stored in the managed object instance for the specified attribute. The method will succeed as long as the instance contains the attribute.

Parameters:

attributeName - The name of the attribute.

Returns:

true if two or more values are currently assigned to the attribute, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - This AttributeCollection represents an object that can be deleted and that has already been deleted.

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

SmApiException

getAttributes

java.util.Hashtable getAttributes()

Deprecated. Deprecated in IdentityMinder 6.0. Use of this method is strongly discouraged. Use an attribute retrieval method such as getAttribute() or getAttributeMultiValue().

Retrieves the current attributes of the managed object, as set through this AttributeCollection.

This deprecated method ignores any permission information that might be stored in the managed object instance. Further, the method does not retrieve any permission information in the instance, if any.

Returns:

The current attributes and attribute values in the managed object instance.

enumerateAttributes

java.util.Vector enumerateAttributes()

Retrieves the names of all the attributes that are present in this instance of the managed object.

Returns:

A Vector of Strings containing the attribute names.

setAttributes

void setAttributes(java.util.Hashtable attributes)

Deprecated. Deprecated in IdentityMinder 6.0. Use of this method is strongly discouraged. Use a method such as setAttribute() or setAttributeMultiValue() to assign values to attributes.

Updates the current values of the specified attributes. Only the attributes specified in the attributes parameter are updated.

This deprecated method ignores any permission information that might be stored in the managed object instance. Further, the method does not set any permission information in the instance. Using this method can lead to cases where some of an object's attributes have permission information and others do not.

Note: This method updates the local (in-memory) representation of the current managed object. To commit the changes to the data store, call modifyObject(). The changes are then immediately persisted to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Parameters:

attributes - The attributes being set. Values of attributes unspecified in this parameter are unchanged.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - This AttributeCollection represents an object that can be deleted and that has already been deleted.

setAttribute

void setAttribute(java.lang.String attributeName,
                  java.lang.Object attributeValue)
                  throws SmApiException

Updates the current value of the specified attribute.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow write access. If it does not, AttributePermissionException is thrown.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Note: This method updates the local (in-memory) representation of the current managed object. To commit the changes to the data store, call modifyObject(). The changes are then immediately persisted to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Parameters:

attributeName - The name of the attribute to update.

attributeValue - The value to set for the attribute.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - This AttributeCollection represents an object that can be deleted and that has already been deleted.

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to set an attribute you have no write rights to.

com.netegrity.llsdk6.imsapi.exception.AttributeTypeException - Attempt to set an attribute with the wrong type data.

SmApiException

addValueToAttribute

void addValueToAttribute(java.lang.String attributeName,
                         java.lang.Object attributeValue)
                         throws SmApiException

Adds a value to the specified multi-value attribute. If the attribute is a single-value attribute, Identity Manager converts it to a multi-value attribute.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow write access. If it does not, AttributePermissionException is thrown.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Note: This method updates the local (in-memory) representation of the current managed object. To commit the changes to the data store, call modifyObject(). The changes are then immediately persisted to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Parameters:

attributeName - The name of the attribute to update.

attributeValue - The value to add to the attribute.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - This AttributeCollection represents an object that can be deleted and that has already been deleted.

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to set an attribute you have no write rights to.

com.netegrity.llsdk6.imsapi.exception.AttributeTypeException - Attempt to set an attribute with the wrong type data.

SmApiException

getAttribute

java.lang.String getAttribute(java.lang.String attributeName)
                              throws SmApiException

Retrieves the current value of the specified attribute.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow read access. If it does not, AttributePermissionException is thrown, and the attribute's value is not retrieved.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Parameters:

attributeName - The name of the attribute to retrieve.

Returns:

The current value of the specified attribute. If the attribute is multi-valued, the returned String will be the encoded version.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to read an attribute you have no read rights to.

SmApiException

getAttributeMultiValue

java.util.Vector getAttributeMultiValue(java.lang.String attributeName)
                                        throws SmApiException

Retrieves the current values of the specified multi-value attribute.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow read access. If it does not, AttributePermissionException is thrown, and the attribute's values are not retrieved.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Parameters:

attributeName - The name of the attribute to retrieve.

Returns:

Vector of zero or more strings representing the current values of this attribute.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - This AttributeCollection represents an object that can be deleted and that has already been deleted.

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to read an attribute you have no read rights to.

SmApiException

setAttributeMultiValue

void setAttributeMultiValue(java.lang.String attributeName,
                            java.util.Vector values)
                            throws SmApiException

Sets the current values of the specified multi-value attribute.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow write access. If it does not, AttributePermissionException is thrown.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Note: This method updates the local (in-memory) representation of the current managed object. To commit the changes to the data store, call modifyObject(). The changes are then immediately persisted to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Parameters:

attributeName - The name of the attribute to update.

values - A Vector strings to set for the attribute.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - This AttributeCollection represents an object that can be deleted and that has already been deleted.

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to set an attribute you have no write rights to.

com.netegrity.llsdk6.imsapi.exception.AttributeTypeException - Attempt to set an attribute with the wrong type data.

SmApiException

getOriginalAttribute

java.lang.String getOriginalAttribute(java.lang.String attributeName)
                                      throws SmApiException

Retrieves the original value of the specified attribute. The value retrieved is the value that was set for the attribute when the instance of the managed object was created.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow read access. If it does not, AttributePermissionException is thrown, and the attribute's original value is not retrieved.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Parameters:

attributeName - The name of the attribute to retrieve.

Returns:

The original value of the specified attribute. If the attribute is multi-valued, the returned String will be the encoded version.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to read an attribute you have no read rights to.

SmApiException

getOriginalAttributeMultiValue

java.util.Vector getOriginalAttributeMultiValue(java.lang.String attributeName)
                                                throws SmApiException

Retrieves the original values of the specified multi-value attribute. The values retrieved are the values that were set for the attribute when the instance of the managed object was created.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow read access. If it does not, AttributePermissionException is thrown, and the attribute's original values are not retrieved.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Parameters:

attributeName - The name of the multi-value attribute to retrieve.

Returns:

Vector of zero or more strings representing the original values of this attribute.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - This AttributeCollection represents an object that can be deleted and that has already been deleted.

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to read an attribute you have no read rights to.

SmApiException

getLastCommittedAttribute

java.lang.String getLastCommittedAttribute(java.lang.String attributeName)
                                           throws SmApiException

Retrieves the value of the specified attribute as it existed when the managed object was last committed to the data store. For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow read access. If it does not, AttributePermissionException is thrown, and the attribute's last-committed value is not retrieved.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Parameters:

attributeName - The name of the attribute to retrieve.

Returns:

The last-committed value of the attribute. If the attribute is multi-valued, the returned String will be the encoded version.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to read an attribute you have no read rights to.

SmApiException

getLastCommittedAttributeMultiValue

java.util.Vector getLastCommittedAttributeMultiValue(java.lang.String attributeName)
                                                     throws SmApiException

Retrieves the values of the specified multi-value attribute as they existed when the managed object was last committed to the data store.

For this method to succeed, both of the following conditions must be met:

• The specified attribute must be included in this instance of the managed object. If it is not, AttributeNotPresentException is thrown.
• The permission stored in the managed object for the specified attribute must allow read access. If it does not, AttributePermissionException is thrown, and the attribute's last-committed values are not retrieved.

If the managed object instance does not contain permission information (that is, if it was created by legacy methods or outside of task context), the method does not consider permission restrictions and will succeed if the attribute exists in the managed object instance.

Parameters:

attributeName - The name of the attribute to retrieve.

Returns:

Vector of zero or more strings representing the last-committed values of this attribute.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

com.netegrity.llsdk6.imsapi.exception.AttributePermissionException - Attempt to read an attribute you have no read rights to.

SmApiException

hasAttributeChanged

boolean hasAttributeChanged(java.lang.String attributeName)
                            throws SmApiException

Determines whether the current value of the specified attribute has changed from the original value when the instance of this managed object was created.

If the specified attribute is not included in the managed object instance, an exception is thrown.

This method does not consider any permissions that might be stored in the managed object instance for the specified attribute. The method will succeed as long as the instance contains the attribute.

Parameters:

attributeName - The name of the attribute to check.

Returns:

true if the value has changed, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

SmApiException

isAttributeUncommitted

boolean isAttributeUncommitted(java.lang.String attributeName)
                               throws SmApiException

Determines whether the current value of the specified attribute is different from the value last committed to the data store.

If the specified attribute is not included in the managed object instance, an exception is thrown. This method does not consider any permissions that might be stored in the managed object instance for the specified attribute. The method will succeed as long as the instance contains the attribute.

Parameters:

attributeName - The name of the attribute to check.

Returns:

true if the value has not been committed, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

SmApiException

getAttributePermission

PermissionType getAttributePermission(java.lang.String attributeName)
                                      throws SmApiException

Retrieves the current permission of the specified attribute. If the specified attribute is not included in this managed object, an exception is thrown.

Parameters:

attributeName - The name of the attribute.

Returns:

The current permission value of the specified attribute.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - This AttributeCollection does not contain a "slot" for attributeName. For example, if a User was created without requesting User.PROPERTY_FRIENDLY_NAME, you cannot call User.setAttribute(User.PROPERTY_FRIENDLY_NAME, object).

SmApiException

Since:

IdentityMinder 6.0

removeAttributes

void removeAttributes(java.util.Vector attrNames)

Removes the specified attributes from this attribute collection.

If any specified attributes are not present in the instance, the method ignores these attributes and still succeeds. Any uncommitted changes in the values of these attributes will be lost.

Parameters:

attrNames - A Vector of Strings containing the names of the attributes to remove.

Since:

IdentityMinder 6.0

addAttributes

void addAttributes(AttributeRightsCollection attrRequests)
                   throws SmApiException

Adds the specified attributes to this attribute collection and fetches their values into the object.

If any specified attributes are already present in the instance, the method updates the associated permissions with the maximum of the previous and new permissions. The attribute values themselves are not changed.

Parameters:

attrRequests - A Vector of objects containing attribute names and their associated permissions.

Throws:

SmApiException

Since:

IdentityMinder 6.0

updateAttributeSet

void updateAttributeSet(AttributeRightsCollection attrRequests)
                        throws SmApiException

Updates the attributes in this attribute collection with the attributes specified in attrRequests.

The attributes are updated according to the following conditions:

• If any attributes specified in attrRequests already exist in the instance, the original, last committed, and current values of the existing attributes remain in place. However, the permissions associated with the existing attributes may change, depending on the corresponding permission requests in AttributeRight.
• Attributes that already exist in the instance, but are not included in the new set specified in attrRequests, are lost, along with all information on the original, last committed, and current values.
• Attributes that do not exist in the instance, but are included in the new set specified in attrRequests, have their values and associated permissions fetched into the instance of the object.

Note: Updating the attributes in the current instance of the managed object allows the possibility of a "dirty read" of the object. This could occur if another user updates the same attributes in the same managed object since the current AttributeCollection was instantiated.

Parameters:

attrRequests - A collection of AttributeRight objects.

Throws:

SmApiException

Since:

IdentityMinder 6.0

makeCurrentValueOriginal

void makeCurrentValueOriginal(java.lang.String attributeName)
                              throws SmApiException

Takes the current value of the attribute and makes it the original value. Used to set initial values of logical attributes to an unchanged state.

Parameters:

attributeName -

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the attribute is not there

SmApiException

Since:

Framework r12

getValue

java.lang.Object getValue(java.lang.String attributeName)
                          throws SmApiException

Get the current value of an attribute. This method supports relationship objects.

Parameters:

attributeName -

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the attribute is not there

SmApiException

Since:

Framework r12

getLastCommittedValue

java.lang.Object getLastCommittedValue(java.lang.String attributeName)
                                       throws SmApiException

Get the last committed value of an attribute. This method supports relationship objects.

Parameters:

attributeName -

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the attribute is not there

SmApiException

Since:

Framework r12

getOriginalValue

java.lang.Object getOriginalValue(java.lang.String attributeName)
                                  throws SmApiException

Get the original value of an attribute. This method supports relationship object.

Parameters:

attributeName -

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the attribute is not there

SmApiException

Since:

Framework r12

setValue

void setValue(java.lang.String attributeName,
              java.lang.Object value)
              throws SmApiException

Set the current value of an attribute. This method supports relationship objects.

Parameters:

attributeName -

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the attribute is not there

SmApiException

Since:

Framework r12

getExtendedAttribute

ExtendedAttribute getExtendedAttribute(java.lang.String attributeName)
                                       throws SmApiException

Get the underlying ExtendedAttribute object for an extended attribute.

Parameters:

attributeName -

Returns:

ExtendedAttribute object or null

Throws:

SmApiException

Since:

Framework r12

isUncommitted

boolean isUncommitted()

Determines whether any attribute in the collection is uncommitted.

Returns:

true if there are any uncommitted attributes, or false otherwise.