com.kaltura.client.services.ParentalRuleService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of KalturaOttApiClient Show documentation

KalturaOttApiClient is a library of Java classes that can be used to interact with the Kaltura OTT REST API. More information about the REST API can be found at https://ott.developer.kaltura.com/ Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interact with the API.

There is a newer version: 5.1.2.17630

Show newest version

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.enums.EntityReferenceBy;
import com.kaltura.client.types.ParentalRule;
import com.kaltura.client.types.ParentalRuleFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

/**
 * This class was generated using clients-generator\exec.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

public class ParentalRuleService {
	
	public static class DisableParentalRuleBuilder extends RequestBuilder {
		
		public DisableParentalRuleBuilder(long ruleId, EntityReferenceBy entityReference) {
			super(Boolean.class, "parentalrule", "disable");
			params.add("ruleId", ruleId);
			params.add("entityReference", entityReference);
		}
		
		public void ruleId(String multirequestToken) {
			params.add("ruleId", multirequestToken);
		}
		
		public void entityReference(String multirequestToken) {
			params.add("entityReference", multirequestToken);
		}
	}

	/**
	 * Disables a parental rule that was previously defined by the household master.
	  Disable can be at specific user or household level.
	 * 
	 * @param ruleId Rule Identifier
	 * @param entityReference Reference type to filter by
	 */
    public static DisableParentalRuleBuilder disable(long ruleId, EntityReferenceBy entityReference)  {
		return new DisableParentalRuleBuilder(ruleId, entityReference);
	}
	
	public static class DisableDefaultParentalRuleBuilder extends RequestBuilder {
		
		public DisableDefaultParentalRuleBuilder(EntityReferenceBy entityReference) {
			super(Boolean.class, "parentalrule", "disableDefault");
			params.add("entityReference", entityReference);
		}
		
		public void entityReference(String multirequestToken) {
			params.add("entityReference", multirequestToken);
		}
	}

	/**
	 * Disables a parental rule that was defined at account level. Disable can be at
	  specific user or household level.
	 * 
	 * @param entityReference Reference type to filter by
	 */
    public static DisableDefaultParentalRuleBuilder disableDefault(EntityReferenceBy entityReference)  {
		return new DisableDefaultParentalRuleBuilder(entityReference);
	}
	
	public static class EnableParentalRuleBuilder extends RequestBuilder {
		
		public EnableParentalRuleBuilder(long ruleId, EntityReferenceBy entityReference) {
			super(Boolean.class, "parentalrule", "enable");
			params.add("ruleId", ruleId);
			params.add("entityReference", entityReference);
		}
		
		public void ruleId(String multirequestToken) {
			params.add("ruleId", multirequestToken);
		}
		
		public void entityReference(String multirequestToken) {
			params.add("entityReference", multirequestToken);
		}
	}

	/**
	 * Enable a parental rules for a user
	 * 
	 * @param ruleId Rule Identifier
	 * @param entityReference Reference type to filter by
	 */
    public static EnableParentalRuleBuilder enable(long ruleId, EntityReferenceBy entityReference)  {
		return new EnableParentalRuleBuilder(ruleId, entityReference);
	}
	
	public static class ListParentalRuleBuilder extends ListResponseRequestBuilder {
		
		public ListParentalRuleBuilder(ParentalRuleFilter filter) {
			super(ParentalRule.class, "parentalrule", "list");
			params.add("filter", filter);
		}
	}

	/**
	 * Return the parental rules that applies for the user or household. Can include
	  rules that have been associated in account, household, or user level.           
	    Association level is also specified in the response.
	 * 
	 * @param filter Filter
	 */
    public static ListParentalRuleBuilder list(ParentalRuleFilter filter)  {
		return new ListParentalRuleBuilder(filter);
	}
}