EventSearchQuery.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.elasticsearch.index.objects.event;
import static org.opencastproject.security.api.SecurityConstants.GLOBAL_ADMIN_ROLE;
import org.opencastproject.elasticsearch.impl.AbstractSearchQuery;
import org.opencastproject.elasticsearch.impl.IndexSchema;
import org.opencastproject.security.api.Permissions;
import org.opencastproject.security.api.Permissions.Action;
import org.opencastproject.security.api.User;
import org.opencastproject.util.requests.SortCriterion.Order;
import org.apache.commons.lang3.StringUtils;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* This interface defines a fluent api for a query object used to lookup recording events in the search index.
*/
public class EventSearchQuery extends AbstractSearchQuery {
private final List<String> identifiers = new ArrayList<String>();
private String organization = null;
private User user = null;
private String title = null;
private String description = null;
private final Set<String> actions = new HashSet<String>();
private final List<String> presenters = new ArrayList<String>();
private final List<String> contributors = new ArrayList<String>();
private String subject = null;
private Map<String, Map<String, List<String>>> extendedMetadata = new HashMap<>();
private String location = null;
private String seriesId = null;
private String seriesName = null;
private String language = null;
private String source = null;
private String created = null;
private Date startFrom = null;
private Date startTo = null;
private Date technicalStartFrom = null;
private Date technicalStartTo = null;
private String creator = null;
private String publisher = null;
private String license = null;
private String rights = null;
private String accessPolicy = null;
private String managedAcl = null;
private String workflowState = null;
private Long workflowId = null;
private String workflowDefinition = null;
private Long duration = null;
private String startDate = null;
private String eventStatus = null;
private Boolean hasComments = null;
private Boolean hasOpenComments = null;
private final List<String> comments = new ArrayList<>();
private Boolean needsCutting = null;
private final List<String> publications = new ArrayList<String>();
private Boolean isPublished = null;
private Long archiveVersion = null;
private String agentId = null;
private Date technicalStartTime = null;
private Date technicalEndTime = null;
private final List<String> technicalPresenters = new ArrayList<String>();
private static final Map<String, String> SORT_FIELDS = Map.of(
EventIndexSchema.TITLE, EventIndexSchema.TITLE.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.CONTRIBUTOR, EventIndexSchema.CONTRIBUTOR.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.PRESENTER, EventIndexSchema.PRESENTER.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.SUBJECT, EventIndexSchema.SUBJECT.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.DESCRIPTION, EventIndexSchema.DESCRIPTION.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.LOCATION, EventIndexSchema.LOCATION.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.SERIES_NAME, EventIndexSchema.SERIES_NAME.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.CREATOR, EventIndexSchema.CREATOR.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION),
EventIndexSchema.PUBLISHER, EventIndexSchema.PUBLISHER.concat(IndexSchema.SORT_FIELD_NAME_EXTENSION)
);
@SuppressWarnings("unused")
private EventSearchQuery() {
}
@Override
protected String sortOrderFieldName(String field) {
if (SORT_FIELDS.containsKey(field)) {
return SORT_FIELDS.get(field);
}
return field;
}
/**
* Creates a query that will return event documents.
*/
public EventSearchQuery(String organization, User user) {
super(Event.DOCUMENT_TYPE);
this.organization = organization;
this.user = user;
this.actions.add(Permissions.Action.READ.toString());
if (!user.hasRole(GLOBAL_ADMIN_ROLE)) {
if (!user.getOrganization().getId().equals(organization)) {
throw new IllegalStateException("User's organization must match search organization");
}
}
}
/**
* Selects recording events with the given identifier.
* <p>
* Note that this method may be called multiple times to support selection of multiple recording events.
*
* @param id
* the recording identifier
* @return the enhanced search query
*/
public EventSearchQuery withIdentifier(String id) {
if (StringUtils.isBlank(id)) {
throw new IllegalArgumentException("Identifier cannot be null");
}
this.identifiers.add(id);
return this;
}
/**
* Returns the list of recording identifiers or an empty array if no identifiers have been specified.
*
* @return the identifiers
*/
public String[] getIdentifier() {
return identifiers.toArray(new String[identifiers.size()]);
}
/**
* Returns the organization of the recording
*
* @return the organization
*/
public String getOrganization() {
return organization;
}
/**
* Returns the user of this search query
*
* @return the user of this search query
*/
public User getUser() {
return user;
}
/**
* Selects recordings with the given title.
*
* @param title
* the title
* @return the enhanced search query
*/
public EventSearchQuery withTitle(String title) {
this.title = title;
return this;
}
/**
* Returns the title of the recording.
*
* @return the title
*/
public String getTitle() {
return title;
}
/**
* Filter the recording events without any action checked.
*
* @return the enhanced search query
*/
public EventSearchQuery withoutActions() {
this.actions.clear();
return this;
}
/**
* Filter the recording events with the given action.
* <p>
* Note that this method may be called multiple times to support filtering by multiple actions.
*
* @param action
* the action
* @return the enhanced search query
*/
public EventSearchQuery withAction(Action action) {
if (action == null) {
throw new IllegalArgumentException("Action cannot be null");
}
this.actions.add(action.toString());
return this;
}
/**
* Returns the list of actions or an empty array if no actions have been specified.
*
* @return the actions
*/
public String[] getActions() {
return actions.toArray(new String[actions.size()]);
}
/**
* Selects recording events with the given presenter.
* <p>
* Note that this method may be called multiple times to support selection of multiple recording events.
*
* @param presenter
* the presenter
* @return the enhanced search query
*/
public EventSearchQuery withPresenter(String presenter) {
if (StringUtils.isBlank(presenter)) {
throw new IllegalArgumentException("Presenter cannot be null");
}
this.presenters.add(presenter);
return this;
}
/**
* Returns the list of recording presenters or an empty array if no presenter have been specified.
*
* @return the presenters
*/
public String[] getPresenters() {
return presenters.toArray(new String[presenters.size()]);
}
/**
* Selects recording events with the given contributor.
* <p>
* Note that this method may be called multiple times to support selection of multiple recording events.
*
* @param contributor
* the contributor
* @return the enhanced search query
*/
public EventSearchQuery withContributor(String contributor) {
if (StringUtils.isBlank(contributor)) {
throw new IllegalArgumentException("Contributor cannot be null");
}
this.contributors.add(contributor);
return this;
}
/**
* Returns the list of recording contributors or an empty array if no contributors have been specified.
*
* @return the contributors
*/
public String[] getContributors() {
return contributors.toArray(new String[contributors.size()]);
}
/**
* Selects recording events with the given subject.
*
* @param subject
* the subject
* @return the enhanced search query
*/
public EventSearchQuery withSubject(String subject) {
this.subject = subject;
return this;
}
/**
* Returns the subject of the recording.
*
* @return the subject
*/
public String getSubject() {
return subject;
}
/**
* Selects recording events with the given subject.
*
* @param flavor
* the flavor of the catalog
* @param key
* the metadata field key
* @param value
* the metadata field value
* @return the enhanced search query
*/
public EventSearchQuery withExtendedMetadata(String flavor, String key, String value) {
this.extendedMetadata.computeIfAbsent(flavor, h -> new HashMap<>())
.computeIfAbsent(key, a -> new ArrayList<>())
.add(value);
return this;
}
/**
* Returns the subject of the recording.
*
* @return the subject
*/
public Map<String, Map<String, List<String>>> getExtendedMetadata() {
return extendedMetadata;
}
/**
* Selects recordings with the given description.
*
* @param description
* the description
* @return the enhanced search query
*/
public EventSearchQuery withDescription(String description) {
this.description = description;
return this;
}
/**
* Returns the description of the recording.
*
* @return the description
*/
public String getDescription() {
return description;
}
/**
* Selects recordings with the given location.
*
* @param location
* the location
* @return the enhanced search query
*/
public EventSearchQuery withLocation(String location) {
this.location = location;
return this;
}
/**
* Returns the location of the recording.
*
* @return the location
*/
public String getLocation() {
return location;
}
/**
* Selects recordings with the given series identifier.
*
* @param seriesId
* the series identifier
* @return the enhanced search query
*/
public EventSearchQuery withSeriesId(String seriesId) {
this.seriesId = seriesId;
return this;
}
/**
* Returns the series identifier of the recording.
*
* @return the series identifier
*/
public String getSeriesId() {
return seriesId;
}
/**
* Selects recordings with the given series name.
*
* @param seriesName
* the series name
* @return the enhanced search query
*/
public EventSearchQuery withSeriesName(String seriesName) {
this.seriesName = seriesName;
return this;
}
/**
* Returns the series name of the recording.
*
* @return the series name
*/
public String getSeriesName() {
return seriesName;
}
/**
* Selects recordings with the given language.
*
* @param language
* the language
* @return the enhanced search query
*/
public EventSearchQuery withLanguage(String language) {
this.language = language;
return this;
}
/**
* Returns the language of the recording.
*
* @return the language
*/
public String getLanguage() {
return language;
}
/**
* Selects recordings with the given source type.
*
* @param source
* the source
* @return the enhanced search query
*/
public EventSearchQuery withSource(String source) {
this.source = source;
return this;
}
/**
* Returns the source of the recording.
*
* @return the source
*/
public String getSource() {
return source;
}
/**
* Selects recordings with the given creation date.
*
* @param created
* the creation date
* @return the enhanced search query
*/
public EventSearchQuery withCreated(String created) {
this.created = created;
return this;
}
/**
* Returns the creation date of the recording.
*
* @return the creation date
*/
public String getCreated() {
return created;
}
/**
* The start date to start looking for events.
*
* @param startFrom
* The start date to start looking for events
* @return the enhanced search query
*/
public EventSearchQuery withStartFrom(Date startFrom) {
this.startFrom = startFrom;
return this;
}
/**
* @return The Date after which all events returned should have been started
*/
public Date getStartFrom() {
return startFrom;
}
/**
* The start date to stop looking for events.
*
* @param startTo
* The start date to stop looking for events
* @return the enhanced search query
*/
public EventSearchQuery withStartTo(Date startTo) {
this.startTo = startTo;
return this;
}
/**
* @return The Date before which all events returned should have been started
*/
public Date getStartTo() {
return startTo;
}
/**
* The technical start date to start looking for events.
*
* @param startFrom
* The technical start date to start looking for events
* @return the enhanced search query
*/
public EventSearchQuery withTechnicalStartFrom(Date startFrom) {
this.technicalStartFrom = startFrom;
return this;
}
/**
* @return The technical date after which all events returned should have been started
*/
public Date getTechnicalStartFrom() {
return technicalStartFrom;
}
/**
* The technical start date to stop looking for events.
*
* @param startTo
* The technical start date to stop looking for events
* @return the enhanced search query
*/
public EventSearchQuery withTechnicalStartTo(Date startTo) {
this.technicalStartTo = startTo;
return this;
}
/**
* @return The technical date before which all events returned should have been started
*/
public Date getTechnicalStartTo() {
return technicalStartTo;
}
/**
* Selects recordings with the given creator.
*
* @param creator
* the creator
* @return the enhanced search query
*/
public EventSearchQuery withCreator(String creator) {
this.creator = creator;
return this;
}
/**
* Returns the creator of the recording.
*
* @return the creator
*/
public String getCreator() {
return creator;
}
/**
* Selects recordings with the given publisher.
*
* @param publisher
* the publisher
* @return the enhanced search query
*/
public EventSearchQuery withPublisher(String publisher) {
this.publisher = publisher;
return this;
}
/**
* Returns the publisher of the recording.
*
* @return the publisher
*/
public String getPublisher() {
return publisher;
}
/**
* Selects recordings with the given license.
*
* @param license
* the license
* @return the enhanced search query
*/
public EventSearchQuery withLicense(String license) {
this.license = license;
return this;
}
/**
* Returns the license of the recording.
*
* @return the license
*/
public String getLicense() {
return license;
}
/**
* Selects recordings with the given rights.
*
* @param rights
* the rights
* @return the enhanced search query
*/
public EventSearchQuery withRights(String rights) {
this.rights = rights;
return this;
}
/**
* Returns the rights of the recording.
*
* @return the rights
*/
public String getRights() {
return rights;
}
/**
* Selects recordings with the given access policy.
*
* @param accessPolicy
* the access policy
* @return the enhanced search query
*/
public EventSearchQuery withAccessPolicy(String accessPolicy) {
this.accessPolicy = accessPolicy;
return this;
}
/**
* Returns the access policy of the recording.
*
* @return the access policy
*/
public String getAccessPolicy() {
return accessPolicy;
}
/**
* Selects recordings with the given managed ACL name.
*
* @param managedAcl
* the name of the managed ACL
* @return the enhanced search query
*/
public EventSearchQuery withManagedAcl(String managedAcl) {
this.managedAcl = managedAcl;
return this;
}
/**
* Returns the name of the managed ACL set to the recording.
*
* @return the name of the managed ACL
*/
public String getManagedAcl() {
return managedAcl;
}
/**
* Selects recordings with the given workflow state.
*
* @param workflowState
* the workflow state
* @return the enhanced search query
*/
public EventSearchQuery withWorkflowState(String workflowState) {
this.workflowState = workflowState;
return this;
}
/**
* Returns the workflow state of the recording.
*
* @return the workflow state
*/
public String getWorkflowState() {
return workflowState;
}
/**
* Selects recordings with the given workflow id.
*
* @param workflowId
* the workflow id
* @return the enhanced search query
*/
public EventSearchQuery withWorkflowId(long workflowId) {
this.workflowId = workflowId;
return this;
}
/**
* Returns the workflow id of the recording.
*
* @return the workflow id
*/
public Long getWorkflowId() {
return workflowId;
}
/**
* Selects recordings with the given workflow definition.
*
* @param workflowDefinition
* the workflow definition
* @return the enhanced search query
*/
public EventSearchQuery withWorkflowDefinition(String workflowDefinition) {
this.workflowDefinition = workflowDefinition;
return this;
}
/**
* Returns the workflow definition of the recording.
*
* @return the workflow definition
*/
public String getWorkflowDefinition() {
return workflowDefinition;
}
/**
* Selects recordings with the given start date.
*
* @param startDate
* the start date
* @return the enhanced search query
*/
public EventSearchQuery withStartDate(String startDate) {
this.startDate = startDate;
return this;
}
/**
* Returns the start date of the recording.
*
* @return the start date
*/
public String getStartDate() {
return startDate;
}
/**
* Selects recordings with the given duration.
*
* @param duration
* the duration
* @return the enhanced search query
*/
public EventSearchQuery withDuration(long duration) {
this.duration = duration;
return this;
}
/**
* Returns the duration of the recording.
*
* @return the duration
*/
public Long getDuration() {
return duration;
}
/**
* Selects recordings with the given event status.
*
* @param eventStatus
* the event status
* @return the enhanced search query
*/
public EventSearchQuery withEventStatus(String eventStatus) {
this.eventStatus = eventStatus;
return this;
}
/**
* Returns the event status of the recording.
*
* @return the event status
*/
public String getEventStatus() {
return eventStatus;
}
/**
* Selects recordings with the given has comments status.
*
* @param hasComments
* the has comments status
* @return the enhanced search query
*/
public EventSearchQuery withComments(boolean hasComments) {
this.hasComments = hasComments;
return this;
}
/**
* Selects recordings with the given has open comments status.
*
* @param hasOpenComments
* the has open comments status
* @return the enhanced search query
*/
public EventSearchQuery withOpenComments(boolean hasOpenComments) {
this.hasOpenComments = hasOpenComments;
return this;
}
/**
* Selects recordings with the given has comment need cutting status.
*
* @param needsCutting
* the event has the comments status that it needs cutting
* @return the enhanced search query
*/
public EventSearchQuery withNeedsCutting(boolean needsCutting) {
this.needsCutting = needsCutting;
return this;
}
/**
* Returns the has comments status of the recording.
*
* @return the recording has comments status
*/
public Boolean getHasComments() {
return hasComments;
}
/**
* Returns the has open comments status of the recording.
*
* @return the recording has open comments status
*/
public Boolean getHasOpenComments() {
return hasOpenComments;
}
public EventSearchQuery withComments(String comment) {
if (StringUtils.isBlank(comment)) {
throw new IllegalArgumentException("Comment cannot be null");
}
this.comments.add(comment);
return this;
}
public String[] getComments() {
return comments.toArray(new String[comments.size()]);
}
/**
* Returns the has open comments reason that it needs cutting of the recording.
*
* @return the event has the open comments status that it needs cutting
*/
public Boolean needsCutting() {
return needsCutting;
}
/**
* Selects recording events with the given publication.
* <p>
* Note that this method may be called multiple times to support selection of multiple recording events.
*
* @param publication
* the publication
* @return the enhanced search query
*/
public EventSearchQuery withPublications(String publication) {
if (StringUtils.isBlank(publication)) {
throw new IllegalArgumentException("Publication cannot be null");
}
this.publications.add(publication);
return this;
}
/**
* Returns the list of event publications or an empty array if no publications have been specified.
*
* @return the publications
*/
public String[] getPublications() {
return publications.toArray(new String[publications.size()]);
}
/**
* Selects recordings with the given is published status.
*
* @param isPublished
* the is published status
* @return the enhanced search query
*/
public EventSearchQuery withIsPublished(boolean isPublished) {
this.isPublished = isPublished;
return this;
}
/**
* Returns the is published status of the recording.
*
* @return the recording is published status
*/
public Boolean getIsPublished() {
return isPublished;
}
/**
* Selects events with the given archive version.
*
* @param archiveVersion
* the archive version
* @return the enhanced search query
*/
public EventSearchQuery withArchiveVersion(long archiveVersion) {
this.archiveVersion = archiveVersion;
return this;
}
/**
* Returns the archive version of the event.
*
* @return the archive version
*/
public Long getArchiveVersion() {
return archiveVersion;
}
/**
* Selects recordings with the given agent id.
*
* @param agentId
* the agent id
* @return the enhanced search query
*/
public EventSearchQuery withAgentId(String agentId) {
this.agentId = agentId;
return this;
}
/**
* Returns the agent id of the recording.
*
* @return the agent id
*/
public String getAgentId() {
return agentId;
}
/**
* Selects recordings with the given technical start date.
*
* @param technicalStartTime
* the start date
* @return the enhanced search query
*/
public EventSearchQuery withTechnicalStartTime(Date technicalStartTime) {
this.technicalStartTime = technicalStartTime;
return this;
}
/**
* Returns the technical start date of the recording.
*
* @return the technical start date
*/
public Date getTechnicalStartTime() {
return technicalStartTime;
}
/**
* Selects recordings with the given technical end date.
*
* @param technicalEndTime
* the end date
* @return
* @return the enhanced search query
*/
public EventSearchQuery withTechnicalEndTime(Date technicalEndTime) {
this.technicalEndTime = technicalEndTime;
return this;
}
/**
* Returns the technical end date of the recording.
*
* @return the technical end date
*/
public Date getTechnicalEndTime() {
return technicalEndTime;
}
/**
* Selects recording events with the given technical presenters.
* <p>
* Note that this method may be called multiple times to support selection of multiple recording events.
*
* @param presenter
* the presenter
* @return the enhanced search query
*/
public EventSearchQuery withTechnicalPresenters(String presenter) {
if (StringUtils.isBlank(presenter)) {
throw new IllegalArgumentException("Presenter cannot be null");
}
this.technicalPresenters.add(presenter);
return this;
}
/**
* Returns the list of technical presenters or an empty array if no presenters have been specified.
*
* @return the technical presenters
*/
public String[] getTechnicalPresenters() {
return technicalPresenters.toArray(new String[technicalPresenters.size()]);
}
/**
* Defines the sort order for the recording start date.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByStartDate(Order order) {
withSortOrder(EventIndexSchema.START_DATE, order);
return this;
}
/**
* Returns the sort order for the recording start date.
*
* @return the sort order
*/
public Order getStartDateSortOrder() {
return getSortOrder(EventIndexSchema.START_DATE);
}
/**
* Defines the sort order for the technical recording start date.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByTechnicalStartDate(Order order) {
withSortOrder(EventIndexSchema.TECHNICAL_START, order);
return this;
}
/**
* Returns the sort order for the technical recording start date.
*
* @return the sort order
*/
public Order getTechnicalStartDateSortOrder() {
return getSortOrder(EventIndexSchema.TECHNICAL_START);
}
/**
* Defines the sort order for the recording end date.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByEndDate(Order order) {
withSortOrder(EventIndexSchema.END_DATE, order);
return this;
}
/**
* Returns the sort order for the recording end date.
*
* @return the sort order
*/
public Order getEndDateSortOrder() {
return getSortOrder(EventIndexSchema.END_DATE);
}
/**
* Defines the sort order for the technical recording end date.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByTechnicalEndDate(Order order) {
withSortOrder(EventIndexSchema.TECHNICAL_END, order);
return this;
}
/**
* Returns the sort order for the technical recording end date.
*
* @return the sort order
*/
public Order getTechnicalEndDateSortOrder() {
return getSortOrder(EventIndexSchema.TECHNICAL_END);
}
/**
* Defines the sort order for the recording date.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByDate(Order order) {
withSortOrder(EventIndexSchema.END_DATE, order);
return this;
}
/**
* Returns the sort order for the recording date.
*
* @return the sort order
*/
public Order getDateSortOrder() {
return getSortOrder(EventIndexSchema.END_DATE);
}
/**
* Defines the sort order for the recording date.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByTitle(Order order) {
withSortOrder(EventIndexSchema.TITLE, order);
return this;
}
/**
* Returns the sort order for the recording start date.
*
* @return the sort order
*/
public Order getTitleSortOrder() {
return getSortOrder(EventIndexSchema.TITLE);
}
public EventSearchQuery sortByUID(Order order) {
withSortOrder(EventIndexSchema.UID, order);
return this;
}
public Order getUIDSortOrder() {
return getSortOrder(EventIndexSchema.UID);
}
/**
* Defines the sort order for the recording date.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByPresenter(Order order) {
withSortOrder(EventIndexSchema.PRESENTER, order);
return this;
}
/**
* Returns the sort order for the recording start date.
*
* @return the sort order
*/
public Order getPresentersSortOrder() {
return getSortOrder(EventIndexSchema.PRESENTER);
}
/**
* Defines the sort order for the location.
*
* @param order
* the sort order
* @return the updated query
*/
public EventSearchQuery sortByLocation(Order order) {
withSortOrder(EventIndexSchema.LOCATION, order);
return this;
}
/**
* Returns the sort order for the location.
*
* @return the sort order
*/
public Order getLocationSortOrder() {
return getSortOrder(EventIndexSchema.LOCATION);
}
/**
* Defines the sort order for the series name.
*
* @param order
* the sort order
* @return the updated query
*/
public EventSearchQuery sortBySeriesName(Order order) {
withSortOrder(EventIndexSchema.SERIES_NAME, order);
return this;
}
/**
* Returns the sort order for the series name.
*
* @return the sort order
*/
public Order getSeriesNameSortOrder() {
return getSortOrder(EventIndexSchema.SERIES_NAME);
}
/**
* Defines the sort order for the managed ACL.
*
* @param order
* the order
* @return the enhanced search query
*/
public EventSearchQuery sortByManagedAcl(Order order) {
withSortOrder(EventIndexSchema.MANAGED_ACL, order);
return this;
}
/**
* Returns the sort order for the series managed ACL.
*
* @return the sort order
*/
public Order getManagedAclSortOrder() {
return getSortOrder(EventIndexSchema.MANAGED_ACL);
}
/**
* Defines the sort order for the workflow state.
*
* @param order
* the sort order
* @return the updated query
*/
public EventSearchQuery sortByWorkflowState(Order order) {
withSortOrder(EventIndexSchema.WORKFLOW_STATE, order);
return this;
}
/**
* Returns the sort order for the workflow state.
*
* @return the sort order
*/
public Order getWorkflowStateSortOrder() {
return getSortOrder(EventIndexSchema.WORKFLOW_STATE);
}
/**
* Defines the sort order for the event status.
*
* @param order
* the sort order
* @return the updated query
*/
public EventSearchQuery sortByEventStatus(Order order) {
withSortOrder(EventIndexSchema.EVENT_STATUS, order);
return this;
}
/**
* Returns the sort order for the event status.
*
* @return the sort order
*/
public Order getEventStatusSortOrder() {
return getSortOrder(EventIndexSchema.EVENT_STATUS);
}
/**
* Defines the sort order for publication.
*
* @param order
* the sort order
* @return the updated query
*/
public EventSearchQuery sortByPublicationIgnoringInternal(Order order) {
// TODO implement sort By Publication Ignoring Internal
withSortOrder(EventIndexSchema.PUBLICATION, order);
return this;
}
/**
* Returns the sort order for the publication.
*
* @return the sort order
*/
public Order getPublicationSortOrder() {
// TODO implement getPublicationSortOrder
return getSortOrder(EventIndexSchema.PUBLICATION);
}
}