/*
* Copyright (c) 2011 Lockheed Martin Corporation
*
* 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 org.eurekastreams.web.client.events.data;
import org.eurekastreams.server.domain.PagedSet;
import org.eurekastreams.server.domain.dto.StreamDTO;
/**
* Response object for requests for a page of most active streams.
*/
public class GotMostActiveStreamsPageResponseEvent extends BaseDataResponseEvent<PagedSet<StreamDTO>>
{
/**
* The number of streams to allow the user to page through.
*/
private int totalNumberOfAccessibleStreams;
/**
* Constructor.
*
* @param inResponse
* response.
* @param inTotalNumberOfAccessibleStreams
* the number of streams the user may page through
*/
public GotMostActiveStreamsPageResponseEvent(final PagedSet<StreamDTO> inResponse,
final int inTotalNumberOfAccessibleStreams)
{
super(inResponse);
totalNumberOfAccessibleStreams = inTotalNumberOfAccessibleStreams;
}
/**
* Get the number of streams the user can page through.
*
* @return the number of streams the user can page through
*/
public int getTotalNumberOfAccessibleStreams()
{
return totalNumberOfAccessibleStreams;
}
/**
* Set the number of streams the user can page through.
*
* @param inTotalNumberOfAccessibleStreams
* the number of streams the user can page through
*/
public void setTotalNumberOfAccessibleStreams(final int inTotalNumberOfAccessibleStreams)
{
totalNumberOfAccessibleStreams = inTotalNumberOfAccessibleStreams;
}
}