Class: SDM::Workflow

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

Workflows are the collection of rules that define the resources to which access can be requested, the users that can request that access, and the mechanism for approving those requests which can either but automatic approval or a set of users authorized to approve the requests.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_rules: nil, auto_grant: nil, description: nil, enabled: nil, id: nil, name: nil, weight: nil) ⇒ Workflow

Returns a new instance of Workflow.



9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
# File 'lib/models/porcelain.rb', line 9730

def initialize(
  access_rules: nil,
  auto_grant: nil,
  description: nil,
  enabled: nil,
  id: nil,
  name: nil,
  weight: nil
)
  @access_rules = access_rules == nil ? SDM::_porcelain_zero_value_access_rules() : access_rules
  @auto_grant = auto_grant == nil ? false : auto_grant
  @description = description == nil ? "" : description
  @enabled = enabled == nil ? false : enabled
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @weight = weight == nil ? 0 : weight
end

Instance Attribute Details

#access_rulesObject

AccessRules is a list of access rules defining the resources this Workflow provides access to.



9712
9713
9714
# File 'lib/models/porcelain.rb', line 9712

def access_rules
  @access_rules
end

#auto_grantObject

Optional auto grant setting to automatically approve requests or not, defaults to false.



9714
9715
9716
# File 'lib/models/porcelain.rb', line 9714

def auto_grant
  @auto_grant
end

#descriptionObject

Optional description of the Workflow.



9716
9717
9718
# File 'lib/models/porcelain.rb', line 9716

def description
  @description
end

#enabledObject

Optional enabled state for workflow. This setting may be overridden by the system if the workflow doesn't meet the requirements to be enabled or if other conditions prevent enabling the workflow. The requirements to enable a workflow are that the workflow must be either set up for with auto grant enabled or have one or more WorkflowApprovers created for the workflow.



9722
9723
9724
# File 'lib/models/porcelain.rb', line 9722

def enabled
  @enabled
end

#idObject

Unique identifier of the Workflow.



9724
9725
9726
# File 'lib/models/porcelain.rb', line 9724

def id
  @id
end

#nameObject

Unique human-readable name of the Workflow.



9726
9727
9728
# File 'lib/models/porcelain.rb', line 9726

def name
  @name
end

#weightObject

Optional weight for workflow to specify it's priority in matching a request.



9728
9729
9730
# File 'lib/models/porcelain.rb', line 9728

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9748
9749
9750
9751
9752
9753
9754
# File 'lib/models/porcelain.rb', line 9748

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end