blib/lib/Paws/MTurk/QualificationRequirement.pm untested

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::MTurk::QualificationRequirement;
3 use Moose;
4 has ActionsGuarded => (is => 'ro', isa => 'Str');
5 has Comparator => (is => 'ro', isa => 'Str', required => 1);
6 has IntegerValues => (is => 'ro', isa => 'ArrayRef[Int]');
7 has LocaleValues => (is => 'ro', isa => 'ArrayRef[Paws::MTurk::Locale]');
8 has QualificationTypeId => (is => 'ro', isa => 'Str', required => 1);
9 has RequiredToPreview => (is => 'ro', isa => 'Bool');
10  
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::MTurk::QualificationRequirement
18  
19 =head1 USAGE
20  
21 This class represents one of two things:
22  
23 =head3 Arguments in a call to a service
24  
25 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26 Each attribute should be used as a named argument in the calls that expect this type of object.
27  
28 As an example, if Att1 is expected to be a Paws::MTurk::QualificationRequirement object:
29  
30 $service_obj->Method(Att1 => { ActionsGuarded => $value, ..., RequiredToPreview => $value });
31  
32 =head3 Results returned from an API call
33  
34 Use accessors for each attribute. If Att1 is expected to be an Paws::MTurk::QualificationRequirement object:
35  
36 $result = $service_obj->Method(...);
37 $result->Att1->ActionsGuarded
38  
39 =head1 DESCRIPTION
40  
41 The QualificationRequirement data structure describes a Qualification
42 that a Worker must have before the Worker is allowed to accept a HIT. A
43 requirement may optionally state that a Worker must have the
44 Qualification in order to preview the HIT, or see the HIT in search
45 results.
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 ActionsGuarded => Str
51  
52 Setting this attribute prevents Workers whose Qualifications do not
53 meet this QualificationRequirement from taking the specified action.
54 Valid arguments include "Accept" (Worker cannot accept the HIT, but can
55 preview the HIT and see it in their search results), "PreviewAndAccept"
56 (Worker cannot accept or preview the HIT, but can see the HIT in their
57 search results), and "DiscoverPreviewAndAccept" (Worker cannot accept,
58 preview, or see the HIT in their search results). It's possible for you
59 to create a HIT with multiple QualificationRequirements (which can have
60 different values for the ActionGuarded attribute). In this case, the
61 Worker is only permitted to perform an action when they have met all
62 QualificationRequirements guarding the action. The actions in the order
63 of least restrictive to most restrictive are Discover, Preview and
64 Accept. For example, if a Worker meets all QualificationRequirements
65 that are set to DiscoverPreviewAndAccept, but do not meet all
66 requirements that are set with PreviewAndAccept, then the Worker will
67 be able to Discover, i.e. see the HIT in their search result, but will
68 not be able to Preview or Accept the HIT. ActionsGuarded should not be
69 used in combination with the C<RequiredToPreview> field.
70  
71  
72 =head2 B<REQUIRED> Comparator => Str
73  
74 The kind of comparison to make against a Qualification's value. You can
75 compare a Qualification's value to an IntegerValue to see if it is
76 LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo,
77 EqualTo, or NotEqualTo the IntegerValue. You can compare it to a
78 LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You
79 can check to see if the value is In or NotIn a set of IntegerValue or
80 LocaleValue values. Lastly, a Qualification requirement can also test
81 if a Qualification Exists or DoesNotExist in the user's profile,
82 regardless of its value.
83  
84  
85 =head2 IntegerValues => ArrayRef[Int]
86  
87 The integer value to compare against the Qualification's value.
88 IntegerValue must not be present if Comparator is Exists or
89 DoesNotExist. IntegerValue can only be used if the Qualification type
90 has an integer value; it cannot be used with the Worker_Locale
91 QualificationType ID. When performing a set comparison by using the In
92 or the NotIn comparator, you can use up to 15 IntegerValue elements in
93 a QualificationRequirement data structure.
94  
95  
96 =head2 LocaleValues => ArrayRef[L<Paws::MTurk::Locale>]
97  
98 The locale value to compare against the Qualification's value. The
99 local value must be a valid ISO 3166 country code or supports ISO
100 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale
101 QualificationType ID. LocaleValue can only be used with the EqualTo,
102 NotEqualTo, In, and NotIn comparators. You must only use a single
103 LocaleValue element when using the EqualTo or NotEqualTo comparators.
104 When performing a set comparison by using the In or the NotIn
105 comparator, you can use up to 30 LocaleValue elements in a
106 QualificationRequirement data structure.
107  
108  
109 =head2 B<REQUIRED> QualificationTypeId => Str
110  
111 The ID of the Qualification type for the requirement.
112  
113  
114 =head2 RequiredToPreview => Bool
115  
116 DEPRECATED: Use the C<ActionsGuarded> field instead. If
117 RequiredToPreview is true, the question data for the HIT will not be
118 shown when a Worker whose Qualifications do not meet this requirement
119 tries to preview the HIT. That is, a Worker's Qualifications must meet
120 all of the requirements for which RequiredToPreview is true in order to
121 preview the HIT. If a Worker meets all of the requirements where
122 RequiredToPreview is true (or if there are no such requirements), but
123 does not meet all of the requirements for the HIT, the Worker will be
124 allowed to preview the HIT's question data, but will not be allowed to
125 accept and complete the HIT. The default is false. This should not be
126 used in combination with the C<ActionsGuarded> field.
127  
128  
129  
130 =head1 SEE ALSO
131  
132 This class forms part of L<Paws>, describing an object used in L<Paws::MTurk>
133  
134 =head1 BUGS and CONTRIBUTIONS
135  
136 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
137  
138 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
139  
140 =cut
141