package com.thinkbiganalytics.feedmgr.service.category;
/*-
* #%L
* thinkbig-feed-manager-controller
* %%
* Copyright (C) 2017 ThinkBig Analytics
* %%
* 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.
* #L%
*/
import com.thinkbiganalytics.feedmgr.InvalidOperationException;
import com.thinkbiganalytics.feedmgr.rest.model.FeedCategory;
import com.thinkbiganalytics.feedmgr.rest.model.UserField;
import com.thinkbiganalytics.feedmgr.rest.model.UserProperty;
import java.util.Collection;
import java.util.Set;
import javax.annotation.Nonnull;
/**
* Manages Feed Manager categories.
*/
public interface FeedManagerCategoryService {
Collection<FeedCategory> getCategories();
FeedCategory getCategoryById(String id);
FeedCategory getCategoryBySystemName(String name);
void saveCategory(FeedCategory category);
boolean deleteCategory(String categoryId) throws InvalidOperationException;
/**
* Gets the user-defined fields for all categories.
*
* @return the user-defined fields
*/
@Nonnull
Set<UserField> getUserFields();
/**
* Sets the user-defined fields for all categories.
*
* @param userFields the new set of user-defined fields
*/
void setUserFields(@Nonnull Set<UserField> userFields);
/**
* Gets the user-defined fields for all categories.
*
* @return the user-defined fields
*/
@Nonnull
Set<UserProperty> getUserProperties();
}