com.github.gabrielruiu.springsocial.yahoo.api.ContactsOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-social-yahoo Show documentation

The newest version!

/**
 * Copyright 2014 the original author or authors.
 *
 * 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.github.gabrielruiu.springsocial.yahoo.api;

import com.github.gabrielruiu.springsocial.yahoo.filter.ContactsFilter;
import com.github.gabrielruiu.springsocial.yahoo.module.Category;
import com.github.gabrielruiu.springsocial.yahoo.module.Contact;
import com.github.gabrielruiu.springsocial.yahoo.module.Contacts;

import java.util.List;

/**
 * Main interface for interacting with the Contacts-part of the Yahoo Social API.
 *
 * @see Contacts API
 *
 * @author Ruiu Gabriel Mihai ([email protected])
 */
public interface ContactsOperations {

    /**
     * Retrieves every contact which belongs to the currently logged in user
     */
    Contacts getContacts();

    /**
     * Retrieves every contact which belongs to the currently logged in user and respects the filter constraints
     * @see {@link com.github.gabrielruiu.springsocial.yahoo.filter.ContactsFilter}
     */
    Contacts getContacts(ContactsFilter filter);

    /**
     * Retrieves to contacts which belong to the given category
     */
    Contacts getContactsByCategory(String categoryName);

    /**
     * Retrieves the contract with the given contact id
     */
    Contact getContact(int contactCid);

    /**
     * Retrieves all the categories which belong to the currently logged in user
     */
    List getCategories();

    /**
     * Retrieves the categories to which the contact (given by the contact id) belongs
     */
    List getCategoriesByContactCid(int contactCid);
}