UsersListQuery.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.index.service.resources.list.query;

import org.opencastproject.index.service.resources.list.api.ResourceListFilter;
import org.opencastproject.index.service.resources.list.api.ResourceListFilter.SourceType;
import org.opencastproject.index.service.resources.list.provider.UsersListProvider;
import org.opencastproject.index.service.util.FiltersUtils;
import org.opencastproject.util.data.Option;

/**
 * Query for the users list.
 *
 * The following filters can be used:
 * <ul>
 * <li>name</li>
 * <li>role</li>
 * <li>provider</li>
 * </ul>
 */
public class UsersListQuery extends ResourceListQueryImpl {

  public static final String FILTER_NAME_NAME = "Name";
  private static final String FILTER_NAME_LABEL = "FILTERS.USERS.NAME.LABEL";

  public static final String FILTER_ROLE_NAME = "Role";
  private static final String FILTER_ROLE_LABEL = "FILTERS.USERS.ROLE.LABEL";

  public static final String FILTER_PROVIDER_NAME = "Provider";
  private static final String FILTER_PROVIDER_LABEL = "FILTERS.USERS.PROVIDER.LABEL";

  public static final String FILTER_TEXT_NAME = "textFilter";

  public UsersListQuery() {
    super();
    this.availableFilters.add(createNameFilter(Option.<String> none()));
    this.availableFilters.add(createRoleFilter(Option.<String> none()));
    this.availableFilters.add(createProviderFilter(Option.<String> none()));
  }

  /**
   * Add a {@link ResourceListFilter} filter to the query with the given name
   *
   * @param name
   *          the name to filter for
   */
  public void withName(String name) {
    this.addFilter(createNameFilter(Option.option(name)));
  }

  /**
   * Returns an {@link Option} containing the name used to filter if set
   *
   * @return an {@link Option} containing the name or none.
   */
  public Option<String> getName() {
    return this.getFilterValue(FILTER_NAME_NAME);
  }

  /**
   * Add a {@link ResourceListFilter} filter to the query with the given role
   *
   * @param role
   *          the role to filter for
   */
  public void withRole(String role) {
    this.addFilter(createRoleFilter(Option.option(role)));
  }

  /**
   * Returns an {@link Option} containing the role used to filter if set
   *
   * @return an {@link Option} containing the role or none.
   */
  public Option<String> getRole() {
    return this.getFilterValue(FILTER_ROLE_NAME);
  }

  /**
   * Add a {@link ResourceListFilter} filter to the query with the given provider
   *
   * @param provider
   *          the provider to filter for
   */
  public void withProvider(String provider) {
    this.addFilter(createProviderFilter(Option.option(provider)));
  }

  /**
   * Returns an {@link Option} containing the provider used to filter if set
   *
   * @return an {@link Option} containing the provider or none.
   */
  public Option<String> getProvider() {
    return this.getFilterValue(FILTER_PROVIDER_NAME);
  }

  /**
   * Create a new {@link ResourceListFilter} based on a name
   *
   * @param name
   *          the name to filter on wrapped in an {@link Option} or {@link Option#none()}
   * @return a new {@link ResourceListFilter} for a name based query
   */
  public static ResourceListFilter<String> createNameFilter(Option<String> name) {
    return FiltersUtils.generateFilter(name, FILTER_NAME_NAME, FILTER_NAME_LABEL, SourceType.SELECT,
            Option.some(UsersListProvider.NAME));
  }

  /**
   * Create a new {@link ResourceListFilter} based on a role
   *
   * @param role
   *          the role to filter on wrapped in an {@link Option} or {@link Option#none()}
   * @return a new {@link ResourceListFilter} for a role based query
   */
  public static ResourceListFilter<String> createRoleFilter(Option<String> role) {
    return FiltersUtils.generateFilter(role, FILTER_ROLE_NAME, FILTER_ROLE_LABEL, SourceType.SELECT,
            Option.some(UsersListProvider.ROLE));
  }

  /**
   * Create a new {@link ResourceListFilter} based on a provider
   *
   * @param provider
   *          the provider to filter on wrapped in an {@link Option} or {@link Option#none()}
   * @return a new {@link ResourceListFilter} for a provider based query
   */
  public static ResourceListFilter<String> createProviderFilter(Option<String> provider) {
    return FiltersUtils.generateFilter(provider, FILTER_PROVIDER_NAME, FILTER_PROVIDER_LABEL, SourceType.SELECT,
            Option.some(UsersListProvider.USERDIRECTORY));
  }

}