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.



9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
# File 'lib/models/porcelain.rb', line 9976

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.



9958
9959
9960
# File 'lib/models/porcelain.rb', line 9958

def access_rules
  @access_rules
end

#auto_grantObject

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



9960
9961
9962
# File 'lib/models/porcelain.rb', line 9960

def auto_grant
  @auto_grant
end

#descriptionObject

Optional description of the Workflow.



9962
9963
9964
# File 'lib/models/porcelain.rb', line 9962

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.



9968
9969
9970
# File 'lib/models/porcelain.rb', line 9968

def enabled
  @enabled
end

#idObject

Unique identifier of the Workflow.



9970
9971
9972
# File 'lib/models/porcelain.rb', line 9970

def id
  @id
end

#nameObject

Unique human-readable name of the Workflow.



9972
9973
9974
# File 'lib/models/porcelain.rb', line 9972

def name
  @name
end

#weightObject

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



9974
9975
9976
# File 'lib/models/porcelain.rb', line 9974

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9994
9995
9996
9997
9998
9999
10000
# File 'lib/models/porcelain.rb', line 9994

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