Class: Inforouter::Document

Inherits:
Record
  • Object
show all
Defined in:
lib/inforouter/document.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Record

#initialize

Constructor Details

This class inherits a constructor from Inforouter::Record

Instance Attribute Details

#checkout_by_full_name ⇒ Object

Document checkout by full name.



22
23
24
 
# File 'lib/inforouter/document.rb', line 22

def checkout_by_full_name
  @checkout_by_full_name
end

#checkout_by_username ⇒ Object

Document checkout by username.



20
21
22
 
# File 'lib/inforouter/document.rb', line 20

def checkout_by_username
  @checkout_by_username
end

#checkout_date ⇒ Object

Document checkout date.



18
19
20
 
# File 'lib/inforouter/document.rb', line 18

def checkout_date
  @checkout_date
end

#completion_date ⇒ Object

Document completion date.



30
31
32
 
# File 'lib/inforouter/document.rb', line 30

def completion_date
  @completion_date
end

#creation_date ⇒ Object

Document creation date.



14
15
16
 
# File 'lib/inforouter/document.rb', line 14

def creation_date
  @creation_date
end

#description ⇒ Object

Document description.



10
11
12
 
# File 'lib/inforouter/document.rb', line 10

def description
  @description
end

#disposition_date ⇒ Object

Document disposition date.



36
37
38
 
# File 'lib/inforouter/document.rb', line 36

def disposition_date
  @disposition_date
end

#doc_type_id ⇒ Object

Document doc type ID.



44
45
46
 
# File 'lib/inforouter/document.rb', line 44

def doc_type_id
  @doc_type_id
end

#doc_type_name ⇒ Object

Document doc type name.



46
47
48
 
# File 'lib/inforouter/document.rb', line 46

def doc_type_name
  @doc_type_name
end

#expiration_date ⇒ Object

Document expiration date.



38
39
40
 
# File 'lib/inforouter/document.rb', line 38

def expiration_date
  @expiration_date
end

#id ⇒ Object

Document ID.



4
5
6
 
# File 'lib/inforouter/document.rb', line 4

def id
  @id
end

#importance ⇒ Object

Document importance.



32
33
34
 
# File 'lib/inforouter/document.rb', line 32

def importance
  @importance
end

#modification_date ⇒ Object

Document modification date.



16
17
18
 
# File 'lib/inforouter/document.rb', line 16

def modification_date
  @modification_date
end

#name ⇒ Object

Document name.



6
7
8
 
# File 'lib/inforouter/document.rb', line 6

def name
  @name
end

#path ⇒ Object

Document path.



8
9
10
 
# File 'lib/inforouter/document.rb', line 8

def path
  @path
end

#percent_complete ⇒ Object

Document percent complete.



28
29
30
 
# File 'lib/inforouter/document.rb', line 28

def percent_complete
  @percent_complete
end

#published_version ⇒ Object

Document published version.



50
51
52
 
# File 'lib/inforouter/document.rb', line 50

def published_version
  @published_version
end

#register_date ⇒ Object

Document register date.



40
41
42
 
# File 'lib/inforouter/document.rb', line 40

def register_date
  @register_date
end

#registered_by ⇒ Object

Document registered by.



42
43
44
 
# File 'lib/inforouter/document.rb', line 42

def registered_by
  @registered_by
end

#retention_date ⇒ Object

Document retention date.



34
35
36
 
# File 'lib/inforouter/document.rb', line 34

def retention_date
  @retention_date
end

#size ⇒ Object

Document size.



24
25
26
 
# File 'lib/inforouter/document.rb', line 24

def size
  @size
end

#type ⇒ Object

Document type.



26
27
28
 
# File 'lib/inforouter/document.rb', line 26

def type
  @type
end

#update_instructions ⇒ Object

Document update instructions.



12
13
14
 
# File 'lib/inforouter/document.rb', line 12

def update_instructions
  @update_instructions
end

#version ⇒ Object

Document version.



48
49
50
 
# File 'lib/inforouter/document.rb', line 48

def version
  @version
end

Instance Method Details

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
58
59
 
# File 'lib/inforouter/document.rb', line 55

def exists?
  response = Inforouter.client.request :document_exists, path_params
  result = Inforouter::Responses::DocumentExists.parse response
  result[:@success] == 'true'
end