Oracle® Fusion Middleware .NET API Reference for Identity Connector Framework  E57662-01
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
Org.IdentityConnectors.Framework.Spi.Operations.UpdateAttributeValuesOp Interface Reference

More advanced implementation of Org.IdentityConnectors.Framework.Spi.Operations.UpdateOp to be implemented by connectors that wish to offer better performance and atomicity semantics for the methods Org.IdentityConnectors.Framework.Api.Operations.UpdateApiOp.AddAttributeValues(ObjectClass, Uid, ICollection{ConnectorAttribute}, OperationOptions) and Org.IdentityConnectors.Framework.Api.Operations.UpdateApiOp.RemoveAttributeValues(ObjectClass, Uid, ICollection{ConnectorAttribute}, OperationOptions). More...

Inherits Org.IdentityConnectors.Framework.Spi.Operations.UpdateOp.

Public Member Functions

Uid AddAttributeValues (ObjectClass objclass, Uid uid, ICollection< ConnectorAttribute > valuesToAdd, OperationOptions options)
 Update the object specified by the ObjectClass and Uid, adding to the current values of each attribute the values provided. More...
 
Uid RemoveAttributeValues (ObjectClass objclass, Uid uid, ICollection< ConnectorAttribute > valuesToRemove, OperationOptions options)
 Update the object specified by the ObjectClass and Uid, removing from the current values of each attribute the values provided. More...
 
- Public Member Functions inherited from Org.IdentityConnectors.Framework.Spi.Operations.UpdateOp
Uid Update (ObjectClass objclass, Uid uid, ICollection< ConnectorAttribute > replaceAttributes, OperationOptions options)
 Update the object specified by the ObjectClass and Uid, replacing the current values of each attribute with the values provided. More...
 

Detailed Description

More advanced implementation of Org.IdentityConnectors.Framework.Spi.Operations.UpdateOp to be implemented by connectors that wish to offer better performance and atomicity semantics for the methods Org.IdentityConnectors.Framework.Api.Operations.UpdateApiOp.AddAttributeValues(ObjectClass, Uid, ICollection{ConnectorAttribute}, OperationOptions) and Org.IdentityConnectors.Framework.Api.Operations.UpdateApiOp.RemoveAttributeValues(ObjectClass, Uid, ICollection{ConnectorAttribute}, OperationOptions).

Member Function Documentation

Uid Org.IdentityConnectors.Framework.Spi.Operations.UpdateAttributeValuesOp.AddAttributeValues ( ObjectClass  objclass,
Uid  uid,
ICollection< ConnectorAttribute valuesToAdd,
OperationOptions  options 
)

Update the object specified by the ObjectClass and Uid, adding to the current values of each attribute the values provided.

For each attribute that the input set contains, add to the current values of that attribute in the target object all of the values of that attribute in the input set.

NOTE that this does not specify how to handle duplicate values. The general assumption for an attribute of a

ConnectorObject

is that the values for an attribute may contain duplicates. Therefore, in general simply append the provided values to the current value for each attribute.

Parameters
objclassthe type of object to modify. Will never be null.
uidthe uid of the object to modify. Will never be null.
valuesToAddset of ConnectorAttribute deltas. The values for the attributes in this set represent the values to add to attributes in the object. merged. This set will never include OperationalAttributes. Will never be null.
optionsadditional options that impact the way this operation is run. Will never be null.
Returns
the Uid of the updated object in case the update changes the formation of the unique identifier.
Exceptions
Org.IdentityConnectors.Framework.Common.Exceptions.UnknownUidExceptioniff the Uid does not exist on the resource.
Uid Org.IdentityConnectors.Framework.Spi.Operations.UpdateAttributeValuesOp.RemoveAttributeValues ( ObjectClass  objclass,
Uid  uid,
ICollection< ConnectorAttribute valuesToRemove,
OperationOptions  options 
)

Update the object specified by the ObjectClass and Uid, removing from the current values of each attribute the values provided.

For each attribute that the input set contains, remove from the current values of that attribute in the target object any value that matches one of the values of the attribute from the input set.

NOTE that this does not specify how to handle unmatched values. The general assumption for an attribute of a

ConnectorObject

is that the values for an attribute are merely representational state. Therefore, the implementer should simply ignore any provided value that does not match a current value of that attribute in the target object. Deleting an unmatched value should always succeed.

Parameters
objclassthe type of object to modify. Will never be null.
uidthe uid of the object to modify. Will never be null.
valuesToRemoveset of ConnectorAttribute deltas. The values for the attributes in this set represent the values to remove from attributes in the object. merged. This set will never include OperationalAttributes. Will never be null.
optionsadditional options that impact the way this operation is run. Will never be null..
Returns
the Uid of the updated object in case the update changes the formation of the unique identifier.
Exceptions
Org.IdentityConnectors.Framework.Common.Exceptions.UnknownUidExceptioniff the Uid does not exist on the resource.

The documentation for this interface was generated from the following file: