Interface ISeriesInfoBuilder
interface ISeriesInfoBuilder
Extends com.amazon.apmf.IStandard
Builder that will create the SeriesInfo object.
Methods
season()
Sets the season number of the program in the series info builder and returns an instance of the builder.ISeriesInfoBuilder*season(stringseason)
Parameters
season
string — Required
The string representing the season number. This field is required.
The string will be truncated if its length exceeds 256 bytes and the last 3 bytes will be replaced with ”…”.
Returns
ISeriesInfoBuilder*
The SeriesInfoBuilder object with season set.
Throws
IllegalStateError— If the function is called after this builder instance has already built an object once.
episode()
Sets the episode number of the program in the series info builder and returns an instance of the builder.ISeriesInfoBuilder*episode(stringepisode)
Parameters
episode
string — Required
The string representing the episode number. This field is required.
The string will be truncated if its length exceeds 256 bytes and the last 3 bytes will be replaced with ”…”.
Returns
ISeriesInfoBuilder*
The SeriesInfoBuilder object with episode set.
Throws
IllegalStateError— If the function is called after this builder instance has already built an object once.
build()
Builds and returns a pointer to an instance of theISeriesInfo*build()
ISeriesInfo object.
This function should be called after the desired fields of the program
builder have been set using the other builder functions. The build() function should
only be called once per builder object.
Returns
ISeriesInfo*
An instance of a SeriesInfo object with all of the data that was set.
Throws
InvalidArgumentError— If one or more of the required fields are not provided to the builder.IllegalStateError— If the function is called after this builder instance has already built an object once.
