Class: GroupDocs::Questionnaire::Execution

Inherits:
Api::Entity
  • Object
show all
Defined in:
lib/groupdocs/questionnaire/execution.rb

Constant Summary collapse

STATUSES = 
{
  draft:     0,
  submitted: 1,
  executed:  2,
  approved:  3,
  rejected:  4,
  closed:    5,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Api::Entity

#initialize, #inspect, #to_hash

Constructor Details

This class inherits a constructor from GroupDocs::Api::Entity

Instance Attribute Details

#approverId ⇒ Object Also known as: approver_id 



34
35
36
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 34

def approverId
  @approverId
end

#datasourceId ⇒ Object Also known as: datasource_id 



36
37
38
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 36

def datasourceId
  @datasourceId
end

#documentId ⇒ Object Also known as: document_id 



38
39
40
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 38

def documentId
  @documentId
end

#executiveId ⇒ Object Also known as: executive_id 



32
33
34
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 32

def executiveId
  @executiveId
end

#guid ⇒ Object 



42
43
44
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 42

def guid
  @guid
end

#id ⇒ Object 



26
27
28
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 26

def id
  @id
end

#ownerId ⇒ Object Also known as: owner_id 



28
29
30
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 28

def ownerId
  @ownerId
end

#questionnaireId ⇒ Object Also known as: questionnaire_id 



30
31
32
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 30

def questionnaireId
  @questionnaireId
end

#status ⇒ Symbol

Returns execution status in human-readable format.

Returns:

  • (Symbol) 


40
41
42
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 40

def status
  @status
end

Class Method Details

.all!(access = {}) ⇒ Array<GroupDocs::Questionnaire::Execution>

Returns an array of all executions.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



21
22
23
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 21

def self.all!(access = {})
  Questionnaire.executions!(access)
end

Instance Method Details

#set_status!(status, access = {}) ⇒ Object

Updates status of execution on server.

Parameters:

  • status (Symbol)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


92
93
94
95
96
97
98
99
100
101
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 92

def set_status!(status, access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}/status"
    request[:request_body] = STATUSES[status]
  end.execute!

  self.status = status
end

#update!(access = {}) ⇒ Object

Updates execution on server.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


110
111
112
113
114
115
116
117
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 110

def update!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}"
    request[:request_body] = to_hash
  end.execute!
end