Class: UU::OS::Shortcut::ShortcutGetShortcutList

Inherits:
REST::PagingCriteria show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/shortcut/shortcut_get_shortcut_list.rb

Instance Attribute Summary (collapse)

Attributes inherited from REST::PagingCriteria

#page_index, #page_size

Method Summary

Methods inherited from REST::DTO

#initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from UU::OS::REST::DTO

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::OS::REST::DTO

Instance Attribute Details

- (Object) code_filter

Filter for filtering the result according to the shortcut code. When null is set or if codeFilter is an empty string, no filtering according to the code is applied. Filter behavior is similar to the SQL like predicate pattern string. It is a wildcard with these special characters: <ul> <li>% (percent sign) allows matching any string of any length (including zero length) <li>_ (underscore) allows matching a single character <li>\ (backslash) is used to escape any of these special characters </ul>



24
25
26
 
# File 'uu_os_client-0.10.6/lib/uu/os/shortcut/shortcut_get_shortcut_list.rb', line 24

def code_filter
  @code_filter
end

- (Object) name_filter

Filter for filtering the result according to the shortcut name. When null is set or if nameFilter is an empty string, no filtering according to the name is applied. Filter behavior is similar to the SQL like predicate pattern string. It is a wildcard with these special characters: <ul> <li>% (percent sign) allows matching any string of any length (including zero length) <li>_ (underscore) allows matching a single character <li>\ (backslash) is used to escape any of these special characters </ul>



33
34
35
 
# File 'uu_os_client-0.10.6/lib/uu/os/shortcut/shortcut_get_shortcut_list.rb', line 33

def name_filter
  @name_filter
end

- (Object) query

The UES query string. It has to conform the ues query syntax (see documentation for more info). Filtering and order of the result list can be specified there. When null is set, no filtering is applied and entries are ordered by name and code as the second criteria.



15
16
17
 
# File 'uu_os_client-0.10.6/lib/uu/os/shortcut/shortcut_get_shortcut_list.rb', line 15

def query
  @query
end