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



9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
# File 'lib/models/porcelain.rb', line 9858

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.



9840
9841
9842
# File 'lib/models/porcelain.rb', line 9840

def access_rules
  @access_rules
end

#auto_grantObject

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



9842
9843
9844
# File 'lib/models/porcelain.rb', line 9842

def auto_grant
  @auto_grant
end

#descriptionObject

Optional description of the Workflow.



9844
9845
9846
# File 'lib/models/porcelain.rb', line 9844

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.



9850
9851
9852
# File 'lib/models/porcelain.rb', line 9850

def enabled
  @enabled
end

#idObject

Unique identifier of the Workflow.



9852
9853
9854
# File 'lib/models/porcelain.rb', line 9852

def id
  @id
end

#nameObject

Unique human-readable name of the Workflow.



9854
9855
9856
# File 'lib/models/porcelain.rb', line 9854

def name
  @name
end

#weightObject

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



9856
9857
9858
# File 'lib/models/porcelain.rb', line 9856

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9876
9877
9878
9879
9880
9881
9882
# File 'lib/models/porcelain.rb', line 9876

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