SemanticWeb-Schema/lib/SemanticWeb/Schema/Action.pm
use utf8;
package SemanticWeb::Schema::Action;
# ABSTRACT: An action performed by a direct agent and indirect participants upon a direct object
use v5.14;
use Moo;
extends qw/ SemanticWeb::Schema::Thing /;
use MooX::JSON_LD 'Action';
use Ref::Util qw/ is_plain_hashref /;
# RECOMMEND PREREQ: Ref::Util::XS
use namespace::autoclean;
our $VERSION = 'v23.0.0';
has action_status => (
is => 'rw',
predicate => '_has_action_status',
json_ld => 'actionStatus',
);
has agent => (
is => 'rw',
predicate => '_has_agent',
json_ld => 'agent',
);
has end_time => (
is => 'rw',
predicate => '_has_end_time',
json_ld => 'endTime',
);
has error => (
is => 'rw',
predicate => '_has_error',
json_ld => 'error',
);
has instrument => (
is => 'rw',
predicate => '_has_instrument',
json_ld => 'instrument',
);
has location => (
is => 'rw',
predicate => '_has_location',
json_ld => 'location',
);
has object => (
is => 'rw',
predicate => '_has_object',
json_ld => 'object',
);
has participant => (
is => 'rw',
predicate => '_has_participant',
json_ld => 'participant',
);
has provider => (
is => 'rw',
predicate => '_has_provider',
json_ld => 'provider',
);
has result => (
is => 'rw',
predicate => '_has_result',
json_ld => 'result',
);
has start_time => (
is => 'rw',
predicate => '_has_start_time',
json_ld => 'startTime',
);
has target => (
is => 'rw',
predicate => '_has_target',
json_ld => 'target',
);
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
SemanticWeb::Schema::Action - An action performed by a direct agent and indirect participants upon a direct object
=head1 VERSION
version v23.0.0
=head1 DESCRIPTION
An action performed by a direct agent and indirect participants upon a
direct object. Optionally happens at a location with the help of an
inanimate instrument. The execution of the action may produce a result.
Specific action sub-type documentation specifies the exact expectation of
each argument/role. See also [blog
post](http://blog.schema.org/2014/04/announcing-schemaorg-actions.html) and
[Actions overview document](http://schema.org/docs/actions.html).
=head1 ATTRIBUTES
=head2 C<action_status>
C<actionStatus>
Indicates the current disposition of the Action.
A action_status should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::ActionStatusType']>
=back
=head2 C<_has_action_status>
A predicate for the L</action_status> attribute.
=head2 C<agent>
The direct performer or driver of the action (animate or inanimate). E.g.
*John* wrote a book.
A agent should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Organization']>
=item C<InstanceOf['SemanticWeb::Schema::Person']>
=back
=head2 C<_has_agent>
A predicate for the L</agent> attribute.
=head2 C<end_time>
C<endTime>
The endTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to end. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from January to *December*. For media, including audio
and video, it's the time offset of the end of a clip within a larger file.
Note that Event uses startDate/endDate instead of startTime/endTime, even
when describing dates with times. This situation may be clarified in future
revisions.
A end_time should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_end_time>
A predicate for the L</end_time> attribute.
=head2 C<error>
For failed actions, more information on the cause of the failure.
A error should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Thing']>
=back
=head2 C<_has_error>
A predicate for the L</error> attribute.
=head2 C<instrument>
The object that helped the agent perform the action. E.g. John wrote a book
with *a pen*.
A instrument should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Thing']>
=back
=head2 C<_has_instrument>
A predicate for the L</instrument> attribute.
=head2 C<location>
The location of, for example, where an event is happening, where an
organization is located, or where an action takes place.
A location should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Place']>
=item C<InstanceOf['SemanticWeb::Schema::PostalAddress']>
=item C<InstanceOf['SemanticWeb::Schema::VirtualLocation']>
=item C<Str>
=back
=head2 C<_has_location>
A predicate for the L</location> attribute.
=head2 C<object>
The object upon which the action is carried out, whose state is kept intact
or changed. Also known as the semantic roles patient, affected or undergoer
(which change their state) or theme (which doesn't). E.g. John read *a
book*.
A object should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Thing']>
=back
=head2 C<_has_object>
A predicate for the L</object> attribute.
=head2 C<participant>
Other co-agents that participated in the action indirectly. E.g. John wrote
a book with *Steve*.
A participant should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Organization']>
=item C<InstanceOf['SemanticWeb::Schema::Person']>
=back
=head2 C<_has_participant>
A predicate for the L</participant> attribute.
=head2 C<provider>
The service provider, service operator, or service performer; the goods
producer. Another party (a seller) may offer those services or goods on
behalf of the provider. A provider may also serve as the seller.
A provider should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Organization']>
=item C<InstanceOf['SemanticWeb::Schema::Person']>
=back
=head2 C<_has_provider>
A predicate for the L</provider> attribute.
=head2 C<result>
The result produced in the action. E.g. John wrote *a book*.
A result should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Thing']>
=back
=head2 C<_has_result>
A predicate for the L</result> attribute.
=head2 C<start_time>
C<startTime>
The startTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to start. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from *January* to December. For media, including audio
and video, it's the time offset of the start of a clip within a larger
file. Note that Event uses startDate/endDate instead of startTime/endTime,
even when describing dates with times. This situation may be clarified in
future revisions.
A start_time should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_start_time>
A predicate for the L</start_time> attribute.
=head2 C<target>
Indicates a target EntryPoint, or url, for an Action.
A target should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::EntryPoint']>
=item C<Str>
=back
=head2 C<_has_target>
A predicate for the L</target> attribute.
=head1 SEE ALSO
L<SemanticWeb::Schema::Thing>
=head1 SOURCE
The development version is on github at L<https://github.com/robrwo/SemanticWeb-Schema>
and may be cloned from L<git://github.com/robrwo/SemanticWeb-Schema.git>
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
L<https://github.com/robrwo/SemanticWeb-Schema/issues>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
Robert Rothenberg <rrwo@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2018-2023 by Robert Rothenberg.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
=cut