NAME

WebService::EastCoJp::Dictionary::SearchDicItemParameter - Make HTTP request parameter for EAST.co.jp

SYNOPSIS

  use WebService::EastCoJp::Dictionary::SearchDicItemParameter;
  my $p = WebService::EastCoJp::Dictionary::SearchDicItemParameter->new(
      dic  => "EJdict",
      word => "dic",
  );
  say $p->to_string;

DESCRIPTION

This module is used to make HTTP request parameter. The parameter is for EAST.co.jp.

This module is used with WebService::EastCoJp::Dictionary.

ATTRIBUTES

All attribute:

  - dic
  - word
  - scope
  - match
  - merge
  - prof
  - page_size
  - page_index

dic

This attribute is called Dic in EAST.co.jp.

This attribute has constraint of WebService::EastCoJp::Dictionary::ParameterConstraints's RequestParameter::Dic.

word

This attribute is called Word in EAST.co.jp.

This attribute specifies the word that will be translated.

This will encode when call to_string method. The encode is return value of URI::Escape::uri_encode.

scope

This attribute is called Scope in EAST.co.jp.

This attribute specifies a space. The space is subject or anywhere.

This attribute has constraint of WebService::EastCoJp::Dictionary::ParameterConstraints's RequestParameter::Scope.

match

This attribute is called Match in EAST.co.jp.

This attribute specifies position to which position of the word the character is corresponding.

This attribute has constraint of WebService::EastCoJp::Dictionary::ParameterConstraints's RequestParameter::Match.

merge

This attribute is called Merge in EAST.co.jp.

This attribute specifies how the query is joined.

This attribute has constraint of WebService::EastCoJp::Dictionary::ParameterConstraints's RequestParameter::Merge.

prof

This attribute is called Prof in EAST.co.jp.

This attribute specifies format of contents.

It is XHTML usually.

This attribute has constraint of WebService::EastCoJp::Dictionary::ParameterConstraints's RequestParameter::Prof.

page_size

This attribute is called PageSize in EAST.co.jp.

This attribute specifies the size of result set.

page_index

This attribute is called PageIndex in EAST.co.jp.

This attribute specifies the start index that is returned value of search request. It is zero usually.

METHODS

to_string

This method returns a string that for HTTP request. This method will die when some attributes are undef or empty string. The attributes are dic and word.

SEE ALSO

WebService::EastCoJp::Dictionary WebService::EastCoJp::Dictionary::ParameterConstraints WebService::EastCoJp::Dictionary::GetDicItemParameter

AUTHOR

Kuniyoshi Kouji, <kuniyoshi@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2009 by Kuniyoshi Kouji

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.