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.



9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
# File 'lib/models/porcelain.rb', line 9578

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.



9560
9561
9562
# File 'lib/models/porcelain.rb', line 9560

def access_rules
  @access_rules
end

#auto_grantObject

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



9562
9563
9564
# File 'lib/models/porcelain.rb', line 9562

def auto_grant
  @auto_grant
end

#descriptionObject

Optional description of the Workflow.



9564
9565
9566
# File 'lib/models/porcelain.rb', line 9564

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.



9570
9571
9572
# File 'lib/models/porcelain.rb', line 9570

def enabled
  @enabled
end

#idObject

Unique identifier of the Workflow.



9572
9573
9574
# File 'lib/models/porcelain.rb', line 9572

def id
  @id
end

#nameObject

Unique human-readable name of the Workflow.



9574
9575
9576
# File 'lib/models/porcelain.rb', line 9574

def name
  @name
end

#weightObject

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



9576
9577
9578
# File 'lib/models/porcelain.rb', line 9576

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9596
9597
9598
9599
9600
9601
9602
# File 'lib/models/porcelain.rb', line 9596

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