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.



9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
# File 'lib/models/porcelain.rb', line 9888

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.



9870
9871
9872
# File 'lib/models/porcelain.rb', line 9870

def access_rules
  @access_rules
end

#auto_grantObject

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



9872
9873
9874
# File 'lib/models/porcelain.rb', line 9872

def auto_grant
  @auto_grant
end

#descriptionObject

Optional description of the Workflow.



9874
9875
9876
# File 'lib/models/porcelain.rb', line 9874

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.



9880
9881
9882
# File 'lib/models/porcelain.rb', line 9880

def enabled
  @enabled
end

#idObject

Unique identifier of the Workflow.



9882
9883
9884
# File 'lib/models/porcelain.rb', line 9882

def id
  @id
end

#nameObject

Unique human-readable name of the Workflow.



9884
9885
9886
# File 'lib/models/porcelain.rb', line 9884

def name
  @name
end

#weightObject

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



9886
9887
9888
# File 'lib/models/porcelain.rb', line 9886

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9906
9907
9908
9909
9910
9911
9912
# File 'lib/models/porcelain.rb', line 9906

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