Class: UU::OS::REST::PagingCriteria

Inherits:
DTO
  • Object
show all
Defined in:
uu_os_framework-0.10.6/lib/uu/os/rest/paging_criteria.rb

Overview

The basic implementation that could be extended by DTOs used as uuCommand arguments. It is used to simplify realization of uuCommands.

Direct Known Subclasses

ADK::App::AppGetEntryList, DigitalWorkspace::DigitalWorkspace::DigitalWorkspaceGetRecordList, AccessRole::AccessRoleGetRoleInterfaceList, Activity::ActivityGetActivityList, Activity::ActivityGetInstanceList, AllFromOrganizationalUnitCast::AllFromOrganizationalUnitCastGetCastList, AppMetaModel::AppMetaModelGetEntryList, AppPackage::AppPackageGetEntryList, Artifact::ArtifactGetReferenceList, ArtifactSearch::ArtifactSearchQuery, Attachment::AttachmentGetAttachmentList, Cast::CastGetAccessRoleCastList, Cast::CastGetCastList, Company::CompanyGetEntryList, Folder::FolderGetEntryList, Group::GroupGetRoleInterfaceList, MetaAccessRole::MetaAccessRoleGetRoleInterfaceList, MetaGroup::MetaGroupGetRoleInterfaceList, MetaModel::MetaModelGetEntryList, MetaPermission::MetaPermissionGetAuthorityList, MetaPermission::MetaPermissionGetMaskList, MetaPermission::MetaPermissionGetSystemGroupList, MetaRole::MetaRoleGetRoleInterfaceList, OrganizationalUnit::OrganizationalUnitGetEntryList, Permission::PermissionGetAuthorityList, Permission::PermissionGetMaskList, Permission::PermissionGetSystemGroupList, PersonalAccessRole::PersonalAccessRoleGetRoleInterfaceList, PersonalRole::PersonalRoleGetTerritoryList, Property::PropertyGetEntryList, Property::PropertyGetPropertyList, PropertyTemplate::PropertyTemplateGetEntryList, UU::OS::Role::RoleGetArtifactList, UU::OS::Role::RoleGetRoleInterfaceList, UU::OS::RoleInterface::RoleInterfaceGetMetaArtifactList, UU::OS::RoleSearch::RoleSearchQuery, Sheet::SheetGetSheetList, Sheet::SheetGetVersionList, SheetTemplate::SheetTemplateGetSheetTemplateList, Shortcut::ShortcutGetShortcutList, UseCase::UseCaseGetUseCaseList, UseCaseRealization::UseCaseRealizationGetUseCaseList, VisualUseCase::VisualUseCaseGetUseCaseList, UU::ObjectStore::ObjectStore::UUObjectQuery

Instance Attribute Summary (collapse)

Method Summary

Methods inherited from 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

- (Numeric) page_index

Result list page index.

Parameters:

  • (Numeric)

Returns:

  • (Numeric) 


14
15
16
 
# File 'uu_os_framework-0.10.6/lib/uu/os/rest/paging_criteria.rb', line 14

def page_index
  @page_index
end

- (Numeric) page_size

Result list page size.

Parameters:

  • (Numeric)

Returns:

  • (Numeric) 


19
20
21
 
# File 'uu_os_framework-0.10.6/lib/uu/os/rest/paging_criteria.rb', line 19

def page_size
  @page_size
end

- (String) 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.

Parameters:

  • (String)

Returns:

  • (String) 


26
27
28
 
# File 'uu_os_framework-0.10.6/lib/uu/os/rest/paging_criteria.rb', line 26

def query
  @query
end