com.netegrity.llsdk6.imsapi.abstractinterface
Interface ModifiableObject

All Known Subinterfaces:

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

public interface ModifiableObject

Commits the current object's attribute values to the data store.

Note: The modifyObject() method in this interface immediately persists attribute changes to the data store. All Identity Manager data and security checks are bypassed. Typically, this method is only called after you modify a managed object retrieved through one of the provider objects.

Since:

IdentityMinder 6.0

Method Summary

java.lang.Object	modifyObject() Updates the data store with the attribute values in the current managed object.
java.lang.Object	modifyObject(java.util.Hashtable extraProperties) Updates the data store with the attribute values in the current managed object.

Method Detail

modifyObject

java.lang.Object modifyObject()
                              throws SmApiException

Updates the data store with the attribute values in the current managed object.

This method commits to the data store any changes made to the current managed object's local (in-memory) attribute set.

If you want to associate a complete list of tasks with the role, call modifyObject(Task[]). You can call modifyObject(Task[]) to set a complete list of tasks for a role whether or not you are also committing attribute changes for the role.

Note: modifyObject() immediately persists attribute changes to the data store. All Identity Manager data and security checks are bypassed. Typically, this method is only called after you modify a managed object retrieved through one of the provider objects.

Returns:

The object written to the directory.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this ModifiableObject is also a ConnectableObject and the object is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this interface represents an object that can be deleted, and that has already been deleted

SmApiException

modifyObject

java.lang.Object modifyObject(java.util.Hashtable extraProperties)
                              throws SmApiException

Updates the data store with the attribute values in the current managed object.

This method commits to the data store any changes made to the current managed object's local (in-memory) attribute set.

If you want to associate a complete list of tasks with the role, call modifyObject(Task[]). You can call modifyObject(Task[]) to set a complete list of tasks for a role whether or not you are also committing attribute changes for the role.

Note: modifyObject() immediately persists attribute changes to the data store. All Identity Manager data and security checks are bypassed. Typically, this method is only called after you modify a managed object retrieved through one of the provider objects.

Parameters:

extraProperties - takes in a ProvisioningDefinitionImpl.ETADMIN_OPERATION_ID_ATTRIBURE and optionally returns back a TunnelObject.DS_RETURN_MESSAGE_ATTR

Returns:

The object written to the directory.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this ModifiableObject is also a ConnectableObject and the object is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this interface represents an object that can be deleted, and that has already been deleted

SmApiException