com.identityx.clientSDK.queryHolders.QueryHolder Maven / Gradle / Ivy

Go to download
/*
* Copyright Daon.
*
* 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.identityx.clientSDK.queryHolders;

/**
 * Holds various specifications to be passed to list operations.
 * 1. Search spec {@link SearchSpec} to specify filters for the list operation
 * 2. Sort spec {@link SortSpec} to specify sorting fields for the list operation
 * 3. Expand spec {@link ExpandSpec} to specify expansion options for the returned entities. 
 * The returned entities can in this way have sub-entities fully represented in their JSON notation instead of a simple link.
 * 4. Page spec {@link PageSpec} to specify information on paging, useful for large lists.    
 * 
 */
public abstract class QueryHolder {

	private ExpandSpec expandSpec = null;
	private PageSpec pageSpec = new PageSpec();
	private SearchSpec searchSpec = new SearchSpec();
	private SortSpec sortSpec = new SortSpec();
	private SensitiveDataSpec sensitiveDataSpec = null; 
	private boolean includeAuthorizationInfo;

	/**
	 * 
	 * @return {@link PageSpec}
	 */
	public ExpandSpec getExpandSpec() {
		return expandSpec;
	}

	/**
	 * 
	 * @return {@link PageSpec}
	 */
	public PageSpec getPageSpec() {
		return pageSpec;
	}

	/**
	 * 
	 * @return {@link SearchSpec}
	 */
	public SearchSpec getSearchSpec() {
		return searchSpec;
	}

	/**
	 * 
	 * @param searchSpec {@link SearchSpec}
	 * 
	public void setSearchSpec(SearchSpec searchSpec) {
		this.searchSpec = searchSpec;
	}
	*/

	/**
	 * 
	 * @return {@link SortSpec}
	 */
	public SortSpec getSortSpec() {
		return sortSpec;
	}

	/**
	 * 
	 * @param sortSpec {@link SortSpec}
	 */
	/*
	public void setSortSpec(SortSpec sortSpec) {
		this.sortSpec = sortSpec;
	}
	*/

	/**
	 * 
	 * @return isIncludeAuthorizationInfo. Set this if you want to get back information on the allowed operations on the returned list. 
	 */
	public boolean isIncludeAuthorizationInfo() {
		return includeAuthorizationInfo;
	}
	
	/**
	 * 
	 * @param includeAuthorizationInfo. Set this if you want to get back information on the allowed operations on the returned list.
	 */
	public void setIncludeAuthorizationInfo(boolean includeAuthorizationInfo) {
		this.includeAuthorizationInfo = includeAuthorizationInfo;
	}

	public SensitiveDataSpec getSensitiveDataSpec() {
		return sensitiveDataSpec;
	}

	public void setSensitiveDataSpec(SensitiveDataSpec sensitiveDataSpec) {
		this.sensitiveDataSpec = sensitiveDataSpec;
	}
	
}