sailpoint.object

## Class ProvisioningPlan.AbstractRequest

- java.lang.Object
- - AbstractXmlObject
  - - sailpoint.object.ProvisioningPlan.AbstractRequest

Direct Known Subclasses:
  ProvisioningPlan.AccountRequest, ProvisioningPlan.ObjectRequest

Enclosing interface:
  ProvisioningPlan

    public abstract static class ProvisioningPlan.AbstractRequest
    extends AbstractXmlObject

The common representation of a request for one resource object. This is subclassed by ObjectRequest and AccountRequest.

### Constructor Summary

Constructors
Constructor and Description
`AbstractRequest()`
`AbstractRequest(java.util.Map map)`
`AbstractRequest(ProvisioningPlan.AbstractRequest src)`

### Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
`void` `add(ProvisioningPlan.GenericRequest req)`
`void` `addAll(java.util.Collection<? extends ProvisioningPlan.GenericRequest> reqs)`
`void` `addArgument(java.lang.String key, java.lang.Object value)`
`void` `addAssignmentIds(java.lang.String ids)` Add an assignment id to the list.
`void` `clone(ProvisioningPlan.AbstractRequest src)` Copy the contents of one object into another.
`ProvisioningPlan.AbstractRequest` `cloneRequest()` Clone one object from another.
`void` `cloneRequestProperties(ProvisioningPlan.AbstractRequest src)` Copy target properties from one request to another but not the attribute or permission requests.
`ProvisioningPlan.AbstractRequest` `collapse(boolean includeNullSet)` Collapse attribute and permission requests from this account or object request.
`void` `fromMap(java.util.Map map)`
`java.lang.Object` `get(java.lang.String name)`
`AccountMatchConfig` `getAccountSelector()`
`Rule` `getAccountSelectorRule()` Deprecated. This is no longer the proper way to configure account selections Use `getAccountSelector()`
`java.lang.String` `getApplication()`
`Application` `getApplication(Resolver resolver)` Convenience method to get the Application.
`java.lang.String` `getApplicationName()`
`java.lang.Object` `getArgument(java.lang.String name)`
`<any>` `getArguments()`
`java.util.List<java.lang.String>` `getAssignmentIdList()` Get the assignment ids as a list.
`java.lang.String` `getAssignmentIds()` Get the assignment id csv.
`ProvisioningPlan.AttributeRequest` `getAttributeRequest(java.lang.String name)`
`java.util.List<ProvisioningPlan.AttributeRequest>` `getAttributeRequests()`
`java.util.List<ProvisioningPlan.AttributeRequest>` `getAttributeRequests(java.lang.String name)`
`java.lang.String` `getComments()`
`java.lang.String` `getInstance()`
`java.lang.String` `getNativeIdentity()`
`ProvisioningPlan.ObjectOperation` `getOp()`
`ProvisioningPlan.PermissionRequest` `getPermissionRequest(java.lang.String target)`
`java.util.List<ProvisioningPlan.PermissionRequest>` `getPermissionRequests()`
`java.util.List<ProvisioningPlan.PermissionRequest>` `getPermissionRequests(java.lang.String target)`
`<T extends ProvisioningPlan.GenericRequest> T` `getRequest(java.util.List<T> reqs, java.lang.String name)`
`ProvisioningResult` `getResult()`
`java.lang.String` `getSourceRole()` The name of the role that needs this account, used only when expanding roles that have the allowMultipleAccounts option.
`java.lang.String` `getString(java.lang.String name)`
`java.lang.String` `getTargetIntegration()`
`java.lang.String` `getTrackingId()`
`java.lang.String` `getType()`
`java.lang.String` `getUnmappedApplication()`
`java.lang.String` `getUuid()`
`boolean` `hasAssignmentId(java.lang.String id)` Return true if an assignment id is on the list.
`abstract ProvisioningPlan.AbstractRequest` `instantiate()` Must be implemented in the subclass to create the same class of object from another.
`boolean` `isAccountRequest()`
`boolean` `isCleanable()`
`boolean` `isEmpty()`
`boolean` `isGroupRequest()`
`boolean` `isTargetMatch(ProvisioningPlan.AbstractRequest other)` Return true if the target object of this request matches that of another.
`void` `put(java.lang.String name, java.lang.Object value)`
`void` `remove(ProvisioningPlan.GenericRequest req)`
`void` `setAccountSelector(AccountMatchConfig match)`
`void` `setAccountSelectorRule(Rule rule)` Deprecated.
`void` `setApplication(java.lang.String s)`
`void` `setArguments(<any> atts)`
`void` `setAssignmentIds(java.lang.String ids)`
`void` `setAttributeRequests(java.util.List<ProvisioningPlan.AttributeRequest> reqs)`
`void` `setCleanable(boolean b)`
`void` `setComments(java.lang.String c)`
`void` `setInstance(java.lang.String instance)`
`void` `setNativeIdentity(java.lang.String id)`
`void` `setOp(ProvisioningPlan.ObjectOperation op)` Set the operation to perform on this object.
`void` `setPermissionRequests(java.util.List<ProvisioningPlan.PermissionRequest> reqs)`
`void` `setResult(ProvisioningResult r)`
`void` `setSourceRole(java.lang.String s)`
`void` `setTargetIntegration(java.lang.String name)`
`void` `setTrackingId(java.lang.String trackingId)`
`void` `setType(java.lang.String s)`
`void` `setUnmappedApplication(java.lang.String s)`
`void` `setUuid(java.lang.String uuid)`
`java.util.Map` `toMap()` Render the request in a generic Map/List model for JSON conversion.

### Methods inherited from class java.lang.Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### Constructor Detail

#### AbstractRequest

    public AbstractRequest()

#### AbstractRequest

    public AbstractRequest(java.util.Map map)

#### AbstractRequest

    public AbstractRequest(ProvisioningPlan.AbstractRequest src)

### Method Detail

#### instantiate

    public abstract ProvisioningPlan.AbstractRequest instantiate()

Must be implemented in the subclass to create the same class of object from another.

#### clone

    public void clone(ProvisioningPlan.AbstractRequest src)

Copy the contents of one object into another.

#### cloneRequest

    public ProvisioningPlan.AbstractRequest cloneRequest()

Clone one object from another. Note that this has to be named cloneResourceRequest because there are other clone() methods in the subclasses that return the subclass.

#### cloneRequestProperties

    public void cloneRequestProperties(ProvisioningPlan.AbstractRequest src)

Copy target properties from one request to another but not the attribute or permission requests. Used in the implementation of plan itemization and cloning.

#### add

    public void add(ProvisioningPlan.GenericRequest req)

#### addAll

    public void addAll(java.util.Collection<? extends ProvisioningPlan.GenericRequest> reqs)

#### remove

    public void remove(ProvisioningPlan.GenericRequest req)

#### isEmpty

    public boolean isEmpty()

#### collapse

    public ProvisioningPlan.AbstractRequest collapse(boolean includeNullSet)

Collapse attribute and permission requests from this account or object request. If all items collapse we collapse.

#### getUuid

    public java.lang.String getUuid()

#### setUuid

    public void setUuid(java.lang.String uuid)

#### getApplication

    public java.lang.String getApplication()

#### getApplicationName

    public java.lang.String getApplicationName()

#### setApplication

    public void setApplication(java.lang.String s)

#### getUnmappedApplication

    public java.lang.String getUnmappedApplication()

#### setUnmappedApplication

    public void setUnmappedApplication(java.lang.String s)

#### getApplication

    public Application getApplication(Resolver resolver)
                               throws GeneralException

Convenience method to get the Application.

Throws:
  `GeneralException`

#### getInstance

    public java.lang.String getInstance()

#### setInstance

    public void setInstance(java.lang.String instance)

#### getType

    public java.lang.String getType()

#### setType

    public void setType(java.lang.String s)

#### getNativeIdentity

    public java.lang.String getNativeIdentity()

#### setNativeIdentity

    public void setNativeIdentity(java.lang.String id)

#### getSourceRole

    public java.lang.String getSourceRole()

The name of the role that needs this account, used only when expanding roles that have the allowMultipleAccounts option.

#### setSourceRole

    public void setSourceRole(java.lang.String s)

#### getAccountSelectorRule

    @Deprecated
    public Rule getAccountSelectorRule()

Deprecated. This is no longer the proper way to configure account selections Use `getAccountSelector()`
Get the account selection rule for this request. This is transient, used only by AssignmentExpander.

#### setAccountSelectorRule

    @Deprecated
    public void setAccountSelectorRule(Rule rule)

Deprecated.

#### getAccountSelector

    public AccountMatchConfig getAccountSelector()

#### setAccountSelector

    public void setAccountSelector(AccountMatchConfig match)

#### setOp

    public void setOp(ProvisioningPlan.ObjectOperation op)

Set the operation to perform on this object.

For backward compatibility with AccountRequest there are two operation enumerations, ObjectOperation and AccountRequest.Operation with a corresponding set of property methods. The values of the enumerations are identical and methods that set AccountRequest.Operation will be converted to ObjectOperations.

#### getOp

    public ProvisioningPlan.ObjectOperation getOp()

#### getArguments

    public <any> getArguments()

#### getArgument

    public java.lang.Object getArgument(java.lang.String name)

#### addArgument

    public void addArgument(java.lang.String key,
                            java.lang.Object value)

#### setArguments

    public void setArguments(<any> atts)

#### getAttributeRequests

    public java.util.List<ProvisioningPlan.AttributeRequest> getAttributeRequests()

#### setAttributeRequests

    public void setAttributeRequests(java.util.List<ProvisioningPlan.AttributeRequest> reqs)

#### getPermissionRequests

    public java.util.List<ProvisioningPlan.PermissionRequest> getPermissionRequests()

#### setPermissionRequests

    public void setPermissionRequests(java.util.List<ProvisioningPlan.PermissionRequest> reqs)

#### getTrackingId

    public java.lang.String getTrackingId()

#### setTrackingId

    public void setTrackingId(java.lang.String trackingId)

#### getTargetIntegration

    public java.lang.String getTargetIntegration()

#### setTargetIntegration

    public void setTargetIntegration(java.lang.String name)

#### getResult

    public ProvisioningResult getResult()

#### setResult

    public void setResult(ProvisioningResult r)

#### isCleanable

    public boolean isCleanable()

#### setCleanable

    public void setCleanable(boolean b)

#### getAssignmentIds

    public java.lang.String getAssignmentIds()

Get the assignment id csv.

#### setAssignmentIds

    public void setAssignmentIds(java.lang.String ids)

#### getAssignmentIdList

    public java.util.List<java.lang.String> getAssignmentIdList()

Get the assignment ids as a list. Internally this is maintained as a csv for cleaner XML.

#### addAssignmentIds

    public void addAssignmentIds(java.lang.String ids)

Add an assignment id to the list.

#### hasAssignmentId

    public boolean hasAssignmentId(java.lang.String id)

Return true if an assignment id is on the list. Since these are uuids separated by commas a substring match is reliable.

#### getComments

    public java.lang.String getComments()

#### setComments

    public void setComments(java.lang.String c)

#### put

    public void put(java.lang.String name,
                    java.lang.Object value)

#### get

    public java.lang.Object get(java.lang.String name)

#### getString

    public java.lang.String getString(java.lang.String name)

#### isTargetMatch

    public boolean isTargetMatch(ProvisioningPlan.AbstractRequest other)

Return true if the target object of this request matches that of another.

#### getAttributeRequest

    public ProvisioningPlan.AttributeRequest getAttributeRequest(java.lang.String name)

#### getAttributeRequests

    public java.util.List<ProvisioningPlan.AttributeRequest> getAttributeRequests(java.lang.String name)

#### getPermissionRequest

    public ProvisioningPlan.PermissionRequest getPermissionRequest(java.lang.String target)

#### getPermissionRequests

    public java.util.List<ProvisioningPlan.PermissionRequest> getPermissionRequests(java.lang.String target)

#### getRequest

    public <T extends ProvisioningPlan.GenericRequest> T getRequest(java.util.List<T> reqs,
                                                                    java.lang.String name)

#### isAccountRequest

    public boolean isAccountRequest()

#### isGroupRequest

    public boolean isGroupRequest()

#### toMap

    public java.util.Map toMap()

Render the request in a generic Map/List model for JSON conversion. Note that the ProvisioningResult is not included here.

#### fromMap

    public void fromMap(java.util.Map map)