File Coverage

blib/lib/Paws/MTurk/QualificationRequirement.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::MTurk::QualificationRequirement;
2 1     1   574 use Moose;
  1         3  
  1         7  
3             has Comparator => (is => 'ro', isa => 'Str', required => 1);
4             has IntegerValues => (is => 'ro', isa => 'ArrayRef[Int]');
5             has LocaleValues => (is => 'ro', isa => 'ArrayRef[Paws::MTurk::Locale]');
6             has QualificationTypeId => (is => 'ro', isa => 'Str', required => 1);
7             has RequiredToPreview => (is => 'ro', isa => 'Bool');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::MTurk::QualificationRequirement
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::MTurk::QualificationRequirement object:
26              
27             $service_obj->Method(Att1 => { Comparator => $value, ..., RequiredToPreview => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::MTurk::QualificationRequirement object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Comparator
35              
36             =head1 DESCRIPTION
37              
38             The QualificationRequirement data structure describes a Qualification
39             that a Worker must have before the Worker is allowed to accept a HIT. A
40             requirement may optionally state that a Worker must have the
41             Qualification in order to preview the HIT.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 B<REQUIRED> Comparator => Str
47              
48             The kind of comparison to make against a Qualification's value. You can
49             compare a Qualification's value to an IntegerValue to see if it is
50             LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo,
51             EqualTo, or NotEqualTo the IntegerValue. You can compare it to a
52             LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You
53             can check to see if the value is In or NotIn a set of IntegerValue or
54             LocaleValue values. Lastly, a Qualification requirement can also test
55             if a Qualification Exists or DoesNotExist in the user's profile,
56             regardless of its value.
57              
58              
59             =head2 IntegerValues => ArrayRef[Int]
60              
61             The integer value to compare against the Qualification's value.
62             IntegerValue must not be present if Comparator is Exists or
63             DoesNotExist. IntegerValue can only be used if the Qualification type
64             has an integer value; it cannot be used with the Worker_Locale
65             QualificationType ID. When performing a set comparison by using the In
66             or the NotIn comparator, you can use up to 15 IntegerValue elements in
67             a QualificationRequirement data structure.
68              
69              
70             =head2 LocaleValues => ArrayRef[L<Paws::MTurk::Locale>]
71              
72             The locale value to compare against the Qualification's value. The
73             local value must be a valid ISO 3166 country code or supports ISO
74             3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale
75             QualificationType ID. LocaleValue can only be used with the EqualTo,
76             NotEqualTo, In, and NotIn comparators. You must only use a single
77             LocaleValue element when using the EqualTo or NotEqualTo comparators.
78             When performing a set comparison by using the In or the NotIn
79             comparator, you can use up to 30 LocaleValue elements in a
80             QualificationRequirement data structure.
81              
82              
83             =head2 B<REQUIRED> QualificationTypeId => Str
84              
85             The ID of the Qualification type for the requirement.
86              
87              
88             =head2 RequiredToPreview => Bool
89              
90             If true, the question data for the HIT will not be shown when a Worker
91             whose Qualifications do not meet this requirement tries to preview the
92             HIT. That is, a Worker's Qualifications must meet all of the
93             requirements for which RequiredToPreview is true in order to preview
94             the HIT. If a Worker meets all of the requirements where
95             RequiredToPreview is true (or if there are no such requirements), but
96             does not meet all of the requirements for the HIT, the Worker will be
97             allowed to preview the HIT's question data, but will not be allowed to
98             accept and complete the HIT. The default is false.
99              
100              
101              
102             =head1 SEE ALSO
103              
104             This class forms part of L<Paws>, describing an object used in L<Paws::MTurk>
105              
106             =head1 BUGS and CONTRIBUTIONS
107              
108             The source code is located here: https://github.com/pplu/aws-sdk-perl
109              
110             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
111              
112             =cut
113