TvEpisodeProxy.java

/**
 *  Copyright 2011 Colin Alworth
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package com.acme.gwt.shared;

import java.util.List;

import com.acme.gwt.data.TvEpisode;
import com.acme.gwt.server.InjectingLocator;
import com.acme.gwt.server.InjectingServiceLocator;
import com.google.web.bindery.requestfactory.shared.EntityProxy;
import com.google.web.bindery.requestfactory.shared.EntityProxyId;
import com.google.web.bindery.requestfactory.shared.ProxyFor;
import com.google.web.bindery.requestfactory.shared.RequestContext;
import com.google.web.bindery.requestfactory.shared.Service;

/**
 * An individual episode of a TvShowProxy. Contains a reference to the show that it belongs to, and to
 * its place in that show, as well as a brief name and description of the episode.
 *
 * @author colin
 * @todo Do we want a Season object as well? Only utility I could see in that is to provide meta-
 * data to a List of Episodes.
 * jn: seasons are abstract
 */
public @ProxyFor(value = TvEpisode.class, locator = InjectingLocator.class)
interface TvEpisodeProxy extends EntityProxy {
	Long getId();

	Integer getVersion();

	void setId(Long id);

	void setVersion(Integer version);

	TvShowProxy getTvShow();

	void setTvShow(TvShowProxy iShow);

	Integer getSeason();

	void setSeason(Integer season);

	Integer getEpisodeNumber();

	void setEpisodeNumber(Integer episodeNumber);

	String getName();

	void setName(String name);

	List<TvScheduledEpisodeProxy> getScheduledEpisodes();

	public EntityProxyId<TvEpisodeProxy> stableId();

	void setScheduledEpisodes(List<TvScheduledEpisodeProxy> scheduledEpisodes);

	@Service(value = TvEpisode.class, locator = InjectingServiceLocator.class)
	public interface TvEpisodeRequest extends RequestContext {
		//un-implemented on the server, commenting out to stop test failures until it exists
		//InstanceRequest<TvEpisodeProxy, List<TvScheduledEpisodeProxy>> findEpisodesInRange(Date startDate, Date endDate);

	}
}