Package oracle.iam.request.vo

Interface Request

public interface Request
This value object stores information about a Request.

  • Method Details

    • setRequestModelName

      void setRequestModelName(String modelName)

    • getRequestModelName

      String getRequestModelName()
      Gets the request model name set with this request
      Returns:
      request model name set with this request

    • setRequestTemplateName

      @Deprecated void setRequestTemplateName(String templateName)
      Deprecated.

    • getRequestTemplateName

      @Deprecated String getRequestTemplateName()
      Deprecated.
      Gets the request template name set with this request
      Returns:
      request template name set with this request

    • setJustification

      void setJustification(String justification)

    • getJustification

      String getJustification()
      Gets the justification of this request
      Returns:
      justification of this request

    • setRequestStatus

      void setRequestStatus(String status)

    • getRequestStatus

      String getRequestStatus()
      Gets the status set with this request
      Returns:
      The status set with this request

    • setRequestStage

      void setRequestStage(long stageKey)

    • getRequestStage

      long getRequestStage()
      Gets the request stage key set with this request
      Returns:
      The request stage key

    • setRequestID

      void setRequestID(String id)

    • getRequestID

      String getRequestID()
      Gets the request id of this request
      Returns:
      The request id

    • setParentRequest

      void setParentRequest(Request parent)

    • getParentRequest

      Request getParentRequest()
      Gets the parent request object of this request
      Returns:
      The parent request

    • setChildRequests

      void setChildRequests(List<Request> childRequests)

    • getChildRequests

      List<Request> getChildRequests()
      Gets a list of requests set as child of this request
      Returns:
      A list of request set as child of this request

    • setExecutionDate

      void setExecutionDate(Date date)

    • getExecutionDate

      Date getExecutionDate()
      Gets the requested operation initiated date
      Returns:
      The requested operation initiated date

    • setTargetEntities

      void setTargetEntities(List<RequestEntity> entities)

    • getTargetEntities

      List<RequestEntity> getTargetEntities()
      Gets a list of request entities set with this request
      Returns:
      A list of RequestEntity

    • setBeneficiaries

      void setBeneficiaries(List<Beneficiary> beneficiary)

    • getBeneficiaries

      List<Beneficiary> getBeneficiaries()
      Gets a list of Beneficiary objects set with this request
      Returns:
      A list of Beneficiary

    • setRequestKey

      void setRequestKey(Long key)

    • getRequestKey

      Long getRequestKey()
      Gets the unique key of this request
      Returns:
      key of this request

    • getRequesterKey

      String getRequesterKey()

    • getCreationDate

      Date getCreationDate()
      Gets the date on which this request was created
      Returns:
      The date on which this request was created

    • setCreationDate

      void setCreationDate(Date date)

    • isParent

      String isParent()
      Checks if this request has child requests
      Returns:
      "true" if this request has child request, "false" otherwise

    • setIsParent

      void setIsParent(String isParent)

    • getOrchID

      long getOrchID()
      Gets the orchestration id set for this request
      Returns:
      orchestration id set for this request

    • setOrchID

      void setOrchID(long orchID)

    • getEventID

      long getEventID()
      Gets the orchestration event id for this request
      Returns:
      The Orchestration event id

    • setEventID

      void setEventID(long eventID)

    • getBeneficiaryType

      String getBeneficiaryType()
      Gets the beneficiary type for this request. If the request raised is for provision based model, it returns either User or Organization
      Returns:
      Beneficiary type for this request

    • setBeneficiaryType

      void setBeneficiaryType(String beneficiaryType)

    • getApprovalData

      List<oracle.iam.request.vo.ApprovalData> getApprovalData()
      Gets the Approval details i.e process id, current status, for this request
      Returns:
      Approval details for this request

    • setApprovalData

      void setApprovalData(List<oracle.iam.request.vo.ApprovalData> approvalData)

    • getEndDate

      Date getEndDate()
      Gets the date on which this request ended
      Returns:
      End date of this request

    • setEndDate

      void setEndDate(Date date)

    • getTemplateAttributes

      List<RequestTemplateAttribute> getTemplateAttributes()
      Gets the list of additional attributes defined in Request template set in this request
      Returns:
      List of RequestTemplateAttributes

    • setTemplateAttributes

      void setTemplateAttributes(List<RequestTemplateAttribute> templateAttributes)

    • getReasonForFailure

      String getReasonForFailure()
      Returns:

    • setReasonForFailure

      void setReasonForFailure(String error)
      Parameters:
      error -

    • isRequestWithdrawAllowed

      boolean isRequestWithdrawAllowed(List<RequestStage> requestStages)
      Checks whether the requester is allowed to be close/withdrawn or not. If the child requests status is not in approval status, then the request cann't be withdrawn or closed.
      Returns:

    • getAdditionalAttributes

      List<RequestTemplateAttribute> getAdditionalAttributes()
      Gets the list of additional attributes set in this request
      Returns:
      List of RequestTemplateAttributes

    • setAdditionalAttributes

      void setAdditionalAttributes(List<RequestTemplateAttribute> additionalAttributes)
      Sets addition attributes to this request.
      Parameters:
      templateAttributes - List of RequestTemplateAttribute

    • getDependsOnRequestId

      String getDependsOnRequestId()

    • setIsDirectOperation

      void setIsDirectOperation(boolean isDirectOperation)
      Sets the flag to determine if the request turns into a direct operation or not.
      Parameters:
      isDirectOperation - - true if request results in direct operation, false otherwise

    • isDirectOperation

      boolean isDirectOperation()
      Returns:
      true - if request resulted into a direct operation, false otherwise