IAdmApprovalRequest
The IAdmApprovalRequest interface represents an approval request.
Inheritance: IAdmTop
Methods
-
Method
-
Description
-
Approve()
-
Approves the request.
-
Deny()
-
Denies the request.
-
Cancel()
-
Cancels the request.
-
GetApproversInfo()
-
Returns the IAdmRequestApproversInfo interface that represents request approvers – a list of users and groups who can process the request.
-
SetApproversInfo()
-
Updates the list of request approvers.
Properties
-
Property
-
Description
-
Requestor
-
Gets the user who performed the operation that was sent for approval.
-
ProcessedBy
-
Gets the user who approved or denied the request.
-
DescriptionOfOperationToApprove
-
Gets or sets a string description of the operation that was sent for approval.
-
DescriptionOfOperationToApproveXml
-
Gets or sets an XML-formatted description of the operation that was sent for approval.
-
ApprovalState
-
Gets the current state of the request.
-
CreationDate
-
Gets the date and time of the request creation.
-
TargetObject
-
Gets or sets the directory object targeted by the operation that was sent for approval.
-
TargetObjectParent
-
Gets or sets the parent of the directory object targeted by the operation that was sent for approval.
-
DenialOrCancelingReason
-
Gets the reason why the approval request was denied or cancelled.
Details
Approve()
Approves the request.
void Approve()
Remarks
To specify the reason for approval, approve requests using the IAdmApprovalRequest4::ApproveEx method.
Deny()
Denies the request.
void Deny(string reason)
Parameters
- reason – the reason why the approval request was denied.
Cancel()
Cancels the request.
void Cancel(string reason)
Parameters
- reason – the reason why the approval request was canceled.
GetApproversInfo()
Returns the IAdmRequestApproversInfo interface that represents request approvers – a list of users and groups who can process the request.
IAdmRequestApproversInfo GetApproversInfo()
SetApproversInfo()
Updates the list of request approvers.
void SetApproversInfo(IAdmRequestApproversInfo approversinfo)
Remarks
This method does not save the changes to the directory. Call IADs::SetInfo to save the changes.
Requestor
Gets the user who performed the operation that was sent for approval.
- Type:
- IAdmTop
- Access:
- Read-only
ProcessedBy
Gets the user who approved or denied the request.
- Type:
- IAdmTop
- Access:
- Read-only
DescriptionOfOperationToApprove
Gets or sets a string description of the operation that was sent for approval.
- Type:
- string
- Access:
- Read/Write
DescriptionOfOperationToApproveXml
Gets or sets an XML-formatted description of the operation that was sent for approval.
- Type:
- string
- Access:
- Read/Write
ApprovalState
Gets the current state of the request.
- Type:
- ADM_APPROVALSTATE_ENUM
- Access:
- Read-only
CreationDate
Gets the date and time of the request creation.
- Type:
- DateTime
- Access:
- Read-only
TargetObject
Gets or sets the directory object targeted by the operation that was sent for approval.
- Type:
- IAdmTop
- Access:
- Read/Write
TargetObjectParent
Gets or sets the parent of the directory object targeted by the operation that was sent for approval.
- Type:
- IAdmTop
- Access:
- Read/Write
DenialOrCancelingReason
Gets the reason why the approval request was denied or cancelled.
- Type:
- string
- Access:
- Read-only
Requirements
Minimum required version: 2009.1