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.



9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
 
# File 'lib/models/porcelain.rb', line 9813

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_rules ⇒ Object

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



9795
9796
9797
 
# File 'lib/models/porcelain.rb', line 9795

def access_rules
  @access_rules
end

#auto_grant ⇒ Object

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



9797
9798
9799
 
# File 'lib/models/porcelain.rb', line 9797

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



9799
9800
9801
 
# File 'lib/models/porcelain.rb', line 9799

def description
  @description
end

#enabled ⇒ Object

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.



9805
9806
9807
 
# File 'lib/models/porcelain.rb', line 9805

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



9807
9808
9809
 
# File 'lib/models/porcelain.rb', line 9807

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



9809
9810
9811
 
# File 'lib/models/porcelain.rb', line 9809

def name
  @name
end

#weight ⇒ Object

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



9811
9812
9813
 
# File 'lib/models/porcelain.rb', line 9811

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9831
9832
9833
9834
9835
9836
9837
 
# File 'lib/models/porcelain.rb', line 9831

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