com.sappenin.utils.rest.v2.model.RestCollection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-utils2 Show documentation

Utilities, Helpers, and base-classes for assisting in server-side REST API implementations written in Java.

The newest version!

/**
 * Copyright (C) 2014 Sappenin Inc. ([email protected])
 * 
 * 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.sappenin.utils.rest.v2.model;

import java.util.List;

import com.sappenin.utils.rest.v2.model.meta.CollectionMeta;
import com.sappenin.utils.rest.v2.model.meta.impl.AbstractMeta;

/**
 * A Generic Representation of a Collection of resources. This class is compliant with ActivityStrea.ms 1.0.

 * 

 *  The type of {@link RestModel} that this collection holds.

 *  The type of {@link AbstractMeta} that this collections' meta object is.
 */
public interface RestCollection>
{
	/**
	 * Get this object's {@link AbstractMeta}.
	 *
	 * @return
	 */
	public M getMeta();

	/**
	 * @return the items
	 */
	public List getPageItems();

}